Implementing a Custom Adapter as an Event Sink
14.3 Passing Login Credentials from an Adapter to a Data Feed Provider
If your adapter accesses an external data feed, the adapter might need to pass login credentials username and password to the data feed for user authentication. The simplest, and least secure, way to do this is to hard-code the non-encrypted login credentials in your adapter Java code. However, this method does not allow you to encrypt the password or later change the login credentials without recompiling the adapter Java code. The following procedures describe a different method that takes these two issues into account. In the procedure, it is assumed that the username to access the data feed is juliet and the password is superSecret. You must decide whether you want the login credentials to be configured statically in the EPN assembly file, or dynamically by extending the configuration of the adapter. Configuring the credentials statically in the EPN assembly file is easier, but if the credentials later change you must restart the application for the update to the EPN assembly file to take place. Extending the adapter configuration allows you to change the credentials dynamically without restarting the application, but extending the configuration involves additional steps, such as creating an XSD file and compiling it into a JAXB object. This section describes: ■ Section 14.3.1, How to Pass Static Login Credentials to the Data Feed Provider ■ Section 14.3.2, How to Pass Dynamic Login Credentials to the Data Feed Provider ■ Section 14.3.3, How to Access Login Credentials From an Adapter at Runtime For more information, see Chapter 19, Extending Component Configuration .14.3.1 How to Pass Static Login Credentials to the Data Feed Provider
This procedure describes how to pass login credentials that you configure statically in the EPN assembly file. To pass static credentials to the data feed provider: 1. Open a command window and set your environment as described in Setting Your Development Environment in the Oracle Complex Event Processing Getting Started. 2. Change to the directory that contains the EPN assembly file for your application. 3. Using your favorite XML editor, edit the EPN assembly file by updating the wlevs:adapter element that declares your adapter. In particular, add two instance properties that correspond to the username and password of the login credentials. For now, specify the cleartext password value; you will encrypt it in a later step. Also add a temporary password element whose value is the cleartext password. For example: wlevs:adapter id=myAdapter provider=myProvider wlevs:instance-property name=user value=juliet wlevs:instance-property name=password value=superSecret passwordsuperSecretpassword wlevs:adapter 4. Save the EPN assembly file. Configuring Custom Adapters 14-13 5. Use the encryptMSAConfig command to encrypt the value of the password element in the EPN assembly file: prompt ORACLE_CEP_HOMEocep_11.1binencryptMSAConfig . epn_assembly_file msainternal.dat_file where ORACLE_CEP_HOME refers to the main directory into which you installed Oracle CEP, such as d:\oracle_cep. The second argument refers to the directory that contains the EPN assembly file; because this procedure directs you to change to the directory, the example shows .. The epn_assembly_file parameter refers to the name of your EPN assembly file. Finally, the msainternal.dat_file parameter refers to the location of the .msainternal.dat file associated with your domain; by default this file is located in the DOMAIN_DIRservername directory, where DOMAIN_DIR refers to the domain directory such as oracle_cepuser_ projectsdomainsmydomain and servername refers to the server instance. For more information, see The encryptMSAConfig Command-Line Utility in the Oracle Complex Event Processing Administrators Guide. After you run the command, the value of the password element of the EPN assembly file will be encrypted. 6. Edit the EPN assembly file: Copy the encrypted value of the password element to the value attribute of the password instance property. Remove the password element from the XML file. For example: wlevs:adapter id=myAdapter provider=myProvider wlevs:instance-property name=user value=juliet wlevs:instance-property name=password value={Salted-3DES}B7L6nehu7dgPtJJTnTJWRA== wlevs:adapter 7. Update your adapter Java code to access the login credentials properties you have just configured and decrypt the password. See Section 14.3.1, How to Pass Static Login Credentials to the Data Feed Provider. 8. Edit the MANIFEST.MF file of the application and add the com.bea.core.encryption package to the Import-Package header. See Section 24.2.2.1, Creating the MANIFEST.MF File. 9. Re-assemble and deploy your application as usual. See Chapter 24, Assembling and Deploying Oracle CEP Applications.14.3.2 How to Pass Dynamic Login Credentials to the Data Feed Provider
This procedure describes how to pass login credentials that you configure dynamically by extending the configuration of the adapter. To pass dynamic login credentials to the data feed provider: 1. Extend the configuration of your adapter by adding two new elements: user and password, both of type string. For example, if you were extending the adapter in the HelloWorld example, the XSD file might look like the following: 14-14 Oracle Complex Event Processing Developers Guide xs:complexType name=HelloWorldAdapterConfig xs:complexContent xs:extension base=wlevs:AdapterConfig xs:sequence xs:element name=message type=xs:string xs:element name=user type=xs:string xs:element name=password type=xs:string xs:sequence xs:extension xs:complexContent xs:complexType See Chapter 19, Extending Component Configuration for detailed instructions. 2. Open a command window and set your environment as described in Setting Your Development Environment in the Oracle Complex Event Processing Getting Started. 3. Change to the directory that contains the component configuration XML file for your adapter. 4. Using your favorite XML editor, update this component configuration XML file by adding the required login credentials using the user and password elements. For now, specify the cleartext password value; you will encrypt it in a later step. For example: ?xml version=1.0 encoding=UTF-8? myExample:config xmlns:myExample=http:www.bea.comxmlnswlevsexamplemyExample adapter namemyAdaptername userjulietuser passwordsuperSecretpassword adapter myExample:config 5. Save the adapter configuration file. 6. Use the encryptMSAConfig command to encrypt the value the password element in the adapter configuration file: prompt ORACLE_CEP_HOMEocep_11.1binencryptMSAConfig . adapter_config_file msainternal.dat_file where ORACLE_CEP_HOME refers to the main directory into which you installed Oracle CEP, such as d:\oracle_cep. The second argument refers to the directory that contains the adapter configuration file; because this procedure directs you to change to the directory, the example shows .. The adapter_ config_file parameter refers to the name of your adapter configuration file. Finally, the msainternal.dat_file parameter refers to the location of the .msainternal.dat file associated with your domain; by default this file is located in the DOMAIN_DIRservername directory, where DOMAIN_DIR refers to the domain directory such as oracle_cepuser_ projectsdomainsmydomain and servername refers to the server instance. For more information, see The encryptMSAConfig Command-Line Utility in the Oracle Complex Event Processing Administrators Guide. After you run the command, the value of the password element will be encrypted. 7. Update your adapter Java code to access the login credentials properties you have just configured and decrypt the password. Configuring Custom Adapters 14-15 See Section 14.3.1, How to Pass Static Login Credentials to the Data Feed Provider. 8. Edit the MANIFEST.MF file of the application and add the com.bea.core.encryption package to the Import-Package header. See Section 24.2.2.1, Creating the MANIFEST.MF File. 9. Re-assemble and deploy your application as usual. See Chapter 24, Assembling and Deploying Oracle CEP Applications.14.3.3 How to Access Login Credentials From an Adapter at Runtime
This section describes how update your custom adapter Java code to dynamically get the user and password values from the extended adapter configuration, and then use the com.bea.core.encryption.EncryptionService API to decrypt the encrypted password. The code snippets below build on the HelloWorld adapter Java code, shown in Section 14.2.2.1, Implementing a Custom Adapter as an Event Source. To access login credential properties from an adapter at runtime: 1. Import the additional APIs that you will need to decrypt the encrypted password: import com.bea.core.encryption.EncryptionService; import com.bea.core.encryption.EncryptionServiceException; import com.bea.wlevs.util.Service; 2. Use the Service annotation to get a reference to the EncryptionService: private EncryptionService encryptionService; ... Service public void setEncryptionServiceEncryptionService encryptionService { this.encryptionService = encryptionService; } 3. In the Prepare callback method, get the values of the user and password properties of the extended adapter configuration as usual only code for the password value is shown: private String password; ... public String getPassword { return password; } public void setPasswordString password { this.password = password; ... Prepare public void checkConfigurationHelloWorldAdapterConfig adapterConfig { if adapterConfig.getMessage == null || adapterConfig.getMessage.length == 0 { throw new RuntimeExceptioninvalid message: + message; } this.password= adapterConfig.getPassword; ... }Parts
» Oracle Fusion Middleware Online Documentation Library
» Adapter Components of the Oracle CEP Event Processing Network
» Channel Processor Components of the Oracle CEP Event Processing Network
» Event Bean Components of the Oracle CEP Event Processing Network
» Spring Bean Cache Components of the Oracle CEP Event Processing Network
» Table Nested Stages Components of the Oracle CEP Event Processing Network
» Foreign Stages Components of the Oracle CEP Event Processing Network
» Streams and Relations Transmitting Events in the EPN: Stream and Relation Sources and Sinks
» Transmitting Events in the EPN: Examples
» EPN Assembly File Overview of the Oracle CEP Programming Model
» Component Configuration Files Overview of the Oracle CEP Programming Model
» High Availability and Scalability
» Oracle CEP calls the ResumableBean.beforeResume method on all
» For each bean that implements RunnableBean, Oracle CEP starts it running in a
» Application state is now RUNNING.
» User Action: Uninstall Application
» User Action: Update Application
» User Action: Calling Methods of Stream and Relation Sources and Sinks
» Oracle CEP APIs Overview of the Oracle CEP Programming Model
» Creating an Oracle CEP Application
» Static Resource Names Static Resource Injection
» Dynamic Resource Names Static Resource Injection
» Dynamic Resource Injection Dynamic Resource Lookup Using JNDI
» Next Steps Oracle Fusion Middleware Online Documentation Library
» Event Type Instantiation and Immutability
» Event Types Specified as JavaBean or Java Class
» Event Types Specified as java.util.Map Event Types Specified as a Tuple
» Event Types for use With a Database Table Source
» Event Types for use With the csvgen Adapter
» Event Type and Serialization Creating Oracle CEP Event Types
» How to Create an Oracle CEP Event Type as a JavaBean Using the Event Type Repository Editor
» How to Create an Oracle CEP Event Type as a JavaBean Manually
» How to Create an Oracle CEP Event Type as a Tuple Using the Event Type Repository Editor
» How to Create an Oracle CEP Event Type as a Tuple Manually
» How to Create an Oracle CEP Event Type as a Java Class Manually
» How to Create an Oracle CEP Event Type as a java.util.Map
» Using an Event Type Builder Factory
» Sharing Event Types Between Application Bundles
» Installing the Latest Oracle CEP IDE for Eclipse
» Installing the Oracle CEP IDE for Eclipse Distributed With Oracle CEP
» Configuring Eclipse Oracle Fusion Middleware Online Documentation Library
» How to Create an Oracle CEP Project
» Oracle CEP Project Overview Select File New Other.
» How to Export an Oracle CEP Project
» In the Binary Build area, check the resources you want exported with your
» How to Add a Standard JAR File to an Oracle CEP Project
» How to Export a Package How to Import a Package
» How to Create a Remote Oracle CEP Server and Server Runtime
» How to Create an Oracle CEP Server Runtime
» How to Start a Local Oracle CEP Server
» How to Deploy an Application to an Oracle CEP Server
» How to Configure Connection and Control Settings for Oracle CEP Server
» How to Configure Domain Runtime Settings for Oracle CEP Server
» How to Start the Oracle CEP Visualizer from Oracle CEP IDE for Eclipse
» Right-click a server in the Servers view and select Debug.
» How to Open the EPN Editor from a Project Folder
» How to Open the EPN Editor from a Context or Configuration File
» Flow Representation Filtering EPN Editor Overview
» Zooming Layout Showing and Hiding Unconnected Beans
» Printing and Exporting to an Image Configuration Badging
» Link Specification Location Indicator
» Nested Stages EPN Editor Overview
» Event Type Repository Editor
» Hyperlinking in Component Configuration and EPN Assembly Files
» Hyperlinking in Oracle CQL Statements
» Type the keyboard short cut Ctrl-Alt-T.
» Right-click on an empty portion of the EPN Editor surface and select New from
» Laying Out Nodes Renaming Nodes Deleting Nodes
» Conversion Between JMS Messages and Event Types
» JMS Service Providers Outbound JMS Adapter
» How to Configure a JMS Adapter Using the Oracle CEP IDE for Eclipse
» How to Configure a JMS Adapter Manually
» How to Configure a JMS Adapter for Oracle WebLogic Server JMS Manually
» How to Configure a JMS Adapter for Tibco EMS JMS Manually
» How to Create a Custom Converter for the Inbound JMS Adapter
» How to Create a Custom Converter for the Outbound JMS Adapter
» How to Encrypt Passwords in the JMS Adapter Component Configuration File
» JMS Inbound Adapter EPN Assembly File Configuration
» JMS Outbound Adapter EPN Assembly File Configuration
» JMS Inbound Adapter Component Configuration
» JMS Outbound Adapter Component Configuration
» Local Publishing Overview of the Built-In Pub-Sub Adapter for Publishing
» Remote Publishing Overview of the Built-In Pub-Sub Adapter for Publishing
» Overview of the Built-In Pub-Sub Adapter for Subscribing
» Converting Between JSON Messages and Event Types
» How to Configure an HTTP Pub-Sub Adapter Using the Oracle CEP IDE for Eclipse
» How to Configure an HTTP Pub-Sub Adapter Manually
» HTTP Pub-Sub Adapter for Publising EPN Assembly File Configuration
» HTTP Pub-Sub Adapter for Subscribing EPN Assembly File Configuration
» HTTP Pub-Sub Adapter for Publising Component Configuration
» HTTP Pub-Sub Adapter for Subscribing Component Configuration
» Channels as Streams Channels Representing Streams and Relations
» Channels as Relations Channels Representing Streams and Relations
» System-Timestamped Channels Application-Timestamped Channels
» Controlling Which Queries Output to a Downstream Channel: selector
» Batch Processing Channels Overview of Channel Configuration
» EventPartitioner Channels Overview of Channel Configuration
» How to Configure a System-Timestamped Channel Using Oracle CEP IDE for Eclipse
» How to Configure an Application-Timestamped Channel Using Oracle CEP IDE for Eclipse
» How to Create a Channel Component Configuration File Manually
» Channel Component Configuration File Channel EPN Assembly File
» How to Configure an Oracle CQL Processor Using Oracle CEP IDE for Eclipse
» How to Create an Oracle CQL Processor Component Configuration File Manually
» How to Configure an Oracle CQL Processor Table Source Using Oracle CEP IDE for Eclipse
» Oracle CQL Processor Component Configuration File
» Oracle CQL Processor EPN Assembly File
» Configuring an Oracle CQL Processor Cache Source Overview of EPL Processor Component Configuration
» How to Configure an EPL Processor Manually
» Configuring an EPL Processor Cache Source
» EPL Processor Component Configuration File
» EPL Processor EPN Assembly File
» Use Case: Publishing Events to a Cache
» Use Case: Consuming Data From a Cache
» Use Case: Updating and Deleting Data in a Cache
» Use Case: Using a Cache in a Multi-Server Domain
» Additional Caching Features Overview of Oracle CEP Cache Configuration
» Caching APIs Overview of Oracle CEP Cache Configuration
» Specifying the Key Used to Index an Oracle CEP Local Cache
» Configuring an Oracle CEP Local Cache as an Event Source
» Configuring an Oracle CEP Local Cache Loader
» Configuring an Oracle CEP Local Cache Store
» The coherence-cache-config.xml File
» The tangosol-coherence-override.xml File
» Specifying the Key Used to Index an Oracle Coherence Cache
» Configuring an Oracle Coherence Cache as an Event Source
» Configuring an Oracle Coherence Cache Loader
» Configuring an Oracle Coherence Cache Store
» Configuring a Third-Party Caching System and Cache
» How to Access a Cache From an Oracle CQL Statement
» How To Access a Cache From an EPL Statement
» Accessing a Cache From an Adapter
» How to Access a Cache With JMX Using Oracle CEP Visualizer
» How to Access a Cache With JMX Using Java
» Default Persistent Event Store
» Custom Persistent Event Store
» Persistent Event Store Schema
» Querying Stored Events Overview of Configuring Event Record and Playback
» Configuring an Event Store for Oracle CEP Server
» Configuring a Component to Record Events
» Configuring a Component to Playback Events
» Starting and Stopping the Record and Playback of Events
» Description of the Berkeley Database Schema
» Accessing a Cache From an EPL User-Defined Function Creating a Custom Event Store Provider
» Custom Adapters as Event Sources Custom Adapters as Event Sinks
» How to Implement a Custom Adapter Using Ant
» Implementing a Custom Adapter as an Event Source
» Implementing a Custom Adapter as an Event Sink
» Implementing a Custom Adapter Factory
» How to Pass Static Login Credentials to the Data Feed Provider
» How to Pass Dynamic Login Credentials to the Data Feed Provider
» Configuring the Custom Adapter Component Configuration File
» Custom Event Beans as Event Sources
» Custom Event Beans as Event Sinks
» Implementing a Custom Event Bean as an Event Source
» Implementing a Custom Event Bean as an Event Sink
» Configuring the Custom Event Bean Component Configuration File
» Implementing a Custom Spring Bean as an Event Source
» Implementing a Custom Spring Bean as an Event Sink
» Declaring the Custom Spring Bean Components in your Application
» How to Expose an Oracle CEP Application as a Web Service
» How to Configure Oracle JDBC Data Cartridge Application Context
» Extending Component Configuration Using Annotations
» Extending Component Configuration Using an XSD
» How to Extend Component Configuration Using Annotations
» Creating the XSD Schema File
» Lifecycle Callback Annotations Lifecycle
» Rejoining the High Availability Multi-Server Domain
» Deployment Group and Notification Group
» High Availability Input Adapter
» Buffering Output Adapter High Availability Components
» Broadcast Output Adapter High Availability Components
» Correlating Output Adapter ActiveActiveGroupBean
» High Availability and Oracle Coherence
» Simple Failover Choosing a Quality of Service
» Simple Failover with Buffering
» Light-Weight Queue Trimming Choosing a Quality of Service
» Primary Oracle CEP High Availability Use Case
» Select the Minimum High Availability Your Application can Tolerate
» Use Oracle CEP High Availability Components at All Ingress and Egress Points
» Choose an Adequate warm-up-window Time Ensure Applications are Idempotent
» Source Event Identity Externally Understand the Importance of Event Ordering
» Range-Based Windows Oracle CQL Query Restrictions
» Tuple-Based Windows Oracle CQL Query Restrictions
» Partitioned Windows Oracle CQL Query Restrictions
» Sliding Windows Oracle CQL Query Restrictions
» DURATION Clause and Non-Event Detection
» Prefer Application Time Oracle CQL Query Restrictions
» How to Configure Simple Failover
» How to Configure Simple Failover With Buffering
» How to Configure Light-Weight Queue Trimming
» How to Configure Precise Recovery With JMS
» High Availability Input Adapter EPN Assembly File Configuration
» High Availability Input Adapter Component Configuration File Configuration
» Broadcast Output Adapter EPN Assembly File Configuration
» Broadcast Output Adapter Component Configuration File Configuration
» Correlating Output Adapter EPN Assembly File Configuration
» Correlating Output Adapter Component Configuration File Configuration
» How to Configure Scalability With the Default Channel EventPartitioner
» How to Configure Scalability With a Custom Channel EventPartitioner
» How to Configure Scalability in a JMS Application Without Oracle CEP High Availability
» How to Configure Scalability in a JMS Application With Oracle CEP High Availability
» How to Configure the ActiveActiveGroupBean Group Pattern Match
» Applications Overview of Application Assembly and Deployment
» Private Application Dependencies Application Dependencies
» Shared Application Dependencies Application Dependencies
» Library Directory Application Libraries
» Library Extensions Directory Application Libraries
» Creating Application Libraries Application Libraries
» Deployment and Deployment Order
» Configuration History Management Overview of Application Assembly and Deployment
» Assembling an Oracle CEP Application Using Oracle CEP IDE for Eclipse
» Creating the MANIFEST.MF File
» Assembling Applications With Foreign Stages
» How to Assemble a Custom Adapter in its Own Bundle
» How to Assemble a Custom Event Bean in its Own Bundle
» Click OK. How to Configure an Absolute Path
» How to Update an Application Library Using Oracle CEP IDE for Eclipse
» How to View an Application Library Using the Oracle CEP Visualizer
» Message Catalog Hierarchy Using Message Catalogs With Oracle CEP Server
» Guidelines for Naming Message Catalogs
» Using Message Arguments Using Message Catalogs With Oracle CEP Server
» Message Catalog Formats Using Message Catalogs With Oracle CEP Server
» Message Catalog Localization Using Message Catalogs With Oracle CEP Server
» How to Parse a Message Catalog to Generate Logger and TextFormatter Classes for Localization
» How to Deploy an Oracle CEP Application Using Oracle CEP IDE for Eclipse
» How to Deploy an Oracle CEP Application Using Oracle CEP Visualizer
» How to Deploy an Oracle CEP Application Using the Deployer Utility
» Overview of Testing Applications With the Load Generator and csvgen Adapter
» Configuring and Running the Load Generator Utility
» Creating a Load Generator Property File
» Configuring the csvgen Adapter in Your Application
» Event Inspector HTTP Publish-Subscribe Channel and Server
» How to Trace Events Using Oracle CEP Visualizer
» Scalability Using the ActiveActiveGroupBean
» Host Configuration High Availability Performance Tuning
» High Availability Input Adapter and Quality of Service
» High Availability Input Adapter Configuration
» Broadcast Output Adapter Configuration
» Oracle Coherence Heartbeat Frequency
» Oracle Coherence Serialization Oracle Coherence Performance Tuning Options
» Adapter Lifecycle Annotations OSGi Service Reference Annotations
» Example com.bea.wlevs.configuration.Activate
» Example com.bea.wlevs.configuration.Rollback
Show more