Copyright © Cloud Software Group, Inc. All Rights Reserved

Endpoint Reference

Endpoints correspond closely to the publisher and subscriber, request-response invocation server, or request-response server objects used by an Adapter SDK program. This section provides reference information for all endpoints.

In most cases, you do not create endpoints explicitly. Instead, TIBCO Designer creates a session and an endpoint for you when you create a service.

This section also discusses timers, which can potentially be used to trigger actions just like endpoints. The following topics are covered:

•	Endpoints Overview

•	Publisher Endpoints

•	Subscriber Endpoints

•	Client / Request-Response Invocation Service Endpoints

•	Server / Request-Response Service Endpoints

•

Timer

•	Adding Schema to Endpoints

Endpoints Overview

When you create a service by dragging a resource from the Adapter Services folder into the design panel, TIBCO Designer creates the corresponding session and endpoint in the Advanced folder of the Generic Adapter Configuration you are using. If you cannot fully configure the endpoint from the Adapter Services folder, you can access it in the Advanced folder and make changes there.

This chapter lists the available fields for each endpoint.

Publisher Endpoints

A publisher sends data to TIBCO Rendezvous or TIBCO Enterprise Message Service. A publisher is associated with a schema class that specifies the data to be published. Also associated with a publisher is a session. Sessions of several types are supported. The session for a publisher determines the wire format it can use. For JMS sessions, you can also change the delivery mode.

Creating sessions explicitly and adding publishers to the session is not recommended. Instead, you should create the service you need, and let TIBCO Designer create the session and endpoint. If there are changes you cannot make directly to the service, you can then make them to the corresponding session or endpoint.

TIBCO Rendezvous Publishers

TIBCO Designer supports RV, RVA, RVCM, and RVTX sessions. For each type of session, you can create a corresponding publisher.

For TIBCO Rendezvous publishers, following wire formats are supported at present:

•	Rendezvous Message is a TIBCO Rendezvous message which may have any contents, not necessarily following the TIBCO ActiveEnterprise wire format.

•	ActiveEnterprise Message is the TIBCO ActiveEnterprise standard wire format. It can include metadata information.

•	XML Message uses aeXml message format.

TIBCO Enterprise Message Service Publisher

TIBCO Designer supports JMS sessions and will create the appropriate session for you when you create a service. The Connection Factory Type (Topic or Queue) and the Delivery Mode (Persistent or non-Persistent) you assign to the service determine the session and endpoint that is created.

TIBCO Rendezvous Publisher

For an RV Publisher, you supply the following information:

Table 80 Rendezvous Publisher

Name	Name of this publisher.
Description	Optional description of the publisher.
Endpoint Type	Choose from the pop-up, which displays the allowed types for the current session.
Wire Format	Rendezvous Message, ActiveEnterprise Message, or XML Message. Default is ActiveEnterprise Message. If you choose ActiveEnterprise Message, control information is included with the message. If you choose Rendezvous Message, no control information is included with the message but control information may be included with the data.
Subject	Subject with which this publisher will send out messages.
Reply Subject	Reply subject for this publisher.

RVCM Publisher

For an RVCM publisher, you supply the following information:

Table 81 RVCM Publisher

Name	Name of this publisher.
Description	Optional description.
Endpoint Type	Choose from the pop-up, which displays the allowed types for the current session.
Wire Format	Rendezvous Message, ActiveEnterprise Message, or XML Message. Default is ActiveEnterprise Message. If you choose ActiveEnterprise Message, control information is included with the message. If you choose Rendezvous Message, no control information is included with the message but control information may be included with the data.
Subject	Subject with which this publisher will send out messages.
Reply Subject	Reply subject for this publisher.
Message Timeout (ms)	Time after which the message is discarded from the ledger file. Default is 0 seconds, meaning that the timeout is infinite.
Preregistered Listeners	Comma-separated list of listeners preregistered for this publisher. Refer to each listener using the CmName of the session.

RVTX Publisher

For a TIBCO Rendezvous TX publisher, you can supply the following information:

Table 82 RVTX Publisher

Name	Name of this publisher.
Description	Optional description.
Endpoint Type	Choose from the pop-up, which displays the allowed types for the current session.
Wire Format	Rendezvous Message, ActiveEnterprise Message, or XML Message. Default is ActiveEnterprise Message. If you choose ActiveEnterprise Message, control information is included with the message. If you choose Rendezvous Message, no control information is included with the message but control information may be included with the data.
Subject	Subject with which this publisher will send out messages.
Reply Subject	Reply subject for this publisher.
Message Timeout	Message timeout for this publisher.

JMS Topic Publisher

For a JMS publisher associated with a JMS session using a Topic Connection Factory, you can supply the following information:

Table 83 JMS Topic Publisher

Name	Name of this publisher.
Description	Optional description.
Endpoint Type	For JMS publishers, there are no endpoint type choices.
Delivery Mode	Either persistent or non-persistent.
Destination	Destination used by this publisher.
Reply Destination	Reply destination for this publisher.
Message Timeout	Message timeout for this publisher.

JMS Queue Publisher

For a JMS publisher associated with a JMS session using a Queue Connection Factory, you can supply the following information:

Table 84 JMS Queue Publisher

Name	Name of this publisher.
Description	Optional description.
Endpoint Type	For JMS publishers, there are no endpoint type choices.
Delivery Mode	Always non-persistent. The mode persistent cannot be used with JMS Queue publishers.
Destination	Destination used by this publisher.
Reply Destination	Reply destination for this publisher.
Message Timeout	Message timeout for this publisher.

 

Subscriber Endpoints

Subscribers specify the data consumers in the applications.

Creating sessions explicitly and adding subscribers to the session is not recommended. Instead, you should create the service you need, and let TIBCO Designer create the session and endpoint. If there are changes you cannot make directly to the service, you can then make them to the corresponding session or endpoint.

When you create a subscriber, the choices you get depend on the session in which the subscriber is created.

RV Subscriber, RVCM Subscriber, RVCMQ Subscriber, RVTX Subscriber

You supply the following information for each type of subscriber using TIBCO Rendezvous as the transport:

Table 85 RV, RVCM, RVCMQ, RVTX Subscriber

Name	Name of this subscriber.
Description	Optional description of the subscriber.
Endpoint Type	Choose from the pop-up, which displays the allowed types for the current session.
Wire Format	Rendezvous Message, ActiveEnterprise Message, or XML Message. Default is ActiveEnterprise Message. If you choose ActiveEnterprise Message, control information is included with the message. If you choose Rendezvous Message, no control information is included with the message but control information may be included with the data.
Subject	Subject with which this publisher will send out messages.
Listen Timeout (ms)	If no message is received after this amount of time, the adapter performs any actions specified in the program for that case. Default is 0

JMS Subscribers

You supply the following information for subscribers using JMS as a transport:

Table 86 JMS Subscribers

Name	Name of this subscriber.
Description	Optional description of the subscriber.
Endpoint Type	For JMS Subscribers, there is no choice to make.
Delivery Mode	Either durable or non-durable. Note: For subscribers using a queue session, durable is not an option.
Destination	Destination for this JMS subscriber.
Auto-confirm	If this box is checked, the SDK automatically confirms events for this subscriber.

Client / Request-Response Invocation Service Endpoints

Request-response invocation (client) services are used by ActiveEnterprise operations that communicate with a remote or local server. You can define request-response invocation services for each type of session.

See "The SDK Operation Model" in TIBCO Adapter SDK Programmer’s Guide for more information.

Creating sessions explicitly and adding clients to the session is not recommended. Instead, you should create the service you need, and let TIBCO Designer create the session and endpoint. If there are changes you cannot make directly to the service, you can then make them to the corresponding session or endpoint.

TIBCO Rendezvous Request-Response Invocation Service

You can create a TIBCO Rendezvous Request-Response Invocation Service for RV or RVCM. Each Rendezvous Request-Response Invocation Service allows you to specify the following information:

Table 87 TIBCO Rendezvous Request-Response Invocation Service

Name	Name of this client.
Description	Optional description of this client.
Endpoint Type	Choice of endpoint types for the session to which the client currently belongs.
Subject	Subject with which this client communicates with the server.
Invocation Timeout (ms)	If no reply is received by the client after this timeout, the application gets an error notification.

JMS Request-Response Invocation Service

Each JMS Request-Response Invocation Service allows you to specify the following information:

Table 88 JMS Request-Response Invocation Service

Name	Name of this client.
Description	Optional description of this client.
Delivery Mode	Non-Persistent or Persistent.
Endpoint Type	Choice of endpoint types for the session to which the client currently belongs.
Destination	Destination used to communicate with the server.
Invocation Timeout (ms)	If no reply is received by the client after this timeout, the application gets an error notification.

Server / Request-Response Service Endpoints

Request-Response services are used by ActiveEnterprise operations that communicate with a remote or local client (request-response server). You can define request-response services for each type of session.

Creating sessions explicitly and adding servers to the session is not recommended. Instead, you should create the service you need, and let TIBCO Designer create the session and endpoint. If there are changes you cannot make directly to the service, you can then make them to the corresponding session or endpoint.

See "The SDK Operation Model" in TIBCO Adapter SDK Concepts for more information.

TIBCO Rendezvous Request-Response Service

You can create a TIBCO Rendezvous Request-Response Service for RV, RVCM, or RVCMQ.

Each server allows you to specify the following information:

Table 89 TIBCO Rendezvous Request-Response Service

Name	Name of this server.
Description	Optional description of this server.
Endpoint Type	Choice of endpoint types for the session to which the client currently belongs.
Subject	Subject with which this server communicates with clients.

JMS Request-Response Service

Each server allows you to specify the following information:

Table 90 JMS Request-Response Service

Name	Name of this server.
Description	Optional description of this server.
Endpoint Type	Choice of endpoint types for the session to which the client currently belongs.
Delivery Mode	Either durable or non-durable.
Destination	Destination used to communicate with the client.

Timer

TIBCO Designer allows you to add a timer to your adapter configuration. The timer can then be used by the adapter program.

To add a timer, follow these steps:

1.	Open the Timers folder

2.	Drag a Timer from the palette panel into the design panel.

3.	Specify configuration information for the timer.

Table 91 Timer

Name	Name of this timer.
Interval (milliseconds)	Trigger interval in milliseconds (for repeating timers)
Repeating	If checked, this is a repeating timer. If not checked, this is a once-only timer.
Session Reference	Click the Browse icon to associate a session with this timer.

Adding Schema to Endpoints

As a rule, it is best to add schema to endpoints using the Schemas tab of the service. If, however, you must create the session and endpoint directly, follow these steps to add schema:

1.	In the project panel, select the endpoint while the schema object is visible.

2.	From the project panel, drag the schema object into the design panel with the endpoint still selected.

TIBCO Designer creates a reference to the schema object and includes it below the endpoint in the hierarchy.

An alternate approach to adding the schema is to use the Link Resource menu command, as follows:

1.	From the menu bar, choose Tools > Resource Tools > Link Resource.

2.	Select the schema object as the Field Resource.

3.	Select the endpoint as the Field Target.

4.

Click OK.

Copyright © Cloud Software Group, Inc. All Rights Reserved