Contents

Popular
 Contents

The target configuration encapsulates different back end/third party  services which need to be invoked by the proxy to fulfil requests. The endpoint URL specified when creating a project is saved as the default target configuration. New targets can be added by clicking the Add button. Targets can be HTTP or JMS endpoints.

HTTP

The figure below depicts an HTTP endpoint.


Figure 1: HTTP Target 

AttributeDescription
Target IDID provided while creating a target.
Target URIURI of the Target endpoint.
MethodChoose method from Get, Post, Put and Delete.
Failover IDThe 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 failover alternative for HTTP endpoint or vice-a-versa.

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

AttributeDescription
User Name

User Name to connect to the web server.

PasswordPassword 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

AttributeDescription
User Name

User Name to connect to the web server.

PasswordPassword for the username mentioned.
HostnameHost that needed to be authenticated with.
PortPort of the host.
DOMAINDomain 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

AttributeDescription
User Name

User Name to connect to the web server.

PasswordPassword 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. Other 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 the hostname in the certificate does not match with the hostname in the request URL. If it is not selected, an 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 are organized in a package hierarchy similar to content handlers. 

Key Store Settings
AttributeDescription
Key Manager Factory TypeAlgorithm for the Key Manager Factory.
Key Store TypeType of the Key Store whose location is specified by Key Store Location should be specified in the field.
Key Store LocationLocation of the key store file.
The KeyStore is used by the component for client authentication.
Key Store PasswordPassword of the specified key store can be specified in the field.
Key Store Client KeyDetermines Key Store Client Key
Trust Store Settings
AttributeDescription
Trust Manager Factory TypeAlgorithm for the Trust Manager Factory.
Trust Store LocationLocation 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 TypeType of Trust Store whose location is specified by property Trust Store Location.
Trust Store PasswordPassword 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 the response from another JMS Destination.


Figure 7: JMS Target Configuration attributes

AttributeDescription
Target IDID provided while creating a target.
Failover IDThe 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 an HTTP endpoint as a failover alternative for JMS endpoint.

Connection Configuration

This configuration helps to connect with a provider, and administer JMS.

AttributeDescription
Server URLIP address of the JMS server.
Backup URLsThe 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 nameConnection Factory Lookup Name.
JMS usernameUsername with which the connection to the server is established.
JMS passwordPassword for the username mentioned.

JNDI Configuration

AttributeDescription
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 the Add  button.

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 for a name. It is analogous to the root, or top of a directory tree for a file system.

Session Configuration

A session is created from a connection. It is a single-thread context which generates messages to serve multiple consumers.

AttributeDescription
Is Transacted
A session can be either transacted or non-transacted. Enable this if the session is transacted. When enabled, the acknowledge mode property disappears.
Acknowledgement Mode

The type of Acknowledgement can be specified here. A session retains messages it consumes until they have been acknowledged.

Auto Acknowledge

The session automatically acknowledges a client's receipt of a message either when the session has successfully returned from the receive call or when the message listener, which has been called by the session to process the message, successfully returns.

Client Acknowledge

With this acknowledgment mode, the client acknowledges a consumed message.

Dups OK Acknowledge

This acknowledgment mode instructs the session to lazily acknowledge the delivery of messages.

Request Destination Configuration

AttributeDescription
Destination NameJNDI name of the topic/queue to be subscribed.
Destination Type

Specifies whether the destination for the port is a 'Queue' or a 'Topic':

  • Topic: This value is selected when the type of destination is a 'Topic'.
  • Queue: This value is selected when the type of destination is a 'Queue'.

Lookup DestinationEnable this property if the destination is already present and needs to be looked up using JNDI.
Autocreate DestinationEnable this property to create a destination if it is not set.

Producer Configuration

AttributeDescription
Delivery Mode

Delivery mode defines whether the message is persistent or non-persistent.

  • PERSISTENT
    Instructs the JMS provider to take extra care to ensure a message is not lost in transit in case of a JMS provider failure. A message sent with this delivery mode is logged to stable storage when it is sent.
  • NON-PERSISTENT
    NON_PERSISTENT delivery mode does not require the JMS provider to store the message or otherwise guarantee that it is not lost if the provider fails.

Icon

This factor has an impact on the performance. Choose non-persistent messages where appropriate.

PriorityThe priority of the message to be sent to the destination.
Time to Live in msThe time to live (in milliseconds) of the message to be sent to the destination. After the specified timeout, the message will be discarded.

Response Destination Configuration

Destination on which response is expected.

Icon

Refer to the Request Destination Configuration section above for the descriptions.

Error Destination

Destination on which error is expected.

Icon

Refer to the Request Destination Configuration section above for the descriptions.

Consumer Configuration

AttributeDescription
Execution Timeout in msMaximum time in milliseconds the component should wait for a message. The default value is '0' which specifies infinite wait time which signifies waiting until a message is received.
Message SelectorValue for a JMS message property to route the message.


Adaptavist ThemeBuilder EngineAtlassian Confluence