com.solacesystems.solclientj.core

Class Solclient

java.lang.Object

com.solacesystems.solclientj.core.Solclient

public class Solclient
extends java.lang.Object

This is the entry point of Java RTO messaging API. Applications using this API, will interact with this class to perform the following:

• Initialize the API
• Adjust logging levels
• Create context instances
• Create message instances
• Use the Solclient.Allocator factory to create various objects
• Get information such as errors and statistics

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Solclient.Allocator Used to group the set of allocation factory methods for the different object types
static class	Solclient.GLOBAL_PROPERTIES Global Configuration Properties.

Constructor Summary

Constructors

Constructor and Description
Solclient()

Method Summary

Modifier and Type	Method and Description
static int	createContextForHandle(ContextHandle in_out_contextHandle, java.lang.String[] properties) Allocates a new Context which will be bound to a given unbound ContextHandle.
static int	createMessageForHandle(MessageHandle in_out_messageHandle) Allocate a new message that can be used for storing and sending messages to and from the Solace Messaging Appliance. The allocated message will be bound to a given unbound MessageHandle Applications are responsible for releasing all messages allocated by this method, by calling MessageHandle.destroy()
static int	createNativeDestinationForHandle(NativeDestinationHandle in_out_NativeDestinationHandle, Destination destination) Allocates a NativeDestination resource for the given Destination and binds it to an unbound NativeDestinationHandle.
static MessageHandle	createNewMessageAndHandle() A convenience factory method that produces a MessageHandle with an newly allocated message in the handle.
static int	createReplicationGroupMessageIdForHandle(ReplicationGroupMessageIdHandle in_out_ReplicationGroupMessageIdHandle, java.lang.String rgmidStr) Allocates a new ReplicationGroupMessageId resource using the serialized ReplicationGroupMessageId String and binds it to an unbound ReplicationGroupMessageIdHandle.
static SolclientErrorInfo	getLastErrorInfo() Returns a SolclientErrorInfo instance, which contains the last captured error information for the calling thread.
static long	getMessageLevelStat(int msgLevelStatEnum) Returns the value of the specified message statistic.
static long	getQuantaLevelStat(int quantaStatEnum, int quantaIdx) Returns the quanta level statistic for the given quantaIdx
static Version	getVersion() Returns the Java RTO Version information
static int	init(java.lang.String[] properties) Initializes the Messaging APIs. This function must be called before any other API interface call is made, with the exception of Solclient.setLogLevel(), which can be called first to set the Log level.
static boolean	isInitialized() Returns a boolean indicating if Messaging APIs has been initialized.
static boolean	isInitilized() Deprecated. use Solclient.isInitialized() instead.
static int	setLogLevel(java.util.logging.Level javaLogLevel) Sets the log level to the desired java logging level.

Methods inherited from class java.lang.Object

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

Constructor Detail

Solclient

public Solclient()

Method Detail

init

public static int init(java.lang.String[] properties)
                throws SolclientException

Initializes the Messaging APIs.
This function must be called before any other API interface call is made, with the exception of Solclient.setLogLevel(), which can be called first to set the Log level.

Typically init() is called once during program initialization. Only configuration properties named in Solclient.GLOBAL_PROPERTIES are processed; other property names are ignored. Any values not supplied are set to default values. This function takes care of any required global initialization. Note that the property values are stored internally in the API, and the caller does not have to maintain the props array after this call completes. Also, the API does not modify the properties array when processing the property list.

Parameters:

properties - An array of name and value string pairs for global configuration properties, or NULL, if there are no global properties to set.

Returns:

a SolEnum.ReturnCode: SolEnum.ReturnCode.OK

Throws:

SolclientException

isInitialized

public static boolean isInitialized()

Returns a boolean indicating if Messaging APIs has been initialized. The Messaging API becomes initialized when the Solclient.init() is called.

Returns:

indicates if the Messaging APIs has been initialized

isInitilized

@Deprecated
public static boolean isInitilized()

Deprecated. use Solclient.isInitialized() instead.

The old misspelled method name for isInitialized.

setLogLevel

public static int setLogLevel(java.util.logging.Level javaLogLevel)
                       throws SolclientException

Sets the log level to the desired java logging level. This is necessary as the logging levels are translated and set in the underlying CCSMP layer to keep the java logging and the CCSMP logging in sync. Adjusting the logging level directly at runtime without a call to this method could leave the API exposed to poor performance and garbage collection as CCSMP generated logs are directed into the JavaRTO API but ignored once they arrive to the java logging.

Parameters:

javaLogLevel - Level

Returns:

SolEnum.ReturnCode

Throws:

SolclientException

createMessageForHandle

public static int createMessageForHandle(MessageHandle in_out_messageHandle)
                                  throws SolclientException

Allocate a new message that can be used for storing and sending messages to and from the Solace Messaging Appliance.
The allocated message will be bound to a given unbound MessageHandle
Applications are responsible for releasing all messages allocated by this method, by calling MessageHandle.destroy()

Parameters:

in_out_messageHandle - an unbound MessageHandle which will be bound to the newly created Message

Returns:

a SolEnum.ReturnCode: SolEnum.ReturnCode.OK

Throws:

SolclientException

createNewMessageAndHandle

public static MessageHandle createNewMessageAndHandle()
                                               throws SolclientException

A convenience factory method that produces a MessageHandle with an newly allocated message in the handle.

This allocates a new MessageHandle and populates the MessageHandle with a new message.
This is equivalent to calling Allocator.newMessageHandle() followed by Solclient.createMessageForHandle()
Applications are responsible for releasing all the message allocated by this method, by calling MessageHandle.destroy()

Returns:

A bound MessageHandle

Throws:

SolclientException

createContextForHandle

public static int createContextForHandle(ContextHandle in_out_contextHandle,
                                         java.lang.String[] properties)
                                  throws SolclientException

Allocates a new Context which will be bound to a given unbound ContextHandle.

The context properties are supplied as an array of name/value pointer pairs, where the name and value are both strings. The context properties are reserved for future use. Applications are responsible for releasing a context allocated by this method, by calling ContextHandle.destroy()

Parameters:

properties - an array of property name and values, reserved for future use.

in_out_contextHandle - an unbound ContextHandle which will be bound to the newly created Context

Returns:

SolEnum.ReturnCode

Throws:

SolclientException

createNativeDestinationForHandle

public static int createNativeDestinationForHandle(NativeDestinationHandle in_out_NativeDestinationHandle,
                                                   Destination destination)

Allocates a NativeDestination resource for the given Destination and binds it to an unbound NativeDestinationHandle. A NativeDestinationHandle should be used in all cases when a destination needs to be set and reused in fast operations when efficiency is important. Note: A MutableTopic is not supported as a Destination for this operation. There is no advantage to using a NativeDestination for a MutableTopic. A MutableTopic can be used directly when publishing and subscribing as efficiently as a NativeDestination

Parameters:

in_out_NativeDestinationHandle - an unbound NativeDestinationHandle

destination -

Returns:

a SolEnum.ReturnCode: SolEnum.ReturnCode.OK

getVersion

public static Version getVersion()
                          throws SolclientException

Returns the Java RTO Version information

Returns:

a Version instance

Throws:

SolclientException

getLastErrorInfo

public static SolclientErrorInfo getLastErrorInfo()
                                           throws SolclientException

Returns a SolclientErrorInfo instance, which contains the last captured error information for the calling thread. This information is captured on a per-thread basis. The returned object is only valid until the thread makes the next API call.

This method is typically invoked from within callback listener invocations (Session and Flow), to get more info on the reported event.

Returns:

a SolclientErrorInfo

Throws:

SolclientException

getQuantaLevelStat

public static long getQuantaLevelStat(int quantaStatEnum,
                                      int quantaIdx)
                               throws SolclientException

Returns the quanta level statistic for the given quantaIdx

Parameters:

quantaStatEnum - , one of SolEnum.QuantaLevelStat

quantaIdx - index of the quanta, an int in {0..NUM_MSG_QUANTA}

Returns:

quanta stat for the given quantaIdx

Throws:

SolclientException

getMessageLevelStat

public static long getMessageLevelStat(int msgLevelStatEnum)
                                throws SolclientException

Returns the value of the specified message statistic.

Parameters:

msgLevelStatEnum - , one of SolEnum.MessageLevelStat

Returns:

message level stat

Throws:

SolclientException

createReplicationGroupMessageIdForHandle

public static int createReplicationGroupMessageIdForHandle(ReplicationGroupMessageIdHandle in_out_ReplicationGroupMessageIdHandle,
                                                           java.lang.String rgmidStr)

Allocates a new ReplicationGroupMessageId resource using the serialized ReplicationGroupMessageId String and binds it to an unbound ReplicationGroupMessageIdHandle.

Parameters:

in_out_ReplicationGroupMessageIdHandle - an unbound ReplicationGroupMessageIdHandle

rgmidStr -

Returns:

a SolEnum.ReturnCode: SolEnum.ReturnCode.OK