Top Description Methods
org.eclipse.persistence.sessions.coordination

public Interface CommandConverter

Imports
org.eclipse.persistence.sessions.coordination.Command

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 convertToEclipseLinkCommand(), 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 EclipseLink Command object into an object that is suitable for being processed by the application.

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

Method Summary

Modifier and TypeMethod and Description
public Command

Returns:

The converted Command object that will be sent to remote services
convertToEclipseLinkCommand
(Object
An application-formatted command
command
)

PUBLIC: Convert a command from its application-specific format to a EclipseLink Command object.

public Object

Returns:

The converted Command object that will be sent to be remotely executed
convertToUserCommand
(Command
An application-formatted command
command
)

PUBLIC: Convert a EclipseLink Command object into its application-specific format to a

Method Detail

convertToEclipseLinkCommandback to summary
public Command convertToEclipseLinkCommand(Object command)

PUBLIC: Convert a command from its application-specific format to a EclipseLink Command object.

Parameters
command:Object

An application-formatted command

Returns:Command

The converted Command object that will be sent to remote services

convertToUserCommandback to summary
public Object convertToUserCommand(Command command)

PUBLIC: Convert a EclipseLink Command object into its application-specific format to a

Parameters
command:Command

An application-formatted command

Returns:Object

The converted Command object that will be sent to be remotely executed