- backout() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Backs out the current unit of work.
- Broker - Class in com.softwareag.entirex.aci
-
Represents a session instance of a Broker and
handles the connection to EntireX Broker (TCP/IP or SSL/TLS), Broker SSL Agent, Broker HTTP(S) Agent or Direct RPC in Integration Server (TCP/IP or SSL/TLS).
- Broker(String, String) - Constructor for class com.softwareag.entirex.aci.Broker
-
Creates a Broker object for the specified Broker address and user ID.
- Broker(String, String, int) - Constructor for class com.softwareag.entirex.aci.Broker
-
Creates a Broker object for the specified Broker address, user ID and
socket pool size.
- Broker(String, String, String) - Constructor for class com.softwareag.entirex.aci.Broker
-
Creates a Broker object for the specified Broker address, user ID and
token.
- Broker(String, String, String, int) - Constructor for class com.softwareag.entirex.aci.Broker
-
Creates a Broker object for the specified Broker address, user ID,
token and socket pool size.
- BrokerAttachInfo - Class in com.softwareag.entirex.aci
-
Contains information for attach servers returned by the
receiveAttachInfo() method for an attach server.
- BrokerCommunication - Class in com.softwareag.entirex.aci
-
Abstract superclass for conversational communication and UnitofWork
communication.
- BrokerException - Exception in com.softwareag.entirex.aci
-
Exception class thrown by EntireX Java ACI/RPC classes.
- BrokerMessage - Class in com.softwareag.entirex.aci
-
This class encapsulates a single message, which will be sent to or
received from another participant via the EntireX Broker.
- BrokerMessage() - Constructor for class com.softwareag.entirex.aci.BrokerMessage
-
Creates a Message object with an empty message.
- BrokerMessage(byte[]) - Constructor for class com.softwareag.entirex.aci.BrokerMessage
-
Creates a Message object initialized with the passed byte array.
- BrokerMessage(String) - Constructor for class com.softwareag.entirex.aci.BrokerMessage
-
Creates a BrokerMessage object initialized with the passed String
object.
- BrokerSecurity - Interface in com.softwareag.entirex.aci
-
Interface which defines the interface to EntireX Security.
- brokerService - Variable in class com.softwareag.entirex.aci.BrokerCommunication
-
The BrokerService object to which the Communication belongs.
- BrokerService - Class in com.softwareag.entirex.aci
-
Represents a service that is available through the EntireX Broker and is
used by both clients which want to access a service, and by servers
which register the services they provide.
- BrokerService(Broker, String) - Constructor for class com.softwareag.entirex.aci.BrokerService
-
Creates a new BrokerService object.
- BrokerService(Broker, String, String, String) - Constructor for class com.softwareag.entirex.aci.BrokerService
-
Creates a new BrokerService object.
- cancel() - Method in class com.softwareag.entirex.aci.Conversation
-
Cancels the current conversation.
- cancel() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Cancels the current unit of work.
- cancelallConversations() - Method in class com.softwareag.entirex.aci.BrokerService
-
Cancels all conversations for this service.
- closeConversation() - Method in class com.softwareag.entirex.aci.RPCService
-
Closes the running RPC conversation.
- closeConversation(boolean) - Method in interface com.softwareag.entirex.aci.ServerImplementation
-
Method called by the RPC Server when a conversation RPC ends.
The parameter indicates that the RPC client has closed the conversation
with the option commit.
- closeConversationCommit() - Method in class com.softwareag.entirex.aci.RPCService
-
Closes the running RPC conversation.
- com.softwareag.entirex.aci - package com.softwareag.entirex.aci
-
This package is the Java ACI for the EntireX Broker.
- com.softwareag.entirex.xml.rt - package com.softwareag.entirex.xml.rt
-
- commit() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Commits the current unit of work.
- commitBoth() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Commits the two units of work, one being currently received and one
being currently sent in a single atomic operation.
- commitCancelConversation() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Commits the current unit of work and cancels the associated conversation.
- commitEndConversation() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Commits the current unit of work and ends the associated conversation.
- Conversation - Class in com.softwareag.entirex.aci
-
Represents a conversational communication with a participant.
- Conversation(BrokerService) - Constructor for class com.softwareag.entirex.aci.Conversation
-
Creates a new Conversation object and
attaches it to the specified BrokerService.
- Conversation(BrokerService, ConversationState) - Constructor for class com.softwareag.entirex.aci.Conversation
-
Creates a new Conversation object and
attaches it to the specified BrokerService.
- ConversationState - Class in com.softwareag.entirex.aci
-
Class used to save the state of conversations.
- getApplicationName() - Method in class com.softwareag.entirex.aci.Broker
-
Gets the name of the application.
- getAttemptedDeliveryCount() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Returns how often it was attempted to deliver the unit of work.
- getBroker() - Method in class com.softwareag.entirex.aci.BrokerService
-
Returns the Broker object to which the service belongs.
- getBrokerID() - Method in class com.softwareag.entirex.aci.Broker
-
Returns the Broker ID which was specified in the constructor of this
class.
- getBrokerService() - Method in class com.softwareag.entirex.aci.BrokerCommunication
-
Returns the BrokerService object to which the communication belongs.
- getCharacterEncoding() - Method in class com.softwareag.entirex.aci.BrokerService
-
Gets the character encoding name or null.
- getCharset() - Method in class com.softwareag.entirex.aci.BrokerService
-
Gets the Charset used for this service.
- getClientUID() - Method in class com.softwareag.entirex.aci.BrokerMessage
-
Returns the client's user ID.
- getCommitTimestamp() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Returns the sender's commit timestamp for this unit of work as a Date
object.
- getCommitTimestampString() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Returns the sender's commit timestamp for this unit of work as a
String object.
- getCompressionLevel() - Method in class com.softwareag.entirex.aci.Broker
-
Returns the compression level.
- getConnInfo() - Method in class com.softwareag.entirex.aci.Broker
-
Returns connection information.
- getConversation() - Method in class com.softwareag.entirex.aci.BrokerMessage
-
Returns the corresponding Conversation object.
- getConversation() - Method in class com.softwareag.entirex.aci.RPCService
-
Returns the Conversation object.
- getCorrelationID() - Method in class com.softwareag.entirex.aci.BrokerMessage
-
Returns the correlation ID for this message if available.
The correlation ID is only available if this message is a reply message to a previous request message.
- getCorrelationIDOfReply() - Method in class com.softwareag.entirex.aci.RPCService
-
Gets the messageID of the RPC response.
- getCorrelationIDOfReply() - Method in class com.softwareag.entirex.xml.rt.XMLRPCService
-
- getDefaultWaittime() - Method in class com.softwareag.entirex.aci.BrokerService
-
Returns the default wait time.
- getErrorClass() - Method in exception com.softwareag.entirex.aci.BrokerException
-
Returns the error class part of the Broker error.
- getErrorClass() - Method in exception com.softwareag.entirex.xml.rt.XMLException
-
Returns the error class part of the XML Runtime error.
- getErrorCode() - Method in exception com.softwareag.entirex.aci.BrokerException
-
Returns the error code part of the Broker error.
- getErrorCode() - Method in exception com.softwareag.entirex.xml.rt.XMLException
-
Returns the error code part of the XML Runtime error.
- getErrorDetail() - Method in exception com.softwareag.entirex.aci.BrokerException
-
Gets the error detail text.
- getErrorInfo() - Method in exception com.softwareag.entirex.aci.BrokerException
-
Returns additional information from the Broker call which caused the
error.
- getErrorText() - Method in exception com.softwareag.entirex.xml.rt.XMLException
-
Returns the error text part of the XML Runtime error.
- getLibraryName() - Method in class com.softwareag.entirex.aci.RPCService
-
Returns the current value of the library name used by the RPC.
- getLifetime() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Returns the lifetime value of a unit of work.
- getMaxReceiveLen() - Method in class com.softwareag.entirex.aci.BrokerService
-
Returns the current maximum receive length.
- getMessage() - Method in class com.softwareag.entirex.aci.BrokerMessage
-
Returns the current message as a byte array.
- getMessage() - Method in exception com.softwareag.entirex.xml.rt.XMLException
-
Debugging method to write this exception text and kind onto stdout.
- getMessageID() - Method in class com.softwareag.entirex.aci.BrokerMessage
-
Returns the unique message ID of this message.
This message ID is passed only to a Broker version 10.1 or higher.
- getMessageID() - Method in class com.softwareag.entirex.aci.RPCService
-
Gets the message id for reliable RPC.
- getMessageIDOfRequest() - Method in class com.softwareag.entirex.aci.RPCService
-
Gets the messageID of the RPC request.
- getMessageIDOfRequest() - Method in class com.softwareag.entirex.xml.rt.XMLRPCService
-
- getNaturalLogon() - Method in class com.softwareag.entirex.aci.RPCService
-
Returns the current setting for logon to Natural Security for Natural
RPC servers.
- getNewpassword() - Method in interface com.softwareag.entirex.aci.BrokerSecurity
-
Returns the encrypted Newpassword if it was supplied in the prepareLogon call.
- getPassword() - Method in interface com.softwareag.entirex.aci.BrokerSecurity
-
Returns the encrypted password if it was supplied in the prepareLogon call.
- getProgramName() - Method in class com.softwareag.entirex.aci.RPCService
-
Returns the current value of the RPC subprogram name.
- getReliable() - Method in class com.softwareag.entirex.aci.RPCService
-
Gets the mode for reliable RPC.
- getRPCPassword() - Method in class com.softwareag.entirex.aci.RPCService
-
Gets the RPC password (used with NATURAL logon).
- getRPCUserId() - Method in class com.softwareag.entirex.aci.RPCService
-
Returns the user ID which is used by the RPCs.
- getRPCVersion() - Method in class com.softwareag.entirex.xml.rt.XMLRPCService
-
- getSecurityToken() - Method in class com.softwareag.entirex.aci.Broker
-
Returns the current value of the security token.
- getSecurityToken() - Method in interface com.softwareag.entirex.aci.BrokerSecurity
-
Returns a Security Token.
- getServerClass() - Method in class com.softwareag.entirex.aci.BrokerService
-
Returns the server class.
- getServerName() - Method in class com.softwareag.entirex.aci.BrokerService
-
Returns the server name.
- getService() - Method in class com.softwareag.entirex.aci.BrokerMessage
-
Returns the BrokerService object to which the message belongs.
- getServiceName() - Method in class com.softwareag.entirex.aci.BrokerService
-
Returns the service name.
- getStatus() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Returns the current status of the current unit of work.
- getStatusOfMessage(String) - Method in class com.softwareag.entirex.aci.RPCService
-
Gets the status of the message identified by the message id for
reliable RPC.
- getThreadRunner() - Static method in class com.softwareag.entirex.aci.Broker
-
Gets the ThreadRunner object.
- getTicket() - Method in class com.softwareag.entirex.aci.ConversationState
-
Returns the ticket of this ConversationState object.
- getToken() - Method in class com.softwareag.entirex.aci.Broker
-
Returns the token specified in the constructor of this class.
- getTrace() - Static method in class com.softwareag.entirex.aci.Broker
-
Returns the current trace level.
- getTransportTimeout() - Static method in class com.softwareag.entirex.aci.Broker
-
Gets the socket timeout value in seconds.
- getUniqueID() - Method in class com.softwareag.entirex.aci.Broker
-
Returns a String object, which is unique for this instance of the Broker
object.
- getUnitofWork() - Method in class com.softwareag.entirex.aci.BrokerMessage
-
Returns the corresponding UnitofWork object.
- getUnitofWorkID() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Returns the unique identifier for the current unit of work.
- getUserData() - Method in class com.softwareag.entirex.aci.BrokerCommunication
-
Returns the user data associated with this communication.
- getUserID() - Method in class com.softwareag.entirex.aci.Broker
-
Returns the current value of the user ID.
- getUserStatus() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Returns the user-defined status associated with the current unit of work.
- getVersion() - Static method in class com.softwareag.entirex.aci.Broker
-
Returns version information of the EntireX Java ACI package.
- receive() - Method in class com.softwareag.entirex.aci.BrokerService
-
Receives an incoming request or message.
- receive(String) - Method in class com.softwareag.entirex.aci.BrokerService
-
Receives an incoming request or message.
- receive(String) - Method in class com.softwareag.entirex.aci.Conversation
-
Receives an incoming request and waits the specified time for an answer.
- receive() - Method in class com.softwareag.entirex.aci.Conversation
-
Receives an incoming request and waits for an answer.
- receive(String) - Method in class com.softwareag.entirex.aci.UnitofWork
-
Receives the first or subsequent message of a unit of work.
- receive() - Method in class com.softwareag.entirex.aci.UnitofWork
-
Receives the first or subsequent message of a unit of work.
- receiveAny() - Method in class com.softwareag.entirex.aci.BrokerService
-
Receives an incoming request or message.
- receiveAny(BrokerService, String) - Static method in class com.softwareag.entirex.aci.UnitofWork
-
Receives the first or subsequent message of a unit of work.
- receiveAny(BrokerService) - Static method in class com.softwareag.entirex.aci.UnitofWork
-
Receives the first message or subsequent message of a unit of work.
- receiveAttachInfo() - Method in class com.softwareag.entirex.aci.BrokerService
-
Receives for attach servers a notification about waiting clients.
- receiveLast() - Method in class com.softwareag.entirex.aci.Conversation
-
Re-reads the last message that was received for this conversation.
- receiveOld() - Method in class com.softwareag.entirex.aci.BrokerService
-
Receives an incoming request or message.
- receiveOld(BrokerService, String) - Static method in class com.softwareag.entirex.aci.UnitofWork
-
Receives the first or subsequent message of a unit of work.
- receiveOld(BrokerService) - Static method in class com.softwareag.entirex.aci.UnitofWork
-
Receives the first message or subsequent message of a unit of work.
- receivePreview(String) - Method in class com.softwareag.entirex.aci.Conversation
-
Receives an incoming request in preview mode and waits the specified time
for an answer.
- receivePreview() - Method in class com.softwareag.entirex.aci.Conversation
-
Receives an incoming request in preview mode and waits the default time
for an answer.
- reconnect(String) - Method in class com.softwareag.entirex.aci.Broker
-
Reconnects this Broker object to the Broker address specified in the
constructor and set the user ID.
- reconnect(String, String) - Method in class com.softwareag.entirex.aci.Broker
-
Reconnects this Broker object to the Broker address specified in the
constructor and set user ID and token.
- register() - Method in class com.softwareag.entirex.aci.BrokerService
-
Registers a BrokerService with the EntireX Broker.
- registerAttach() - Method in class com.softwareag.entirex.aci.BrokerService
-
Registers a Broker Attach Server with the EntireX Broker.
- registerXMLRPCServerClass(XMLRPCServerInterface) - Method in class com.softwareag.entirex.xml.rt.XMLRPCServer
-
Register the implementation of XMLRPCServerInterface called
if Java API for XML RPC Server is defined in configuration file.
Method must be called before starting the server.
To use implementation of XMLRPCServerInterface the configuration
file must define
<TargetServer name="xmlrpcServerClass">
- RELIABLE_AUTO_COMMIT - Static variable in class com.softwareag.entirex.aci.RPCService
-
RELIABLE_AUTO_COMMIT = 1
- RELIABLE_CLIENT_COMMIT - Static variable in class com.softwareag.entirex.aci.RPCService
-
RELIABLE_CLIENT_COMMIT = 2
- RELIABLE_OFF - Static variable in class com.softwareag.entirex.aci.RPCService
-
RELIABLE_OFF = 0
- reliableCommit() - Method in class com.softwareag.entirex.aci.RPCService
-
Commit a transaction (unit of work) for reliable RPC.
- reliableRollback() - Method in class com.softwareag.entirex.aci.RPCService
-
Roll back a transaction (unit of work) for reliable RPC.
- replicates - Variable in class com.softwareag.entirex.aci.BrokerAttachInfo
-
Number of registered server replicas.
- reply(BrokerMessage) - Method in class com.softwareag.entirex.aci.BrokerMessage
-
Sends a reply to a previously received message.
- replyError(String, String) - Method in class com.softwareag.entirex.aci.BrokerService
-
Sends a reply with an error code to the Broker.
- restoreFromTicket(String) - Static method in class com.softwareag.entirex.aci.ConversationState
-
Create a ConversationState object from the specifed ticket.
- RPCService - Class in com.softwareag.entirex.aci
-
This abstract subclass of BrokerService represents a Broker service used
by EntireX RPC.
- saveState() - Method in class com.softwareag.entirex.aci.BrokerCommunication
-
Returns a ConversationState object for the current
Conversation object or the current UnitofWork object.
- send(BrokerMessage) - Method in class com.softwareag.entirex.aci.BrokerService
-
Sends an asynchronous non-conversational message.
- send(BrokerMessage) - Method in class com.softwareag.entirex.aci.Conversation
-
Sends an asynchronous conversational message.
- send(BrokerMessage) - Method in class com.softwareag.entirex.aci.UnitofWork
-
Sends an asynchronous message as part of a unit of work.
- sendCommit(BrokerMessage) - Method in class com.softwareag.entirex.aci.UnitofWork
-
Sends an asynchronous message which commits the unit of work.
- sendReceive(BrokerMessage) - Method in class com.softwareag.entirex.aci.BrokerService
-
Sends a synchronous non-conversational message.
- sendReceive(BrokerMessage, String) - Method in class com.softwareag.entirex.aci.BrokerService
-
Sends a synchronous non-conversational message.
- sendReceive(BrokerMessage, String) - Method in class com.softwareag.entirex.aci.Conversation
-
Sends a synchronous conversational message.
- sendReceive(BrokerMessage) - Method in class com.softwareag.entirex.aci.Conversation
-
Sends a synchronous conversational message.
- SERVER_IDENTIFICATION_NAME - Static variable in class com.softwareag.entirex.xml.rt.XMLRPCServer
-
Identification name of XML RPC Server
- serverAddress - Variable in class com.softwareag.entirex.aci.BrokerAttachInfo
-
The server address.
- ServerImplementation - Interface in com.softwareag.entirex.aci
-
This interface may be implemented by server classes which implement the
programs of a library.
- setApplicationName(String) - Method in class com.softwareag.entirex.aci.Broker
-
Sets the name of the application.
- setBroker(Broker) - Method in class com.softwareag.entirex.aci.RPCService
-
Dynamically assigns the instance of a Broker object.
- setCharacterEncoding(String) - Method in class com.softwareag.entirex.aci.BrokerService
-
Sets the character encoding for the payload encoding.
- setCommandLogging(boolean) - Method in class com.softwareag.entirex.aci.Broker
-
Switch command logging on and off.
- setCompressionLevel(int) - Method in class com.softwareag.entirex.aci.Broker
-
Sets the compression level.
- setCompressionLevel(String) - Method in class com.softwareag.entirex.aci.Broker
-
Sets the compression level.
- setConversation(Conversation) - Method in class com.softwareag.entirex.aci.RPCService
-
Enables conversational RPC.
- setDataPersistence(boolean) - Method in class com.softwareag.entirex.aci.UnitofWork
-
Enables or disables data persistence when creating a new unit of work.
- setDefaultWaittime(String) - Method in class com.softwareag.entirex.aci.BrokerService
-
Sets the value of the default wait time field to the argument.
- setLibraryName(String) - Method in class com.softwareag.entirex.aci.RPCService
-
Changes the library name used by the RPC.
- setLifetime(String) - Method in class com.softwareag.entirex.aci.UnitofWork
-
Sets the lifetime value of a unit of work.
- setMaxReceiveLen(int) - Method in class com.softwareag.entirex.aci.BrokerService
-
Sets the current maximum receive length.
- setMessage(byte[]) - Method in class com.softwareag.entirex.aci.BrokerMessage
-
Sets the current message to the passed byte array.
- setMessage(String) - Method in class com.softwareag.entirex.aci.BrokerMessage
-
Sets the current message to the passed string.
- setNaturalLogon(boolean) - Method in class com.softwareag.entirex.aci.RPCService
-
Enables or disables logon to Natural Security for Natural RPC servers.
- setReliable(int) - Method in class com.softwareag.entirex.aci.RPCService
-
Sets reliable RPC mode.
- setRPCPassword(String) - Method in class com.softwareag.entirex.aci.RPCService
-
Changes the password used for an RPC.
- setRPCUserId(String) - Method in class com.softwareag.entirex.aci.RPCService
-
Changes the user ID used for an RPC call.
- setSecurity(BrokerSecurity) - Method in class com.softwareag.entirex.aci.Broker
-
Specifies a security object, enables BrokerSecurity.
- setSecurity(BrokerSecurity, boolean) - Method in class com.softwareag.entirex.aci.Broker
-
Deprecated.
- setSecurity(BrokerSecurity, int) - Method in class com.softwareag.entirex.aci.Broker
-
Deprecated.
- setSecurity(BrokerSecurity, int, boolean) - Method in class com.softwareag.entirex.aci.Broker
-
Deprecated.
- setSecurityToken(byte[]) - Method in class com.softwareag.entirex.aci.Broker
-
Sets the security token to the argument.
- setServerAddress(String) - Method in class com.softwareag.entirex.aci.RPCService
-
Dynamically assigns the server address.
- setStatusPersistence(boolean) - Method in class com.softwareag.entirex.aci.UnitofWork
-
Enables or disables status persistence when creating a new unit of work.
- setStatusPersistence(int) - Method in class com.softwareag.entirex.aci.UnitofWork
-
Enables status persistence when creating a new unit of work and sets the lifetime
of the persistent status.
- setStatusPersistence(String) - Method in class com.softwareag.entirex.aci.UnitofWork
-
Enables status persistence when creating a new unit of work and sets
the lifetime of the persistent status.
- setThreadRunner(ThreadRunner) - Static method in class com.softwareag.entirex.aci.Broker
-
Sets the ThreadRunner object, which wraps the method
to start a new thread.
- setTrace(int) - Static method in class com.softwareag.entirex.aci.Broker
-
Sets the trace level.
- setTrace(int, PrintWriter) - Static method in class com.softwareag.entirex.aci.Broker
-
Sets the trace level.
- setTransportTimeout(int) - Static method in class com.softwareag.entirex.aci.Broker
-
Sets the socket timeout value in seconds.
- setUserData(byte[]) - Method in class com.softwareag.entirex.aci.BrokerCommunication
-
Sets the user data associated with this communication.
- setUserProperty(String, String) - Method in class com.softwareag.entirex.xml.rt.XMLRPCService
-
Sets user-specific properties for this XMLRPCService object.
Defined Values:
PROPERTY_THROW_JAVA_EXCEPTION yes|no
PROPERTY_DEFAULT_FAULTDOC_FORMAT xml|soap
PROPERTY_DEFAULT_XMLSPACE preserve
- setUserStatus(String) - Method in class com.softwareag.entirex.aci.UnitofWork
-
Sets the user-defined status associated with the current unit of work.
- setUserStatusFromException(Exception) - Method in class com.softwareag.entirex.aci.UnitofWork
-
- shutdown() - Method in interface com.softwareag.entirex.aci.ServerImplementation
-
Called on shutdown by the Java RPC server.
- start(String[]) - Method in class com.softwareag.entirex.xml.rt.XMLRPCServer
-
Starts the XML RPC Server with an implementation of XMLRPCServerInterface.
- startThread(Thread) - Method in interface com.softwareag.entirex.aci.ThreadRunner
-
Start a thread.