ABLE 2.0.0 07/02/2003 10:25:01

Package com.ibm.able.conversation

The com.ibm.able.conversation contains classes for conversation management in ABLE.

See:
          Description

Interface Summary
ConversationPolicyHandler This is the ultimate basis for all conversation policy execution modules.
MessageForm Classes that implement this interface are used to assemble and disassemble TransportMessages, converting them to & from strongly-typed objects (the "constituent data") which are defined by the particular MessageForm class itself.
StateMachineInterface Description of a state machine, suitable for CPGraphLoader/Viewer.
 

Class Summary
AbleConversation The AbleConversation class executes one side of a single conversation, managing all ConversationPolicyHandlers, etc., as needed.
AbleConversationGraphicView This class defines a specialized AbleConversationManager bean inspector that shows all active conversations that the bvean is managing, in the form of trees, with nodes representing conversations and child conversations
AbleConversationManager The AbleConversationManager class is an AbleBean implementing of the ConversationManager interface.
AbleConversationManagerBeanInfo This class provides BeanInfo for the AbleConversationManager class.
AbleConversationManagerCustomizer This class provides the customizer for the AbleConversationManager bean.
AbleConversationManagerCustomizerPanel This class provides the graphical editor panel for the AbleConversationManager to specify the default conversation policy and the repository for finding other conversation policies.
AbleConversationPolicyHandlerFactory The AbleConversationPolicyHandlerFactory class is an ABLE-specific implementation of the ConversationPolicyHandlerFactory interface.
AbleCpGraphLoader This takes a CpStateMachine and constructs an equivalent com.ibm.graph.Net object.
AbleCpGraphViewer This provides graphical display of a CpStateMachine.
AbleCpStateMachineHandler The AbleCpStateMachineHandler class is an ABLE-specific implementation of the CpStateMachineHandler interface.
AbleJasConversationAgent The AbleJasConversationAgent class represents a simple conversational agent that can execute conversations as specified by Conversation Policies (CPs) encoded in the XML dialect cpXML.
AbleJasConversationAgentBeanInfo This class provides BeanInfo for the AbleJasConversationAgent class.
AbleJasConversationAgentCustomizer OLD VERSION -- TO BE WITHDRAWN
AbleJasConversationDecisionPanel This class provides the graphical editor panel for the AbleJasConversationAgent decision logic connections.
AbleJasConversationGraphicView This class defines a specialized Able Jas Conversation Agent inspector that shows all active conversations that the agent is engaged in, in the form of trees, with nodes representing conversations and child conversations
AbleJasConversationPanel This class provides the graphical editor panel for the AbleJasConversationAgent to specify the default conversation policy and the repository for finding other conversation policies.
AbleJasMessageSystemAdapter The AbleJasMessageSystemAdapter class is a MessageSystemAdapter that uses Java Agent Services (JAS) messaging.
AbleMessageTransformFactory The AbleMessageTransformFactory is an ABLE-specific implementation of the MessageTransform factory interface.
AblePlatformConversationAgent The AblePlatformConversationAgent class represents an agent that supports conversations atop the Java Agent Services (JAS) platform.
AblePlatformConversationAgentBeanInfo This class provides BeanInfo for the AbleJasConversationAgent2 class.
AblePlatformConversationAgentCustomizer This class provides the customizer for the Able Jas Conversation Agent.
AbleRemoteUdfDecisionLogicAdapter The AbleRemoteUdfDecisionLogicAdapter uses ABLE's user-defined functions (UDFs)--cf.
AbstractCPH Helper class that is an abstract, partial implementation of the ConversationPolicyHandler interface.
AutoConversationSetup This bean handles setting up conversations based on the setup_cp.xml and metaconversation_cp.xml provided with the ABLE distribution in examples/datafiles.
AutoConversationSetupAgentPanel This class provides the graphical editor panel for the AutoConversationSetup bean to be used in specifying the valid agent names to accept conversation requests from
AutoConversationSetupBeanInfo This class provides BeanInfo for the AutoConversationSetup class.
AutoConversationSetupCustomizer This class provides the customizer for the AutoConversationSetup Bean Adds an AutoConversationSetupRolePanel and AutoConversationSetupAgentPanel to the customizer panels provided by AbleObjectCustomizer
AutoConversationSetupRolePanel This class provides the graphical editor panel for the AutoConversationSetup bean to be used in specifying the valid policy names and roles that the agent can assume during conversations
ContextEvent This is an event output from a CPH, that tells the conv mgr to change either the owner agent's conversation-context data ("self"), or that of the other agent in the conversation ("counterpart").
ConversationContext This is a storage area for contextual information relevant to a conversation: conversation IDs, participant names & locators, whether conversation is in-progress, done, or derailed by a protocol error, etc.
ConversationEvent As-yet-trivial subclass of EventObject; useful only for type-checking.
ConversationEventSequence This is a sequence of events, used for CPH processing outputs and for batch-mode CPH inputs.
ConversationParser Parses a CP-XML file and extracts the following information and stores them internally
ConversationSetupForm This is a MessageForm for messages that contain data for setting up a conversation: i.e., the name, locator, and conversationID of a participant.
CPDoneEvent This is a ConversationEvent returned by a CPH when its CP reaches a terminal state.
CPGraphLoader This reads CP data from a statemachine description and then constructs a graph from what it's read.
CPGraphViewer This provides graphical display of a conversation policy, including a popup window showing details of selected states & transitions.
DecisionEvent DecisionEvents are used to indicate either the need for a decision (a "decision request") or a decision istelf.
DecisionLogicAdapter This class is meant to be an abstraction of the things to be performed by a piece of code that glues the Able Jas Conversation Agent to an able bean that computes a decision based on the curent state and the input to the state.
DecisionPanel Class that serves as an interface to the user for helping the decision making process during a conversation.
DefaultDecisionMaker This class represents a decision logic object that be attached to an ABLE JAS conversation agent to act as a decision logic during the execution of any conversation.
DefaultDecisionMakerBeanInfo This class provides BeanInfo for the DefaultDecisionMaker class.
FilterByExtension The FilterByExtension class accepts files with extensions that match a given string.
InterfacePanelFactory This class represents a factory of MessageFormInterfacePanels.
JasConversationMetaData The AbleJasConversationMetaData class is an ABLE-compatible implementation of the JasConversationMetaData interface.
JasConversationSetupTransform The JasConversationSetupTransform class deals with messages that contain data for setting up a conversation over Java Agent Services (JAS) messaging.
JasMessageTransform The JasMessageTransform class is the common base class for MessageTransforms that form & parse Java Agent Services (JAS) messages.
JasStringLiteralTransform Forms & parses a JAS messaging containing a string-literal.
LoadCPEvent This is a ConversationEvent indicating that it's time to start a new CP.
MessageEvent Event for use with both inbound and outbound messages.
MessageFormFactory This is a factory of MessageForm instances.
MessageFormInterfacePanel An abstract class that defines the basic form to provide a user-interface ' JPanel' to accept data for constructing a message form.
ProtocolErrorEvent ConversationEvent for protocol errors (e.g., unexpected message).
SimpleConversationManager This is a conversation manager implemented as an AbleBean.
SimpleCPH An implementation of the ConversationPolicyHandler interface that uses a state machine to execute a conversation
StartCPForm This class represents the message-form used during the MetaConversation CP to negotiate regarding policies to use and roles to assume in a new conversation.
StartCPFormPanel Defines the user-interface panel for the StartCPForm
State Class representing a state in a conversation as defined by a Conversation Policy.
StateMachine Represents a state-machine view of a conversation.
TextMessageForm This is a MessageForm for messages with two String-valued elements, "name" and "text".
TextMessageFormPanel This class represents the user-interface to be used to construct a TextMessageForm object
TimerEvent This is a ConversationEvent used to set a timer or to notify the recipient that a timer has expired.
Transition Class that represents a transition during a conversation from one state to another.
 

Exception Summary
MessageFormException Exceptio in MessageForm processing.
 

Package com.ibm.able.conversation Description

The com.ibm.able.conversation contains classes for conversation management in ABLE.

The overall architecture is defined by the conversation management interfaces in com.ibm.conversation. In this package, there are general-purpose classes for use in all ABLE agents that have conversations, as well as certain special-purpose classes that are appropriate to conversational agents that use certain messaging systems.

The general-purpose classes include, most importantly, AbleConversation, as well as AbleConversationManager, AbleConversationPolicyHandlerFactory, AbleCpStateMachineHandler, and AbleMessageTransformFactory. Besides these, class FilterByExtension is a small utility used by the AbleConversationPolicyHandlerFactory, and AbleRemoteUdfDecisionLogicAdapter is an implementation of DecisionLogicAdapter that accesses the agent's decision logic by means of AbleUserDefinedFunction objects.

The specialized classes enable an ABLE agent's conversation management system to work with the messaging system the agent is using (e.g., Java Agent Services, Web Services, etc.) Typically, these classes include a specialized implementation ConversationMetaData and a number of MessageTransform classes to carry out conversions between the message objects appropriate for that messaging system, on the one hand, and the decision-data objects appropriate for the agent's decision logic, on the other.


ABLE 2.0.0 07/02/2003 10:25:01

(C) Copyright IBM Corporation 1999, 2003