The target configuration encapsulates different back end/third party services which needs to be invoked by the proxy to fulfil requests. The endpoint URL specified when creating a project is saved as default target configuration. New targets can be added by clicking the Add button. The targets can be either HTTP or JMS endpoints.
HTTP
Figure 1 depicts an HTTP endpoint.
Figure 1: HTTP Target
| Attribute | Description |
|---|---|
| Target ID | ID provided while creating a target. |
| Target URI | URI of the Target endpoint. |
| Method | Choose method from Get, Post, Put and Delete. |
| Failover ID | The ID of the target which needs to be invoked if invocation fails on this server. |
Target Fail over
When a target is not available it is possible to redirect the call to another target using the Failover ID (mentioned in the table above). It is also possible to specify a JMS endpoint as a fail over alternative for HTTP endpoint or vice-a-verse.
Authentication
This property is used to enable authentication. The three Authentication types are Basic, Digest and NTLM.
Use the option 'NONE' if authentication is not required.
Figure 2: Default type of Authentication
Authentication Type - Basic
When Authentication Type is 'BASIC', the following attributes need to be specified.
Figure 3: Basic Authentication type attributes
| Attribute | Description |
|---|---|
| User Name | User Name to connect to the web server. |
| Password | Password for the username mentioned. |
Authentication Type - Digest
When Authentication Type is 'DIGEST', the following attributes need to be specified.
Figure 4: Digest Authentication type attributes
| Attribute | Description |
|---|---|
| User Name | User Name to connect to the web server. |
| Password | Password for the username mentioned. |
| Hostname | Host that needed to be authenticated with. |
| Port | Port of the host that needed to be authenticated with. |
| DOMAIN | Domain name needed by NT Credentials for NT Domain. |
Authentication Type - NTLM
When Authentication Type is 'NTLM', the following attributes need to be specified.
Figure 5: NTLM Authentication type attributes
| Attribute | Description |
|---|---|
| User Name | User Name to connect to the web server. |
| Password | Password for the username mentioned. |
| Realm | Realm for authentication scope. |
SSL Configuration
Figure 6: SSL Configuration attributes
Use SSL
Select this option to enable SSL Settings. Rest of the properties in this editor are enabled and configurable only when this property is checked.
Alias
Alias identifies the client to the server.
Accept Server Certificate
When accessing HTTPs URLs, this property determines whether the server certificates should be accepted or not. If selected, the certificate will be accepted without any validation.
Ignore Hostname Mismatch
If this option is selected, the certificate will be accepted even if hostname in the certificate does not match with the hostname in the request URL. If its not selected exception is thrown.
Protocol Handler Packages
Determines protocol handler packages property.
Security Protocol
Determines Security protocol
Security Provider Class
Determines Security provider class.
Protocol Handler Packages
Protocol handlers organized in a package hierarchy similar to content handlers.
Key Store Settings
| Attribute | Description |
|---|---|
| Key Manager Factory Type | Algorithm for the Key Manager Factory. |
| Key Store Type | Type of the Key Store whose location is specified by Key Store Location should be specified in the fileld. |
| Key Store Location | Location of the key store file can be provided using the file dialog that opens up on clicking the ellipsis The KeyStore is used by the component for client authentication. |
| Key Store Password | Password of the specified key store can be specified in the field. |
| Key Store Client Key | Determines Key Store Client Key |
Trust Store Settings
| Attribute | Description |
|---|---|
| Trust Manager Factory Type | Algorithm for the Trust Manager Factory. |
| Trust Store Location | Location of the trust store file should be specified. TrustStore is a file where digital certificates of trusted sites are stored and retrieved for authentication during an SSL connection. TrustStore is used to authenticate a server in SSL authentication. |
| Trust Store Type | Type of Trust Store whose location is specified by property Trust Store Location. |
| Trust Store Password | Password of the specified trust store should be specified in the field. |
JMS Target
The JMS target can be used to invoke any Message Oriented Middleware systems instead of an HTTP endpoint.
It allows the proxy to make a Requestor style call to a JMS Destination and wait for response from another JMS Destination.
Figure 7: JMS Target Configuration attributes
| Attribute | Description |
|---|---|
| Target ID | ID provided while creating a target. |
| Failover ID | The ID of the target which needs to be invoked if invocation fails on this server. |
Target Fail over
When a target is not available it is possible to redirect the call to another target using the Failover ID (mentioned in the table above). It is also possible to specify a HTTP endpoint as a fail over alternative for JMS endpoint.
Connection Configuration
This configuration helps to connect with a provider and administer JMS.
| Attribute | Description |
|---|---|
| Server URL | IP address of the JMS server. |
| Backup URLs | The backup URLs to which the component tries to connect if the server specified by the property "server URL" is down. Multiple backup URLs can be specified by separating them with a ';'. |
| CF lookup name | Connection Factory Lookup Name. |
| JMS username | Username with which the connection to the server is established. |
| JMS password | Password for the username mentioned. |
JNDI Configuration
| Attribute | Description |
|---|---|
| JNDI Username | The name with which the user connects to the JNDI server to perform lookup operations. |
| JNDI Password | The password for the JNDI username. |
Initial Context Factory | The name of the initial context factory. The initial context is typically used as a starting point. |
Properties (for Initial Context) | Properties can be used for creating an initial context by providing specific values by clicking Add An initial context must be created using the specific implementation and extra parameters required by the implementation. The initial context will be used to look up a name. It is analogous to the root or top of a directory tree for a file system. |
button.Session Configuration
A session is created from a connection. It is a single-thread context which generates messages to serve multiple consumers.
| Attribute | Description |
|---|---|
| Is Transacted | A session can be either transacted or non-transacted. Enable this if the session is transacted; the acknowledge mode property disappears. |
Acknowledgement Mode | The type of Acknowledgement mode can be specified here. A session retains messages it consumes until they have been acknowledged.
Auto AcknowledgeThe session automatically acknowledges a client's receipt of a message either when the session has successfully returned from a call to receive or when the message listener the session has called to process the message successfully returns. Client AcknowledgeWith this acknowledgment mode, the client acknowledges a consumed message. Dups OK AcknowledgeThis acknowledgment mode instructs the session to lazily acknowledge the delivery of messages. |
Request Destination Configuration
| Attribute | Description |
|---|---|
| Destination Name | JNDI name of the topic/queue to be subscribed to. |
Destination Type | Specifies whether the destination for the port is 'Queue' or 'Topic':
|
| Lookup Destination | Enable this property if the destination is already present and needs to be looked up using JNDI. |
| Autocreate Destination | Enable this property to create a destination if it is not set. |
Producer Configuration
| Attribute | Description |
|---|---|
| Delivery Mode | Delivery mode defines whether the message can be persistent or non-persistent; choose either of these as per requirement:
|
| Priority | The priority of the message to be sent to the destination. |
| Time to Live in ms | The time to live (in milliseconds) of the message to be sent to the destination. After the timeout the message will be discarded. |
Response Destination Configuration
Destination on which response is expected.
Error Destination
Destination on which error is expected.
Consumer Configuration
| Attribute | Description |
|---|---|
| Execution Timeout in ms | Maximum time in milliseconds the component should wait for a message. Default value is 0 which specifies infinite wait time that is, waits until a message is received. |
| Message Selector | Value for a JMS message property to route the message depending on that. |