- getAddress() - Method in interface com.ibm.ima.plugin.ImaEndpoint
-
Returns the IP address of the interface where the endpoint accepts connections.
- getBodyBytes() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get the body of the message as byte array.
- getBodyMap() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get the body of the message as a Map.
- getBodyText() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get the body of the message as a String.
- getBoolean(String, boolean) - Method in class com.ibm.ima.plugin.util.ImaJson
-
Get a boolean from a named JSON item.
- getBooleanProperty(String, boolean) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get a message property as a boolean.
- getCertName() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the certificate name.
- getClientAddress() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the client IP address associated with this connection.
- getClientID() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the client ID.
- getClientPort() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the client port number associated with this connection.
- getConfig() - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Get the plug-in configuration properties.
- getConnection() - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Returns the connection of the subscription
- getConnection() - Method in interface com.ibm.ima.plugin.ImaTransaction
-
- getConnectionListener() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the connection listener associated with this connection.
- getDestination() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get the name of the destination the message was published to.
- getDestination() - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Returns the destination of the subscription
- getDestinationType() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get the type of the destination the message was published to.
- getDestinationType() - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Returns the destination type.
- getEndpoint() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the endpoint associated with this connection.
- getEntries() - Method in class com.ibm.ima.plugin.util.ImaJson
-
Get the array of entries after a parse.
- getEntryCount() - Method in class com.ibm.ima.plugin.util.ImaJson
-
Get the count of entries after a parse.
- getErrorCode() - Method in exception com.ibm.ima.plugin.ImaPluginException
-
Get the error code for the exception.
- getHttpCookie(String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Get an HTTP cookie by name.
- getHttpCookieSet() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Get a Set of HTTP cookie names.
- getHttpHeader(String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Get an HTTP header from the current HTTP connection.
- getIndex() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the index associated with this connection.
- getInt(String, int) - Method in class com.ibm.ima.plugin.util.ImaJson
-
Get an integer from a named JSON item.
- getIntPropery(String, int) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get a message property as an integer.
- getLine() - Method in class com.ibm.ima.plugin.util.ImaJson
-
Return the line position after the parse.
- getMaxMessgeSize() - Method in interface com.ibm.ima.plugin.ImaEndpoint
-
Returns the maximum message size for the endpoint.
- getMessageHub() - Method in interface com.ibm.ima.plugin.ImaEndpoint
-
Returns the name of the message hub to which the endpoint belongs
- getMessageType() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get the type of the message body.
- getName() - Method in interface com.ibm.ima.plugin.ImaEndpoint
-
Returns the name of the endpoint.
- getName() - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Get the plug-in name.
- getName() - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Returns the name of the subscription.
- getNoLocal() - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Returns the nolocal setting of the subscription.
- getPassword() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the password in obfuscated form.
- getPersistence() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get the persistence of the message.
- getPort() - Method in interface com.ibm.ima.plugin.ImaEndpoint
-
Returns the port number of the endpoint.
- getPosition() - Method in class com.ibm.ima.plugin.util.ImaJson
-
Return the position after the parse.
- getProperties() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get a read-only map of the user message properties.
- getProperty(String) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get a message property as an Object.
- getProtocol() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the protocol associated with this connection.
- getProtocolFamily() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the protocol family associated with this connection.
- getProtocolFamily() - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Get the protocol family of the plug-in.
- getProtocolMask() - Method in interface com.ibm.ima.plugin.ImaEndpoint
-
Returns the protocol mask for the endpoint.
- getReliability() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get the reliability of the message.
- getReliability() - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Returns the reliability setting of the subscription
- getRetain() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get the retain value of the message.
- getRetainAsPublished() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get the retained value as published.
- getRetainedMessage(String, Object) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Receive the retained message (if any) from a topic.
- getState() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the state of the connection.
- getString(String) - Method in class com.ibm.ima.plugin.util.ImaJson
-
Get a string from a named JSON item.
- getStringProperty(String) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get a message property as a String.
- getSubscriptionType() - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Returns the subscription type.
- getTransactionListener() - Method in interface com.ibm.ima.plugin.ImaTransaction
-
- getUser() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the user name.
- getUserData() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the user data
- getUserData() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Get a user object associated with this message.
- getUserData() - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Returns the user data
- getValue(int) - Method in class com.ibm.ima.plugin.util.ImaJson
-
Return the value of an item as an object.
- GroupID - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
An identifier of the group of a message - String
- GroupSeq - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The sequence within a group - int
- ImaBase64 - Class in com.ibm.ima.plugin.util
-
The ImaBase64 class is used to convert byte arrays to and from base64 strings.
- ImaConnection - Interface in com.ibm.ima.plugin
-
A connection represents a logical communications channel.
- ImaConnectionListener - Interface in com.ibm.ima.plugin
-
The connection listener defines the callbacks associated with a connection.
- ImaDestinationType - Enum in com.ibm.ima.plugin
-
Define the destination type as topic or queue
- ImaEndpoint - Interface in com.ibm.ima.plugin
-
The ImaEndpoint object represents a read only object which contains the settings of the
endpoint within IBM MessageSight.
- ImaJson - Class in com.ibm.ima.plugin.util
-
The ImaJson class is used to parse a JSON string.
- ImaJson() - Constructor for class com.ibm.ima.plugin.util.ImaJson
-
Create a JSON parser object.
- ImaJson.Entry - Class in com.ibm.ima.plugin.util
-
A JSON entry.
- ImaJson.Entry() - Constructor for class com.ibm.ima.plugin.util.ImaJson.Entry
-
- ImaJson.JObject - Enum in com.ibm.ima.plugin.util
-
JSON object entry type.
- ImaMessage - Interface in com.ibm.ima.plugin
-
The ImaMessage interface defines a message within the plug-in and represents the
message as known internally in the MessageSight server.
- ImaMessageType - Enum in com.ibm.ima.plugin
-
Define the type of the message body.
- ImaPlugin - Interface in com.ibm.ima.plugin
-
A plug-in interface defines a set of methods which can be invoked for this plug-in.
- ImaPluginException - Exception in com.ibm.ima.plugin
-
The ImaPluginExecption is used to indicate an error when processing a synchronous request.
- ImaPluginException(String, String, Throwable) - Constructor for exception com.ibm.ima.plugin.ImaPluginException
-
Create a plug-in runtime exception with a cause.
- ImaPluginException(String, String) - Constructor for exception com.ibm.ima.plugin.ImaPluginException
-
Create a plug-in runtime exception without a cause.
- ImaPluginListener - Interface in com.ibm.ima.plugin
-
The ImaPluginListener defines a set of callback methods which are called by MessageSight.
- ImaPropertyID - Class in com.ibm.ima.plugin
-
A property ID defines identifiers for header fields that are larger than one byte.
- ImaPropertyID() - Constructor for class com.ibm.ima.plugin.ImaPropertyID
-
- ImaReliability - Enum in com.ibm.ima.plugin
-
Define the reliability or quality of service of the message.
- ImaSubscription - Interface in com.ibm.ima.plugin
-
The ImaSubscription object is created using the newSubscription() method of ImaConnection.
- ImaSubscriptionType - Enum in com.ibm.ima.plugin
-
Define the type of a shared subscription
- ImaTransaction - Interface in com.ibm.ima.plugin
-
The ImaSubscription object is created using the newSubscription() method of ImaConnection.
- ImaTransactionListener - Interface in com.ibm.ima.plugin
-
The transaction listener defines the callbacks associated with a transaction.
- initialize(ImaPlugin) - Method in interface com.ibm.ima.plugin.ImaPluginListener
-
Callback when the plug-in is loaded.
- inUse() - Method in interface com.ibm.ima.plugin.ImaTransaction
-
- isClient() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns whether this is an outgoing connection.
- isInternal() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns whether the connection is internal.
- isReliable() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns whether the connection is reliable.
- isReliable() - Method in interface com.ibm.ima.plugin.ImaEndpoint
-
Returns whether the connection is reliable.
- isSecure() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns whether the connection is secure.
- isSecure() - Method in interface com.ibm.ima.plugin.ImaEndpoint
-
Returns whether the connection is secure.
- isSubscribed() - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Returns whether the subscription is currently active.
- isTraceable(int) - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Check if trace is allowed at the specified level.
- isValid() - Method in interface com.ibm.ima.plugin.ImaTransaction
-
- ObjectID - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
An identifier of an object associated with the message
- objtype - Variable in class com.ibm.ima.plugin.util.ImaJson.Entry
-
The type of the object
- onAuthenticate(ImaConnection) - Method in interface com.ibm.ima.plugin.ImaPluginListener
-
Callback to request authentication of a connection.
- onClose(int, String) - Method in interface com.ibm.ima.plugin.ImaConnectionListener
-
Called when the connection is closing.
- onCommit(ImaTransaction, int, String) - Method in interface com.ibm.ima.plugin.ImaTransactionListener
-
Called when the transaction is committed.
- onComplete(Object, int, String) - Method in interface com.ibm.ima.plugin.ImaConnectionListener
-
Called when an asynchronous action completes.
- onConfigUpdate(String, Object, Object) - Method in interface com.ibm.ima.plugin.ImaPluginListener
-
Callback for a configuration update.
- onConnected(int, String) - Method in interface com.ibm.ima.plugin.ImaConnectionListener
-
Called when the connection request completes.
- onConnection(ImaConnection, String) - Method in interface com.ibm.ima.plugin.ImaPluginListener
-
Callback for a new connection with a known protocol.
- onCreate(ImaTransaction, int, String) - Method in interface com.ibm.ima.plugin.ImaTransactionListener
-
Called when the transaction is created.
- onData(byte[], int, int) - Method in interface com.ibm.ima.plugin.ImaConnectionListener
-
Called when data is available on a connection.
- onGetMessage(Object, int, ImaMessage) - Method in interface com.ibm.ima.plugin.ImaConnectionListener
-
Called when an asynchronous get retained message action completes.
- onHttpData(String, String, String, String, byte[]) - Method in interface com.ibm.ima.plugin.ImaConnectionListener
-
Called when data is received on an HTTP connection.
- onLivenessCheck() - Method in interface com.ibm.ima.plugin.ImaConnectionListener
-
Called when no data was received on the connection during checkAlive timeout.
- onMessage(ImaSubscription, ImaMessage) - Method in interface com.ibm.ima.plugin.ImaConnectionListener
-
Called when a message from MessageSight is received for a connection.
- onProtocolCheck(ImaConnection, byte[]) - Method in interface com.ibm.ima.plugin.ImaPluginListener
-
Callback when a new connection is detected which might be for this plug-in.
- onRollback(ImaTransaction, int, String) - Method in interface com.ibm.ima.plugin.ImaTransactionListener
-
Called when the transaction is rolled back.
- send(ImaMessage, ImaDestinationType, String, Object) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Send a message to a destination.
- sendData(String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Send text output data on the connection.
- sendData(byte[]) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Send binary output data on the connection as a byte array.
- sendData(byte[], int, int, boolean) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Send output data on the connection
- sendHttpData(int, String, byte[]) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Send HTTP data.
- sendHttpData(int, String, String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Send HTTP data as a String.
- setAllowComments(boolean) - Method in class com.ibm.ima.plugin.util.ImaJson
-
Allow comments.
- setBodyBytes(byte[]) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Set the body as a byte array.
- setBodyMap(Map<String, Object>) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Set the body as a Map.
- setBodyText(String) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Set the body as a String.
- setCommonName(String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Set the common name of the connection.
- setHttpCookie(String, String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Set an HTTP cookie to be returned on the following sendHttpData.
- setHttpHeader(String, String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Set an HTTP header field for the following sendHttpData().
- setIdentity(String, String, String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Set the identity of the connection.
- setIdentity(String, String, String, int, boolean) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Set the identity of the connection and optionally start authenticate.
- setKeepAlive(int) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Sets the keep alive timeout for the connection.
- setMessageType(ImaMessageType) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Set the message type.
- setPersistent(boolean) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Set the persistence of the message.
- setProtocol(String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Set the protocol for an incoming connection.
- setReliability(ImaReliability) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Set the reliability of the message.
- setReliability(ImaReliability) - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Sets the reliability setting of the subscription
- setRetain(boolean) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Set the retain value of the message.
- setUserData(Object) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Sets the user data
- setUserData(Object) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Set a user object associated with this message.
- setUserData(Object) - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Sets the user data
- simpleSubscriptionName() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Create a simple subscription name for non-durable subscriptions.
- startMessaging(boolean) - Method in interface com.ibm.ima.plugin.ImaPluginListener
-
Callback when messaging is started within the server.
- State_Accepted - Static variable in interface com.ibm.ima.plugin.ImaConnection
-
The connection has been accepted but the not authenticated or authorized
- State_Authenticating - Static variable in interface com.ibm.ima.plugin.ImaConnection
-
The connection is in the process of being authenticated and authorized
- State_Closed - Static variable in interface com.ibm.ima.plugin.ImaConnection
-
The connection is closed
- State_Handshake - Static variable in interface com.ibm.ima.plugin.ImaConnection
-
The connection is in protocol handshake
- State_Open - Static variable in interface com.ibm.ima.plugin.ImaConnection
-
The connection ia authorized and can process messages
- subscribe() - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Make the subscription.
- subscribeNoAck() - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Make the subscription without waiting for an ACK.
- suspendMessageDelivery() - Method in interface com.ibm.ima.plugin.ImaConnection
-
- value - Variable in class com.ibm.ima.plugin.util.ImaJson.Entry
-
The value
- valueOf(String) - Static method in enum com.ibm.ima.plugin.ImaDestinationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.ibm.ima.plugin.ImaMessageType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.ibm.ima.plugin.ImaReliability
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.ibm.ima.plugin.ImaSubscriptionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.ibm.ima.plugin.util.ImaJson.JObject
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.ibm.ima.plugin.ImaDestinationType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.ibm.ima.plugin.ImaMessageType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.ibm.ima.plugin.ImaReliability
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.ibm.ima.plugin.ImaSubscriptionType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.ibm.ima.plugin.util.ImaJson.JObject
-
Returns an array containing the constants of this enum type, in
the order they are declared.