com.solacesystems.jcsmp

Class SubscriberEndpoint

java.lang.Object

com.solacesystems.jcsmp.SubscriberEndpoint

All Implemented Interfaces:

Endpoint

public class SubscriberEndpoint
extends Object
implements Endpoint

The SubscriberEndpoint represents the Endpoint on the appliance to which an application must bind to create a flow for content-routed messages destined for a particular subscriber. These messages are directed to the subscriber based on its XPath subscriptions.

A SubscriberEndpoint may be acquired from JCSMPFactory using a configured JCSMPSession, and it is only valid for use with that session.

Example

This snippet illustrates how to bind a flow to a session's SubscriberEndpoint, which will receive Guaranteed messages matching the XPath subscriptions on that subscriber.

 // session is a JCSMPSession, no default message consumer has been acquired
 XpeProperties xp = new XpeProperties().setExpression("/*");
 session.addSubscription(JCSMPFactory.onlyInstance().createXpe(xp));
 Endpoint se = JCSMPFactory.onlyInstance().createSubscriberEndpoint(session);
 FlowReceiver qr = session.createFlow(se, null, null);
 qr.start();
 BytesXMLMessage rxmsg = qr.receive(1000);
 // process the message
 

Method Summary

Modifier and Type	Method and Description
String	getName() Gets the name of the Endpoint.
String	getVirtualRouterName() The virtual router name identifier for the Endpoint.
boolean	isDurable() Whether this Endpoint is durable.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public String getName()

Description copied from interface: Endpoint

Gets the name of the Endpoint.

Specified by:

getName in interface Endpoint

Returns:

A String representing the Endpoint name.

isDurable

public boolean isDurable()

Description copied from interface: Endpoint

Whether this Endpoint is durable.

Specified by:

isDurable in interface Endpoint

Returns:

true if this Endpoint is durable, false otherwise.

getVirtualRouterName

public String getVirtualRouterName()

Description copied from interface: Endpoint

The virtual router name identifier for the Endpoint.

Specified by:

getVirtualRouterName in interface Endpoint

Returns:

The virtual router name identifier for the Endpoint.