The EBMSAdapter is used for the EB Message Service protocol. Using EBMSAdapter business information can be exchanged in a secure and reliable way between the host and the partner. Messages can be digitally signed and sent encrypted. Additionally successful receipt of messages can be confirmed by returning an acknowledgment.
Configuration
The component can be configured using the custom property sheet as shown in the following sections.
Figure 1: Configuration Property Sheet
This page is used to configure all the connection details,security details, agreement details and attachments used by the host and partner, to be sent using this EB Message Service protocol.
Configuration Property Sheet consists of following properties
Connection Properties
- End Point Address: Partner's URL on which EB MSH (message service handler) is listening, URL to which the request should be sent.
- Server Port: Details of the port on which HOST EB MSH runs,the request processing server listens
- HSQL Server Port: The details of the port on which the HSQL server should run.
- Request Timeout(in ms): TimeOut for HTTPConnection. If no response is received, on timeout Exception message is sent.
- Authentication Mode: It supports BASIC authentication for both host and partner. When BASIC authentication is selected, username and password is required.
Expert Properties
Figure 2: Configuration Property Sheet with expert properties
- Connection Details From Input: Connection Details along with agreement details are taken from input port/message, cps configuration values are overridden.
- Proxy Configuration: Proxy configuration values should be provided
EBMS Properties
Figure 3: From Party Details
- CPA ID: CPA ID describes the formal relationship between the host and partner.It identifies the parameters governing the exchange of messages between the parties.The recipient of a message must be able to resolve the CPA ID to an individual set of parameters, taking into account the sender of the message.Simply said, it is just an arbitary and mandatory string that can be used to identify sender and recipient.
- From and To Party Details: The 'From Party Details' property identifies the Party that originated the message. The 'To Party Details' property identifies the Party that is the intended recipient of the message. The PartyDetails property has PartyID, Type and Role. The type indicates the domain of names to which the string in the content of the PartyID element belongs. The value of the type MUST be mutually agreed and understood by each of the parties. The Role property identifies the authorized role (from or to) of the Party sending (when present as a child of the From element) and/or receiving (when present as a child of the To element) the message.
Figure 4: With Reliable Communication enabled
- Reliable Communication: (yes/no) - If Reliable communication is true, it enables following properties:
- Duplicate Elimination: If Duplicate Elimination is enabled to true, it will eliminate the duplicate responses. When Message Order is enabled, Duplication Elimination is mandatory.
- Send Acknowledgement: If true, then Acknowledgement will be sent for synchronous
- Request.Retry Count: the maximum number of times request is retried if ack is not received
- Retry Interval(in ms): The interval for which request will be retired.
- Send Acknowledgement to outport: If true, Received acknowledgements from partner are sent to output port.
- Persist Duration(in ms): Specifies the minimum length of time to keep the EB message in persistent storage(HSQLDB).
- Synchronous communication: The sender of an EB message can use a synchronous communications protocol to receive the associated response message over the same connection request. For synchronous reply, use following options:
- responseOnly - any mshSignals along with business responses are received on same connection request.
- None(asynchronous) - business responses are received asynchronously.
- Message Order: If true, the recipient receives EB messages in the order of sending.
- Message Buffer: It is used in case of Message Order.If Messages are received out of sequence, messages are buffered (not sent to output port). If the number of messages are more than the buffer size,BUFFER_OVERFLOW message is sent to partner.
- Create Timestamp: Add Timestamp in request.
- Create Time To Live(in ms): Specify the interval in milliseconds for the request sent.It is used to indicate the time,by which a message should be delivered to the To partner.If the time taken for message to deliver is more than the value of Time To Live,message expires.
Attachments
Payloads: Configure the attachments.
Security Properties
Security Details
Security Details for both host and counterpart can be configured here.Set 'Sign Message' to indicate whether to require inbound messages to be signed.Set Message Encrypted to indicate whether to require inbound messages to be encrypted. If requiring encryption:From the EncryptionMethod, select the required method.Present encryption methods:
- DESede
- AES-128
- AES-192
- AES-256
The acknowledgement is signed at the request of a partner and depends on the configuration of an identification credentials set.From the 'Signature Algorithm' list, select the algorithm used to sign the outbound EB message. From the 'Canonicalization Method' list, select the algorithm to canonicalize the SOAP Envelope XML and exclude comments before signing outbound EB messages.
Figure 5: Host Security Details
Similarly, Counterparty's Security Details can be configured.