A B C D E F G H I J L M N O P Q R S T U V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- acknowledge(int) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Acknowledge a received message.
- acknowledge(int, ImaTransaction) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Acknowledge a received message.
- addProperties(Map<String, Object>) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Add to the properties of a message.
- AppID - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The application identifier of the originator - String
- authenticate(int) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Authenticate the connection.
- Authenticated - Static variable in interface com.ibm.ima.plugin.ImaConnection
-
The connection is authenticated and authorized
B
- bytes - com.ibm.ima.plugin.ImaMessageType
-
A message where the body is uninterpreted bytes
C
- clearProperties() - Method in interface com.ibm.ima.plugin.ImaMessage
-
Clear all user message properties.
- ClientID - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The client ID of the originator of the message - String
- close() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Close the connection normally.
- close() - Method in interface com.ibm.ima.plugin.ImaSubscription
-
Close a subscription.
- close(int, String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Close the connection.
- com.ibm.ima.plugin - package com.ibm.ima.plugin
-
Implements a set of interfaces defining the Java plug-in mechanism for IBM MessageSight.
- com.ibm.ima.plugin.util - package com.ibm.ima.plugin.util
-
Provides utilities for use in development of protocol plug-ins.
- commit() - Method in interface com.ibm.ima.plugin.ImaTransaction
-
Commit the transaction.
- ContinueAuthentication - Static variable in interface com.ibm.ima.plugin.ImaConnection
-
Continue authentication check with another module
- COPYRIGHT - Static variable in interface com.ibm.ima.plugin.ImaConnection
- COPYRIGHT - Static variable in interface com.ibm.ima.plugin.ImaConnectionListener
- COPYRIGHT - Static variable in enum com.ibm.ima.plugin.ImaDestinationType
- COPYRIGHT - Static variable in interface com.ibm.ima.plugin.ImaEndpoint
- COPYRIGHT - Static variable in interface com.ibm.ima.plugin.ImaMessage
- COPYRIGHT - Static variable in enum com.ibm.ima.plugin.ImaMessageType
- COPYRIGHT - Static variable in interface com.ibm.ima.plugin.ImaPlugin
- COPYRIGHT - Static variable in interface com.ibm.ima.plugin.ImaPluginConfigValidator
- COPYRIGHT - Static variable in exception com.ibm.ima.plugin.ImaPluginException
- COPYRIGHT - Static variable in interface com.ibm.ima.plugin.ImaPluginListener
- COPYRIGHT - Static variable in class com.ibm.ima.plugin.ImaPropertyID
- COPYRIGHT - Static variable in enum com.ibm.ima.plugin.ImaReliability
- COPYRIGHT - Static variable in class com.ibm.ima.plugin.ImaReturnCode
- COPYRIGHT - Static variable in interface com.ibm.ima.plugin.ImaSubscription
- COPYRIGHT - Static variable in enum com.ibm.ima.plugin.ImaSubscriptionType
- COPYRIGHT - Static variable in interface com.ibm.ima.plugin.ImaTransaction
- COPYRIGHT - Static variable in interface com.ibm.ima.plugin.ImaTransactionListener
- COPYRIGHT - Static variable in class com.ibm.ima.plugin.util.ImaBase64
- COPYRIGHT - Static variable in class com.ibm.ima.plugin.util.ImaJson
- CorrID - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The correlation ID - String
- count - Variable in class com.ibm.ima.plugin.util.ImaJson.Entry
-
The count of items in an array, or the value of an integer entry
- createConnection(String, String) - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Create an internal virtual connection.
- createMessage(ImaMessageType) - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Create a message.
- createTransaction(ImaTransactionListener) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Create a transaction
D
- deleteRetained(String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Delete the retained message (if any) from a topic.
- deleteRetained(String, Object) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Delete the retained message (if any) from a topic.
- DeliveryTime - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
To time before which the message should not be delivered - long as milliseconds since 1970-01-01T00Z
- destroySubscription(Object, String, ImaSubscriptionType) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Destroy a subscription.
- DeviceID - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The device identifier of the originator - String
- Domain - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The domain of the client ID.
- Durable - com.ibm.ima.plugin.ImaSubscriptionType
-
Durable
E
- Entry() - Constructor for class com.ibm.ima.plugin.util.ImaJson.Entry
- escape(StringBuffer, String) - Static method in class com.ibm.ima.plugin.util.ImaJson
-
Copy a string to an output JSON buffer with escapes.
- Expire - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The expiration timestamp of the message - long as milliseconds since 1970-01-01T00Z
F
- fromBase64(String) - Static method in class com.ibm.ima.plugin.util.ImaBase64
-
Convert from a base64 string to a byte array.
- fromMap(Map<String, Object>) - Static method in class com.ibm.ima.plugin.util.ImaJson
-
Create JSON object from a Map.
G
- getAddress() - Method in interface com.ibm.ima.plugin.ImaEndpoint
-
Returns the IP address of the interface where the endpoint accepts connections.
- getAuthor() - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Get the author field of the plug-in.
- 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.
- getBuild() - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Get the build field of the plug-in.
- 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
-
Get the connection associated with a transaction.
- getConnectionListener() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Returns the connection listener associated with this connection.
- getCopyright() - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Get the copyright field of the plug-in.
- getDescription() - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Get the description field of the plug-in.
- 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.
- getEntry(int) - Method in class com.ibm.ima.plugin.util.ImaJson
- 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.
- getLicense() - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Get the license field of the plug-in.
- 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.
- getTitle() - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Get the title field of the plug-in.
- getTransactionListener() - Method in interface com.ibm.ima.plugin.ImaTransaction
-
Get the transaction listerner associated with a transaction.
- 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 associated with the connection.
- 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.
- getVersion() - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Get the version field of the plug-in.
- 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
H
- HTTP_Option_Close - Static variable in interface com.ibm.ima.plugin.ImaConnection
-
Close the connection after sending the response.
- HTTP_Option_ReadMsg - Static variable in interface com.ibm.ima.plugin.ImaConnection
-
Increment the ReadMsg statistic for the connection and endpoint.
- HTTP_Option_WriteMsg - Static variable in interface com.ibm.ima.plugin.ImaConnection
-
Increment the WriteMsg stats for the connection and endpoint.
I
- 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.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.
- ImaPluginConfigValidator - Interface in com.ibm.ima.plugin
-
A plug-in custom properties validator.
- ImaPluginException - Exception in com.ibm.ima.plugin
-
The ImaPluginExecption is used to indicate an error when processing a synchronous request.
- ImaPluginException(String, String) - Constructor for exception com.ibm.ima.plugin.ImaPluginException
-
Create a plug-in runtime exception without a cause.
- ImaPluginException(String, String, Throwable) - Constructor for exception com.ibm.ima.plugin.ImaPluginException
-
Create a plug-in runtime exception with 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
- IMARC_AllocateError - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
Unable to allocate memory
- IMARC_ArgNotValid - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
An argument not valid: name={0}
- IMARC_BadClientData - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The data from the client is not valid
- IMARC_BadClientID - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The ClientID is not valid
- IMARC_BadHTTP - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
HTTP handshake failed
- IMARC_BadPropertyName - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The property name is not valid: property={0}
- IMARC_BadPropertyValue - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
A property value is not valid: property={0} value={1}
- IMARC_BadSysTopic - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The topic is a system topic
- IMARC_CertificateNotValid - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
Certificate not valid
- IMARC_ChangedAuthentication - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The HTTP authentication cannot be changed within a connection
- IMARC_ClientIDConnected - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The client ID is in use by an active connection
- IMARC_ClientIDInUse - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The client ID is already in use
- IMARC_ClientIDNotValid - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The client ID is not valid: {0}
- IMARC_ClientIDRequired - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The client ID is required
- IMARC_Closed - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The object is closed
- IMARC_ClosedByClient - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The connection was closed by the client
- IMARC_ClosedByServer - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The connection was closed by the server
- IMARC_ClosedOnSend - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The connection was closed during a send
- IMARC_ClosedTLSHandshake - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
Closed during TLS handshake
- IMARC_ConnectNotAuthorized - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
Connection is not authorized
- IMARC_ConnectTimedOut - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The connection timed out
- IMARC_DestinationFull - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The destination is full
- IMARC_DestinationInUse - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The destination is in use
- IMARC_DestNotValid - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The destination name is not valid
- IMARC_Destroyed - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The object is already destroyed
- IMARC_EndpointDisabled - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The connection was closed by an administrator
- IMARC_Error - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
System error
- IMARC_ExistingSubscription - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The subscription name being requested already exists
- IMARC_FirstPacketTooBig - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The initial packet is too large
- IMARC_HTTP_BadRequest - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The HTTP request is not valid
- IMARC_HTTP_NotAuthorized - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The HTTP request is not authorized
- IMARC_HTTP_NotFound - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The HTTP request is for an object which does not exist
- IMARC_InvalidParameter - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
An invalid parameter was supplied
- IMARC_LockNotGranted - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The lock could not be acquired
- IMARC_MessageNotValid - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The message is not valid
- IMARC_MessagingNotAvailable - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
Messaging is not available
- IMARC_MsgTooBig - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The message size is too large for this endpoint.
- IMARC_NameNotValid - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The subscription name is not valid
- IMARC_NoCertificate - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
Certificate missing
- IMARC_NoFirstPacket - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
No data was received on a connection
- IMARC_NoPingResponse - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The client did not respond to a ping
- IMARC_NoSubscriptions - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
There are no subscriptions
- IMARC_NotAuthenticated - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
User authentication failed
- IMARC_NotAuthorized - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The operation is not authorized
- IMARC_NotFound - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The requested item is not found
- IMARC_NotImplemented - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The function is not implemented
- IMARC_NullArgument - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
A null argument is not allowed
- IMARC_NullPointer - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
A null object is not allowed
- IMARC_ObjectNotValid - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The messaging object is not valid
- IMARC_OK - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
Success
- IMARC_PingFailed - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
Failed to ping client
- IMARC_PropertiesNotValid - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The properties are not valid
- IMARC_RolledBack - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The transaction was rolled back
- IMARC_SendNotAllowed - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The sending of messages to this destination is not allowed
- IMARC_ServerCapacity - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The server capacity is reached
- IMARC_ServerNotAvailable - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
Server not available
- IMARC_ServerTerminating - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The connection was closed because the server was shutdown
- IMARC_ShareMismatch - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The consumer must have a matching share with the existing subscription
- IMARC_TimeOut - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The receive timed out
- IMARC_TransactionInUse - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The transaction is associated with another session
- IMARC_UnicodeNotValid - Static variable in class com.ibm.ima.plugin.ImaReturnCode
-
The Unicode value is not valid
- ImaReliability - Enum in com.ibm.ima.plugin
-
Define the reliability or quality of service of the message.
- ImaReturnCode - Class in com.ibm.ima.plugin
-
Define a subset of the IBM MessgeSight server return codes which might be visible to the plug-in.
- ImaReturnCode() - Constructor for class com.ibm.ima.plugin.ImaReturnCode
- 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
-
Check if the transaction is fully created.
J
- jmsBytesMessage - com.ibm.ima.plugin.ImaMessageType
-
A JMS BytesMessage
- jmsMapMessage - com.ibm.ima.plugin.ImaMessageType
-
A JMS MapMessage
- jmsMessage - com.ibm.ima.plugin.ImaMessageType
-
A JMS message with no body
- jmsObjectMessage - com.ibm.ima.plugin.ImaMessageType
-
A JMS ObjectMessage
- jmsStreamMessage - com.ibm.ima.plugin.ImaMessageType
-
A JMS StreamMessage
- jmsTextMessage - com.ibm.ima.plugin.ImaMessageType
-
A JMS TextMessage
- JMSType - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The type string - String
- jsonArray - com.ibm.ima.plugin.ImaMessageType
-
A message where the body is a JSON array
- JsonArray - com.ibm.ima.plugin.util.ImaJson.JObject
-
JSON array, count is number of entries
- JsonFalse - com.ibm.ima.plugin.util.ImaJson.JObject
-
JSON false, value is not set
- JsonInteger - com.ibm.ima.plugin.util.ImaJson.JObject
-
A number with no decimal point.
- JsonNull - com.ibm.ima.plugin.util.ImaJson.JObject
-
JSON null, value is not set
- JsonNumber - com.ibm.ima.plugin.util.ImaJson.JObject
-
Number which is too big or has a fractional part
- jsonObject - com.ibm.ima.plugin.ImaMessageType
-
A message where the body is a JSON object
- JsonObject - com.ibm.ima.plugin.util.ImaJson.JObject
-
JSON object, count is number of entries
- JsonString - com.ibm.ima.plugin.util.ImaJson.JObject
-
JSON string, value is UTF-8
- JsonTrue - com.ibm.ima.plugin.util.ImaJson.JObject
-
JSON true, value is not set
L
- level - Variable in class com.ibm.ima.plugin.util.ImaJson.Entry
-
The level in the document tree
- line - Variable in class com.ibm.ima.plugin.util.ImaJson.Entry
-
The line number from the start of the source (first line = 1)
- log(String, int, String, String, Object...) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Put an entry into the log.
- log(String, int, String, String, Object...) - Method in interface com.ibm.ima.plugin.ImaPlugin
- LOG_CRIT - Static variable in interface com.ibm.ima.plugin.ImaPlugin
-
The log entry is critical
- LOG_ERROR - Static variable in interface com.ibm.ima.plugin.ImaPlugin
-
The log entry represents an error
- LOG_INFO - Static variable in interface com.ibm.ima.plugin.ImaPlugin
-
The log entry is informational
- LOG_NOTICE - Static variable in interface com.ibm.ima.plugin.ImaPlugin
-
The log entry is important but is not an error
- LOG_WARN - Static variable in interface com.ibm.ima.plugin.ImaPlugin
-
The log entry represents a warning
M
- MsgID - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The message ID (commonly system generated) - String
N
- name - Variable in class com.ibm.ima.plugin.util.ImaJson.Entry
-
The name of the entry.
- newSubscription(ImaDestinationType, String, String, ImaSubscriptionType, boolean, boolean) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Create a new subscription object.
- newSubscription(String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Create a new simple subscription object.
- NonDurable - com.ibm.ima.plugin.ImaSubscriptionType
-
Non durable
- NotAuthenticated - Static variable in interface com.ibm.ima.plugin.ImaConnection
-
The connection is not authorized and will be terminated
- nullRetained - com.ibm.ima.plugin.ImaMessageType
-
A null retained message which will cause the retained message to be deleted
O
- 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.
P
- parse(File) - Method in class com.ibm.ima.plugin.util.ImaJson
- parse(String) - Method in class com.ibm.ima.plugin.util.ImaJson
-
Parse a JSON message.
- propertyExists(String) - Method in interface com.ibm.ima.plugin.ImaMessage
-
Return whether a property exists.
- Protocol - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The protocol which originated the message - String
- publish(ImaMessage, String, Object) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Publish a message to a topic.
- put(StringBuffer, Object) - Static method in class com.ibm.ima.plugin.util.ImaJson
-
Put out a Java object in JSON form.
- putString(StringBuffer, String) - Static method in class com.ibm.ima.plugin.util.ImaJson
-
Put out a set of bytes with JSON string escapes.
Q
- qos0 - com.ibm.ima.plugin.ImaReliability
-
The message might not be delivered and is not re-delivered (at most once)
- qos1 - com.ibm.ima.plugin.ImaReliability
-
The message is re-delivered in case of an error or connection restart (at least once)
- qos2 - com.ibm.ima.plugin.ImaReliability
-
The message is reliably delivered without duplicates (exactly once)
- queue - com.ibm.ima.plugin.ImaDestinationType
-
The destination is a queue
- Queue - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The queue name (this is needed if the protocol allows wildcard queues) - String
R
- ReplyToQ - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The reply to queue - String destination name
- ReplyToT - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The reply to topic - String destination name
- requiredData(int) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Specify the data required before the next onData call.
- resumeMessageDelivery() - Method in interface com.ibm.ima.plugin.ImaConnection
-
Resume message deliver.
- rollback() - Method in interface com.ibm.ima.plugin.ImaTransaction
-
Rollback the transaction.
S
- send(ImaMessage, ImaDestinationType, String, Object) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Send a message to a destination.
- 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
- sendData(String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Send text output data on the connection.
- sendHttpData(int, int, String, byte[]) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Send HTTP data with options.
- sendHttpData(int, int, String, String) - Method in interface com.ibm.ima.plugin.ImaConnection
-
Send HTTP data as a string with options.
- 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.
- 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 associated with the connection.
- 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
-
Temporarily suspend message deliver.
T
- terminate(int) - Method in interface com.ibm.ima.plugin.ImaPluginListener
-
Callback to inform the plug-in it should release resources.
- text - com.ibm.ima.plugin.ImaMessageType
-
A message where the body is text in UTF-8 encoding
- Timestamp - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The creation timestamp of the message - long as milliseconds since 1970-01-01T00Z
- toArray(int) - Method in class com.ibm.ima.plugin.util.ImaJson
-
Return a string array from a parsed JSON array.
- toBase64(byte[]) - Static method in class com.ibm.ima.plugin.util.ImaBase64
-
Convert a byte array to a base64 string.
- Token - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
A security token authenticating this message
- toMap(int) - Method in class com.ibm.ima.plugin.util.ImaJson
-
Make a Java map object from a JSON object.
- topic - com.ibm.ima.plugin.ImaDestinationType
-
The destination is a topic
- Topic - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The topic name (this is needed if the protocol allows wildcard topics) - String
- toString() - Method in exception com.ibm.ima.plugin.ImaPluginException
-
Get a string version of the exception including the error code.
- toString() - Method in class com.ibm.ima.plugin.util.ImaJson
- trace(int, String) - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Trace with a level specified.
- trace(String) - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Trace unconditionally.
- traceException(int, Throwable) - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Write an exception stack trace to the trace file at a specified level.
- traceException(Throwable) - Method in interface com.ibm.ima.plugin.ImaPlugin
-
Unconditionally write an exception stack trace to the trace file.
U
- useClientCert() - Method in interface com.ibm.ima.plugin.ImaEndpoint
-
Returns whether client certificates are used.
- usePassword() - Method in interface com.ibm.ima.plugin.ImaEndpoint
-
Returns whether the authorization requires passwords.
- UserID - Static variable in class com.ibm.ima.plugin.ImaPropertyID
-
The user ID of the originator of the message - String
V
- validate(ImaPlugin) - Method in interface com.ibm.ima.plugin.ImaPluginConfigValidator
-
Method to validate custom plug-in configuration
- 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.
All Classes All Packages