com.solacesystems.solclientj.core

Class Solclient.Allocator

java.lang.Object

com.solacesystems.solclientj.core.Solclient.Allocator

Enclosing class:

Solclient

public static final class Solclient.Allocator
extends java.lang.Object

Used to group the set of allocation factory methods for the different object types

Note: Objects created from this factory will not allocate native objects

Constructor Summary

Constructors

Constructor and Description
Allocator()

Method Summary

Modifier and Type	Method and Description
static CacheSessionEvent	newCacheSessionEvent() Allocates a new CacheSessionEvent, this instance is to be used with the CacheSessionHandle.takeCacheSessionEvent() method.
static CacheSessionHandle	newCacheSessionHandle() Allocates a new CacheSessionHandle, this is an "unbound" handle that can be used with SessionHandle.createCacheSessionForHandle() method to allocate and "bind" a native resource with this handle.
static ClientName	newClientName(java.lang.String clientName) Creates a representation of ClientName with the given clientName.
static ContextHandle	newContextHandle() Allocates a new ContextHandle, this is an "unbound" handle that can be used with Solclient.createContextForHandle().
static FlowEvent	newFlowEvent() Allocates a new FlowEvent, this instance is to be used with the FlowHandle.takeFlowEvent() method.
static FlowHandle	newFlowHandle() Allocates a new FlowHandle, this is an "unbound" handle that can be used with SessionHandle.createFlowForHandle() TransactedSessionHandle.createFlowForHandle()
static MessageDispatchTargetHandle	newMessageDispatchTargetHandle(Subscription subscription, MessageCallback messageCallback, boolean isLocalDispatchOnly) Allocates a new MessageDispatchTargetHandle for the given Subscription having a MessageCallback.
static MessageHandle	newMessageHandle() Allocates a new MessageHandle, this is an "unbound" handle that can be used with Solclient.createMessageForHandle().
static MutableMessageDispatchTargetHandle	newMutableMessageDispatchTargetHandle() Allocates a new MessageDispatchTargetHandle
static MutableTopic	newMutableTopic() Creates a representation of a MutableTopic destination and allocates an empty name byteBuffer of max-topic-size (250 bytes).
static MutableTopic	newMutableTopic(java.nio.ByteBuffer topicNameBuffer) Creates a representation of a MutableTopic destination with the given topicName stored in a ByteBuffer.
static NativeDestinationHandle	newNativeDestinationHandle() Allocates a new NativeDestinationHandle, this is an "unbound" handle that can be used with Solclient.createNativeDestinationForHandle().
static Queue	newQueue(java.lang.String queueName) Creates a representation of a Durable Queue destination with the given queueName but no set Endpoint.PROPERTIES.
static Queue	newQueue(java.lang.String queueName, java.lang.String[] endpointProperties) Creates a representation of a Durable Queue destination with the given queueName and Endpoint.PROPERTIES.
static ReplicationGroupMessageIdHandle	newReplicationGroupMessageIdHandle() Allocates a new ReplicationGroupMessageIdHandle, this is an "unbound" handle that can be used with Solclient.createReplicationGroupMessageIdForHandle().
static SessionEvent	newSessionEvent() Allocates a new SessionEvent, this instance is to be used with the SessionHandle.takeSessionEvent() method.
static SessionHandle	newSessionHandle() Allocates a new SessionHandle, this is an "unbound" handle that can be used with ContextHandle.createSessionForHandle().
static Topic	newTopic(java.lang.String topicName) Creates a representation of non-temporary Topic destination wih the given topicName.
static TopicEndpoint	newTopicEndpoint(java.lang.String topicEndpointName) Creates a representation of Durable Topic Endpoint (DTE) TopicEndpoint in the API, having the given topicEndpointName, but no set Endpoint.PROPERTIES.
static TopicEndpoint	newTopicEndpoint(java.lang.String topicEndpointName, java.lang.String[] endpointProperties) Creates a representation of Durable Topic Endpoint (DTE) TopicEndpoint in the API, having the given topicEndpointName and Endpoint.PROPERTIES.
static TransactedSessionHandle	newTransactedSessionHandle() Allocates a new TransactedSessionHandle, this is an "unbound" handle that can be used with SessionHandle.createTransactedSessionForHandle() method to allocate and "bind" a native resource with this handle.

Methods inherited from class java.lang.Object

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

Constructor Detail

Allocator

public Allocator()

Method Detail

newTopic

public static Topic newTopic(java.lang.String topicName)

Creates a representation of non-temporary Topic destination wih the given topicName.

Parameters:

topicName -

Returns:

a Topic instance

newMutableTopic

public static MutableTopic newMutableTopic(java.nio.ByteBuffer topicNameBuffer)

Creates a representation of a MutableTopic destination with the given topicName stored in a ByteBuffer.

Parameters:

topicNameBuffer - The topic name is used to initialize the MutableTopic. The ByteBuffer is not referenced by the MutableTopic after create and may be used for other purposes.

Returns:

a MutableTopic instance

newMutableTopic

public static MutableTopic newMutableTopic()

Creates a representation of a MutableTopic destination and allocates an empty name byteBuffer of max-topic-size (250 bytes).

Returns:

a MutableTopic instance

newQueue

public static Queue newQueue(java.lang.String queueName)

Creates a representation of a Durable Queue destination with the given queueName but no set Endpoint.PROPERTIES.

Parameters:

queueName - The name of the durable queue

Returns:

a Queue instance

See Also:

Solclient.Allocator.newQueue(String, String[])

newQueue

public static Queue newQueue(java.lang.String queueName,
                             java.lang.String[] endpointProperties)

Creates a representation of a Durable Queue destination with the given queueName and Endpoint.PROPERTIES.

Parameters:

queueName - The name of the durable queue

endpointProperties - Endpoint.PROPERTIES

Returns:

a Queue instance

See Also:

Solclient.Allocator.newQueue(String)

newTopicEndpoint

public static TopicEndpoint newTopicEndpoint(java.lang.String topicEndpointName)

Creates a representation of Durable Topic Endpoint (DTE) TopicEndpoint in the API, having the given topicEndpointName, but no set Endpoint.PROPERTIES.

Parameters:

topicEndpointName - The name of the durable Topic Endpoint

Returns:

a TopicEndpoint instance

See Also:

Solclient.Allocator.newTopicEndpoint(String, String[])

newTopicEndpoint

public static TopicEndpoint newTopicEndpoint(java.lang.String topicEndpointName,
                                             java.lang.String[] endpointProperties)

Creates a representation of Durable Topic Endpoint (DTE) TopicEndpoint in the API, having the given topicEndpointName and Endpoint.PROPERTIES.

Parameters:

topicEndpointName - The name of the durable Topic Endpoint

endpointProperties - Endpoint.PROPERTIES

Returns:

a TopicEndpoint instance

See Also:

Solclient.Allocator.newTopicEndpoint(String)

newClientName

public static ClientName newClientName(java.lang.String clientName)

Creates a representation of ClientName with the given clientName.

Parameters:

clientName -

Returns:

a ClientName instance

See Also:

ClientName

newSessionHandle

public static SessionHandle newSessionHandle()

Allocates a new SessionHandle, this is an "unbound" handle that can be used with ContextHandle.createSessionForHandle().

Returns:

an "unbound" SessionHandle instance

newContextHandle

public static ContextHandle newContextHandle()

Allocates a new ContextHandle, this is an "unbound" handle that can be used with Solclient.createContextForHandle().

Returns:

an "unbound" ContextHandle instance

newMessageHandle

public static MessageHandle newMessageHandle()

Allocates a new MessageHandle, this is an "unbound" handle that can be used with Solclient.createMessageForHandle().

Returns:

an "unbound" MessageHandle instance

newNativeDestinationHandle

public static NativeDestinationHandle newNativeDestinationHandle()

Allocates a new NativeDestinationHandle, this is an "unbound" handle that can be used with Solclient.createNativeDestinationForHandle().

Returns:

an "unbound" NativeDestinationHandle instance

newMessageDispatchTargetHandle

public static MessageDispatchTargetHandle newMessageDispatchTargetHandle(Subscription subscription,
                                                                         MessageCallback messageCallback,
                                                                         boolean isLocalDispatchOnly)

Allocates a new MessageDispatchTargetHandle for the given Subscription having a MessageCallback.

The allocated MessageDispatchTargetHandle is used to create a subscription entry in the API by calling SessionHandle.subscribe() or FlowHandle.subscribe().

A MessageDispatchTargetHandle includes the Local Dispatch Only attribute. By setting this attribute, the Subscription is not sent to the appliance and exists only in the local API dispatch table. This can serve to reduce the resource use on the appliance in the network of appliances.

For this to have any affect at all, an encompassing Subscription must be set on the appliance. For example, an application could send the subscription /foo/> to the appliance and this subscription will be propogated through the network. Then the application could add 'Local Dispatch Only' subscriptions for /foo/1, /foo/2, and /foo/3. Messages on all these topics would be delivered to the application due to the wild card subscription. They would then be dispatched to the individual MessageDispatchTargetHandle by the Local Dispatch Only entries.

Parameters:

subscription -

messageCallback -

isLocalDispatchOnly - indicates if this Dispatch target is for Local delivery only.

Returns:

an "unbound" MessageDispatchTargetHandle instance

newMutableMessageDispatchTargetHandle

public static MutableMessageDispatchTargetHandle newMutableMessageDispatchTargetHandle()

Allocates a new MessageDispatchTargetHandle

The allocated MessageDispatchTargetHandle is used to create a subscription entry in the API by calling SessionHandle.subscribe() or FlowHandle.subscribe().

Returns:

an "unbound" MessageDispatchMutableTopicHandle instance

newFlowHandle

public static FlowHandle newFlowHandle()

Allocates a new FlowHandle, this is an "unbound" handle that can be used with

• SessionHandle.createFlowForHandle()
• TransactedSessionHandle.createFlowForHandle()

Returns:

an "unbound" FlowHandle instance

newTransactedSessionHandle

public static TransactedSessionHandle newTransactedSessionHandle()

Allocates a new TransactedSessionHandle, this is an "unbound" handle that can be used with SessionHandle.createTransactedSessionForHandle() method to allocate and "bind" a native resource with this handle.

Returns:

an "unbound" TransactedSessionHandle instance

newCacheSessionHandle

public static CacheSessionHandle newCacheSessionHandle()

Allocates a new CacheSessionHandle, this is an "unbound" handle that can be used with SessionHandle.createCacheSessionForHandle() method to allocate and "bind" a native resource with this handle.

Returns:

an "unbound" CacheSessionHandle instance

newSessionEvent

public static SessionEvent newSessionEvent()

Allocates a new SessionEvent, this instance is to be used with the SessionHandle.takeSessionEvent() method.

Returns:

a SessionEvent instance

newFlowEvent

public static FlowEvent newFlowEvent()

Allocates a new FlowEvent, this instance is to be used with the FlowHandle.takeFlowEvent() method.

Returns:

a FlowEvent instance.

newCacheSessionEvent

public static CacheSessionEvent newCacheSessionEvent()

Allocates a new CacheSessionEvent, this instance is to be used with the CacheSessionHandle.takeCacheSessionEvent() method.

Returns:

a CacheSessionEvent instance.

newReplicationGroupMessageIdHandle

public static ReplicationGroupMessageIdHandle newReplicationGroupMessageIdHandle()

Allocates a new ReplicationGroupMessageIdHandle, this is an "unbound" handle that can be used with Solclient.createReplicationGroupMessageIdForHandle().

Returns:

an "unbound" ReplicationGroupMessageIdHandle instance