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 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.

See Also:

Command, CommandManager

Author:

Steven Vo

Since:

OracleAS TopLink 10g (9.0.4)

Method Summary

Methods

Modifier and Type	Method and Description
Command	convertToEclipseLinkCommand(java.lang.Object command) PUBLIC: Convert a command from its application-specific format to a EclipseLink Command object.
java.lang.Object	convertToUserCommand(Command command) PUBLIC: Convert a EclipseLink Command object into its application-specific format to a

Method Detail

convertToEclipseLinkCommand

Command convertToEclipseLinkCommand(java.lang.Object command)

PUBLIC: Convert a command from its application-specific format to a EclipseLink 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 EclipseLink 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