EclipseLink 1.1.1_ 1.1.1.v20090430-r4097 API Reference

org.eclipse.persistence.sessions.coordination
Interface CommandConverter


public interface CommandConverter

Purpose: Define a pluggable conversion interface that can be supplied by the application

Description: The implementation class of this interface should be set on the remote command manager through the setCommandConverter() method. The implementation class will get invoked, through its convertToTopLinkCommand(), to convert the application command format into a TopLink Command object that can be propagated throughout the cluster. Similarly, convertToUserCommand() will be invoked on the implementation class to give the application an opportunity to convert the TopLink Command object into an object that is suitable for being processed by the application.

See Also:
Command, CommandManager
Author:
Steven Vo
Since:
OracleAS TopLink 10g (9.0.4)

Method Summary
 Command convertToTopLinkCommand(java.lang.Object command)
          PUBLIC: Convert a command from its application-specific format to a TopLink Command object.
 java.lang.Object convertToUserCommand(Command command)
          PUBLIC: Convert a TopLink Command object into its application-specific format to a
 

Method Detail

convertToTopLinkCommand

Command convertToTopLinkCommand(java.lang.Object command)
PUBLIC: Convert a command from its application-specific format to a TopLink Command object.

Parameters:
command - An application-formatted command
Returns:
The converted Command object that will be sent to remote services

convertToUserCommand

java.lang.Object convertToUserCommand(Command command)
PUBLIC: Convert a TopLink Command object into its application-specific format to a

Parameters:
command - An application-formatted command
Returns:
The converted Command object that will be sent to be remotely executed

EclipseLink 1.1.1_ 1.1.1.v20090430-r4097 API Reference