Package com.cafesoft.core.message

Contains core classes of the Cafesoft Messaging Framework

See:
Description

Interface Summary

Connection	A client's active network connection to its Message Service Provider.
ConnectionAccessController	An access control object that checks access for the Message Framework's Connection Object
ConnectionAuthenticator	Defines an API that allows for a pluggable authentication mechanism for authenticating connections for usage
ConnectionEventListener	Defines the interface for classes that handle ConnectionEvents.
ConnectionExceptionListener	Defines a method to handle ConnectionExceptions that are thrown by the Connection object.
ConnectionFactory	Defines the interface for message framework classes that create client-side Connections used to transport messages.
ConnectionMetaData	A container object which contains meta-data about the Message Framework's Connection Object
Connector	Listens to a ServerSocket and creates Connection objects to handle incoming Socket connections.
EndPoint	Represents the origination of a Message or the final destination of a Message.
EndPointManager	Provides useful methods to EndPoint objects, for example - to open or close an EndPoint and associated resources.
MessageDecoder	Decodes messages sent through the Messaging Framework.
MessageEncoder	Responsible for encoding messages sent through the messaging framework.
MessageQueue	A queue that specifically handles Message objects.
MessageReceiver	Used by clients to process messages received from a MessageSender via the Message Service Provider.
MessageSender	A client uses a MessageSender object to send messages to a Message Service.
MessageService	Defines the interface for a class that handles incoming Messages.
MessageServiceProvider	Defines the interface for the core class that provides most of the resources needed by the messaging framework.
MessageServiceRegistry	Defines the interface for classes that associate a content type with a MessageReceiver for handling Messages of that content type.
MessageSocket	Container for a MessageReceiver and MessageSender pair.
MessageTranslator	Provides methods for encoding and decoding a Message, and for registering objects that respond to events triggered by encoding or decoding.
MessageTranslatorListener	Listens for Message translation events.
PacketConsumer	Defines an object who is responsible for consuming Packet objects.
PacketProducer	Defines an object who is responsible for producing Packet objects to be processed.
PacketQueue	Responsible for queueing Packets for processing.
ProtocolHandler	Key component used within the scope of a single CMS Connection.
ServerSocketFactory	The ServerSocketFactory interface must be implemented by a factory object that creates ServerSocket instances.
SocketFactory	Creates Socket instances.

Class Summary

AccessStatus	The AccessStatus object is the response object returned from the AccessController object when an access to a connection is attempted.
AuthStatus	The AuthStatus object is the response object returned from the Authenticator object when an authentication attempt is made.
ConnectionEvent	Used to notify ConnectionListeners that a connection has been started or stopped.
ConnectionEventType	A typesafe constant object that represents various Connection events
ConnectionStatus	The ConnectionStatus object is a collection of ConnectionStatus objects that are used to convey the status of the Connection object they represent.
ConnectionSupport	KRJ - doc
Constants	Constants contains message system-wide static values.
DefaultConnector	Listens to a ServerSocket and creates Connection objects to handle incoming Socket connections.
DefaultMessageTranslator	Implements the MessageTranslator interface for encoding and decoding messages.
DefaultServerSocketFactory	Implements a factory for creating ServerSocket instances.
DefaultSocketFactory	DefaultSocketFactory implements a singleton factory for creating Socket instances.
EndPointRegistration	Encapsulates information about a remote EndPoint like a MessageReceiver, MessageSender, MessageService, etc.
EndPointRegistrationBody	EndPointRegistrationBody is the body of a EndPoint Registration Protocol Message, which registers a local MessageSender or MessageReceiver with a remote Connection.
EndPointRegistrationMessageService	Registers remote MessageSender and MessageReceivers with the local MessageServiceProvider.
EndPointRegistrationMessageTranslator	Encodes and decodes EndPointRegistration messages.
EndPointRegistry	Manages the registration of remote EndPoints.
Message	Message implements a basic Message Service provider message, which includes two parts: a message header and a message body.
MessageDecoderObjectPool	An ObjectPool of MessageDecoder Objects
MessageDecoderPoolableObjectFactory	KRJ - doc
MessageEncoderObjectPool	An ObjectPool of MessageEncoder Objects
MessageEncoderPoolableObjectFactory	KRJ - doc
MessageEncoderRunnable	Defines a Runnable object that specifically is responsible for Encoding messages to be sent through the Messaging Framework.
MessageHeader	MessageHeader represents the metadata of a Message transported within a Message Service provider.
MessageInputStream	The MessageInputStream stream object extends the abstract InputStream.
MessageObjectPool	An ObjectPool of Message Objects
MessageOutputStream	The MessageOutputStream stream object extends the abstract class OutputStream.
MessagePoolableObjectFactory
MessageServer	Implements a standalone CMS Message Server.
MessageSocketObjectPool	Maintains a pool of MessageSocket objects.
MessageSocketPoolableObjectFactory	KRJ - doc
MessageTranslatorEvent	MessageTranslatorEvent
MessageTranslatorRegistry	Registers MessageTranslator objects that are responsible for encoding and decoding Message content.
MessageTranslatorSupport	MessageTranslatorSupport
Packet	Collection of data containing all or part of a Message and metadata used to process it.
PacketObjectPool	An ObjectPool of Packet Objects
PacketPoolableObjectFactory	An object that creates, validates, and destroys Packet Objects for the PacketObjectPool
RemoteEndPoint	RemoteEndPoint represents a reference to an EndPoint on a remote host.
SslServerSocketFactory	SslServerSocketFactory implements a configureable factory for creating ServerSocket instances supporting SSL.
SslSocketFactory	SslSocketFactory implements a singleton factory for creating SSL Socket instances.
StandardConnection	Implementation of the Connection interface that reads incoming Message Packets from a Socket's InputStream and writes outgoing Message Packets to a Socket's OutputStream.
StandardConnectionAccessController	Standard implementation of the ConnectionAccessController interface that always allows access to the Connection
StandardConnectionAuthenticator	Standard implementation of the ConnectionAuthenticator interface that always allows authenticates the Connection
StandardConnectionFactory	Creates Connection instances for a client that will connect with a message server and for a server accepting connections from a client.
StandardConnectionMetaData	The Standard implementation of the ConnectionMetaData interface
StandardMessageDecoder	Standard implementation of the MessageDecoder interface.
StandardMessageEncoder	The StandardMessageEncoder object is a standard/default implementation of the MessageEncoder interface.
StandardMessageQueue	Standard implementation of the MessageQueue interface.
StandardMessageReceiver	StandardMessageReceiver enables a client to receive messages from a corresponding MessageSender.
StandardMessageSender	A client uses a MessageSender object to send messages to a Message Service.
StandardMessageServiceProvider	Provides most of the resources needed by the messaging framework.
StandardMessageServiceRegistry	StandardMessageServiceRegistry associates a content type with a MessageReceiver for handling Messages for that content type.
StandardMessageSocket	KRJ - doc
StandardPacketQueue	Vector based implementation of the PacketQueue interface.
StandardProtocolHandler	StandardProtocolHandler is a key component used within the scope of a single CMS Connection.
Value	The class Value is a data container class that is responsible for containing the obtained results from reading from a MessageInputStream.
ValueObjectPool	An ObjectPool of Value Objects
ValuePoolableObjectFactory

Exception Summary

ConnectionAccessException	Thrown when there are errors that occur trying to check access to a connection.
ConnectionAuthenticationException	Thrown when there are errors that occur trying to authenticate a connection.
ConnectionException	Thrown when an error occurs on the connection.
IllegalConnectionStateException	Thrown when a method is called on a Connection object that is not in the proper state to carry out the method.
MessageDecoderException	An exception thrown for any MessageDecoder errors
MessageEncoderException	An exception thrown for any MessageEncoder errors
MessageServiceException	Represents an exceptional condition that notifies message framework participants of errors.
MessageSocketException	Represents an exceptional condition that notifies message framework participants of errors.
MessageTranslatorException	MessageTranslatorException
PacketException
ProtocolException	ProtocolException represents an error condition experienced during message protocol handling.
SocketFactoryException	Represents an exceptional condition that occurs within a message framework SocketFactory.

Package com.cafesoft.core.message Description

Contains core classes of the Cafesoft Messaging Framework