oracle.ifs.protocols.commands.utils

Class CommandInvoker

java.lang.Object

oracle.ifs.protocols.commands.utils.CommandInvoker

public final class CommandInvoker
extends Object

A CommandInvoker is an object for invoking commands without runtime knowledge of which command is being run. The CommandInvoker is setup by registering a series of Commands each with an ArgumentTranslator, a ResultTranslator, and a CommandKey.

Version:

0.9

Author:

Patricia Li, Kevin Gillett

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD_FOLDER_RELATIONSHIP_COMMAND An AddFolderRelationshipCommand is the command for adding a folder relationship.
static String	ATTRIBUTE_STRING_DISPLAY_COMMAND A AttributeStringDisplayCommand is the command for displaying attributes of a LibraryObject as a string.
static String	BLANK_COMMAND A BlankCommand is the default empty implementation.
static String	CANCEL_CHECK_OUT_COMMAND A CancelCheckOutCommand is the command for canceling a checkout.
static String	CAT_COMMAND A CatCommand is the command for renderering an LibraryObject as either a Reader or a Stream for the purpose of text display.
static String	CD_COMMAND A CDCommand is the command for setting the relative path of a FolderPathResolver.
static String	CHECK_IN_COMMAND A CheckInCommand is the command for checking in an object.
static String	CHECK_OUT_COMMAND A CheckOutCommand is the command for checking out an object.
static String	CHECKED_OUT_BY_COMMAND A CheckedOutByCommand is the command for returning the reservor of an object.
static String	CLOSE_CHANNEL_COMMAND A CloseChannelCommand is the protocol command for closing a channel without a logout.
static String	COPY_COMMAND A CopyCommand is the for copying an object in the system.
static String	CREATE_DOCUMENT_COMMAND A CreateDocumentCommand is the command for creating a document.
static String	CREATE_FOLDER_COMMAND A CreateFolderCommand is the command for creating a folder.
static String	DETERMINE_ACL_COMMAND A DetermineAclCommand is the command for determining the acl of an object.
static String	DETERMINE_FORMAT_COMMAND A DetermineFormatCommand is the command for determining the format of a document based on its filename extension.
static String	DETERMINE_PARSER_COMMAND A DetermineParserCommand is the command for determining the availability of a parser based on a filename.
static String	DOES_PUBLIC_OBJECT_EXIST_BY_ID_COMMAND A DoesPublicObjectExistByIdCommand is the command for determining, by specifying an id, whether a PublicObject exist or not.
static String	DOES_PUBLIC_OBJECT_EXIST_BY_PATH_COMMAND A DoesPublicObjectExistByPathCommand is the command for determining, by specifying a path, whether a PublicObject exist or not.
static String	FIND_PUBLIC_OBJECT_BY_ID_COMMAND A FindPublicObjectByIdCommand is the command for looking up a PublicObject by specifying an id.
static String	FIND_PUBLIC_OBJECT_BY_PATH_COMMAND A FindPublicObjectByPathCommand is the command for looking up a PublicObject by specifying a path.
static String	FREE_LIBRARY_OBJECT_COMMAND A FreeLibraryObjectCommand is the command for freeing any generic object in the system.
static String	GET_ATTRIBUTE_NAMES_COMMAND A GetAttributeNamesCommand is the command for getting all the attribute names of a LibraryObject.
static String	GET_ATTRIBUTES_COMMAND A GetAttributesCommand is the command for getting attributes for a LibraryObject.
static String	GET_BEANS_VERSION_COMMAND A GetBeansVersionCommand is the command for retrieving bean's version as a String..
static String	GET_CURRENT_USER_COMMAND A GetCurrentUserCommand is the command for getting the current user.
static String	HANDLE_PUBLIC_OBJECT_VERSIONING_COMMAND A HandlePublicObjectVersioningCommand is the command for adding an object with versioning semantics.
static String	HELP_STRING_COMMAND A HelpStringCommand is the command for storing and retiriving help strings.
static String	INVOKE_SELECTOR_AND_LIST_OUTPUT_COMMAND A InvokeSelectorAndListOutputCommand is the command for invoking a selector and then listing the output.
static String	INVOKE_SELECTOR_COMMAND A InvokeSelectorCommand is the command for invoking a selector.
static String	IS_CHECKED_OUT_COMMAND A IsCheckedOutCommand is the command for determining whether an object is currently checked out or not.
static String	IS_VERSIONED_COMMAND A IsVersionedCommand is the command for determining whether an object is currently versioned or not.
static String	LIST_STRING_COMMAND A ListStringCommand is the command for listing objects as strings.
static String	LOGIN_COMMAND A LoginCommand is the login command.
static String	LOGOUT_COMMAND A LogoutCommand is the logout command.
static String	MOVE_COMMAND A MoveCommand is the command for moving an existing object.
static String	OPEN_SOCKET_COMMAND An OpenSocketCommand is the protocol command for opening a socket for generic use.
static String	PARSE_STREAM_COMMAND A ParseStreamCommand is the command for parse a content stream.
static String	PASV_COMMAND A PasvCommand is the protocol command for putting a SocketFactory into passive mode.
static String	REMOVE_FOLDER_RELATIONSHIP_COMMAND A RemoveFolderRelationshipCommand is the command for removing a folder relationship.
static String	RENDER_AS_RACI_COMMAND A RenderAsRaciCommand is the command for renderering an LibraryObject as a Raci.
static String	RENDER_AS_READER_COMMAND A RenderAsReaderCommand is the command for renderering an LibraryObject as a Reader.
static String	RENDER_AS_STREAM_COMMAND A RenderAsStreamCommand is the command for renderering an LibraryObject as a InputStream.
static String	SET_ATTRIBUTES_COMMAND A SetAttributesCommand is the command for setting an attribute of LibraryObjects.
static String	SHOW_ALL_PATHS_COMMAND A ShowAllPathsCommand is the command for showwing all the paths to a given PublicObject.
static String	UPLOAD_FILE_COMMAND A UploadFileCommand is the command for uploading a file with or without parsing.
static String	VERIFY_COOKIE_COMMAND A VerifyCookie is the protocol command for verifying a cookie value.

Constructor Summary

Constructors

Constructor and Description
CommandInvoker(LibrarySession session) Default Constructor

Method Summary

Modifier and Type	Method and Description
Command	getCommand(String cmdName) Get an instance of the requested command.
void	invoke(Object invoker, Object args, Object cmdKey) Opaquly runs the command identified by cmdKey.
void	registerCommand(Object cmdKey, Command cmd, ArgumentTranslator argTrans, ResultTranslator resultTrans) Registers a cmdKey with a command, argument translator, and result translator.
void	registerCommand(Object cmdKey, String cmd) Registers a cmdKey with a command, where the command is also the ArgumentTranslator and the ResultTranslator.
void	registerCommand(Object cmdKey, String cmd, ArgumentTranslator argTrans, ResultTranslator resultTrans) Registers a cmdKey with a command, argument translator, and result translator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADD_FOLDER_RELATIONSHIP_COMMAND

public static final String ADD_FOLDER_RELATIONSHIP_COMMAND

An AddFolderRelationshipCommand is the command for adding a folder relationship.

See Also:

Constant Field Values

(Published)

ATTRIBUTE_STRING_DISPLAY_COMMAND

public static final String ATTRIBUTE_STRING_DISPLAY_COMMAND

A AttributeStringDisplayCommand is the command for displaying attributes of a LibraryObject as a string.

See Also:

Constant Field Values

(Published)

BLANK_COMMAND

public static final String BLANK_COMMAND

A BlankCommand is the default empty implementation.

See Also:

Constant Field Values

(Published)

CANCEL_CHECK_OUT_COMMAND

public static final String CANCEL_CHECK_OUT_COMMAND

A CancelCheckOutCommand is the command for canceling a checkout.

See Also:

Constant Field Values

(Published)

CAT_COMMAND

public static final String CAT_COMMAND

A CatCommand is the command for renderering an LibraryObject as either a Reader or a Stream for the purpose of text display.

See Also:

Constant Field Values

(Published)

CD_COMMAND

public static final String CD_COMMAND

A CDCommand is the command for setting the relative path of a FolderPathResolver.

See Also:

Constant Field Values

(Published)

CHECKED_OUT_BY_COMMAND

public static final String CHECKED_OUT_BY_COMMAND

A CheckedOutByCommand is the command for returning the reservor of an object.

See Also:

Constant Field Values

(Published)

CHECK_IN_COMMAND

public static final String CHECK_IN_COMMAND

A CheckInCommand is the command for checking in an object.

See Also:

Constant Field Values

(Published)

CHECK_OUT_COMMAND

public static final String CHECK_OUT_COMMAND

A CheckOutCommand is the command for checking out an object.

See Also:

Constant Field Values

(Published)

CLOSE_CHANNEL_COMMAND

public static final String CLOSE_CHANNEL_COMMAND

A CloseChannelCommand is the protocol command for closing a channel without a logout.

See Also:

Constant Field Values

(Published)

COPY_COMMAND

public static final String COPY_COMMAND

A CopyCommand is the for copying an object in the system.

See Also:

Constant Field Values

(Published)

CREATE_DOCUMENT_COMMAND

public static final String CREATE_DOCUMENT_COMMAND

A CreateDocumentCommand is the command for creating a document.

See Also:

Constant Field Values

(Published)

CREATE_FOLDER_COMMAND

public static final String CREATE_FOLDER_COMMAND

A CreateFolderCommand is the command for creating a folder.

See Also:

Constant Field Values

(Published)

DETERMINE_ACL_COMMAND

public static final String DETERMINE_ACL_COMMAND

A DetermineAclCommand is the command for determining the acl of an object.

See Also:

Constant Field Values

(Published)

DETERMINE_FORMAT_COMMAND

public static final String DETERMINE_FORMAT_COMMAND

A DetermineFormatCommand is the command for determining the format of a document based on its filename extension.

See Also:

Constant Field Values

(Published)

DETERMINE_PARSER_COMMAND

public static final String DETERMINE_PARSER_COMMAND

A DetermineParserCommand is the command for determining the availability of a parser based on a filename.

See Also:

Constant Field Values

(Published)

DOES_PUBLIC_OBJECT_EXIST_BY_ID_COMMAND

public static final String DOES_PUBLIC_OBJECT_EXIST_BY_ID_COMMAND

A DoesPublicObjectExistByIdCommand is the command for determining, by specifying an id, whether a PublicObject exist or not.

See Also:

Constant Field Values

(Published)

DOES_PUBLIC_OBJECT_EXIST_BY_PATH_COMMAND

public static final String DOES_PUBLIC_OBJECT_EXIST_BY_PATH_COMMAND

A DoesPublicObjectExistByPathCommand is the command for determining, by specifying a path, whether a PublicObject exist or not.

See Also:

Constant Field Values

(Published)

FIND_PUBLIC_OBJECT_BY_ID_COMMAND

public static final String FIND_PUBLIC_OBJECT_BY_ID_COMMAND

A FindPublicObjectByIdCommand is the command for looking up a PublicObject by specifying an id.

See Also:

Constant Field Values

(Published)

FIND_PUBLIC_OBJECT_BY_PATH_COMMAND

public static final String FIND_PUBLIC_OBJECT_BY_PATH_COMMAND

A FindPublicObjectByPathCommand is the command for looking up a PublicObject by specifying a path.

See Also:

Constant Field Values

(Published)

FREE_LIBRARY_OBJECT_COMMAND

public static final String FREE_LIBRARY_OBJECT_COMMAND

A FreeLibraryObjectCommand is the command for freeing any generic object in the system.

See Also:

Constant Field Values

(Published)

GET_ATTRIBUTE_NAMES_COMMAND

public static final String GET_ATTRIBUTE_NAMES_COMMAND

A GetAttributeNamesCommand is the command for getting all the attribute names of a LibraryObject.

See Also:

Constant Field Values

(Published)

GET_ATTRIBUTES_COMMAND

public static final String GET_ATTRIBUTES_COMMAND

A GetAttributesCommand is the command for getting attributes for a LibraryObject.

See Also:

Constant Field Values

(Published)

GET_BEANS_VERSION_COMMAND

public static final String GET_BEANS_VERSION_COMMAND

A GetBeansVersionCommand is the command for retrieving bean's version as a String..

See Also:

Constant Field Values

(Published)

GET_CURRENT_USER_COMMAND

public static final String GET_CURRENT_USER_COMMAND

A GetCurrentUserCommand is the command for getting the current user.

See Also:

Constant Field Values

(Published)

HANDLE_PUBLIC_OBJECT_VERSIONING_COMMAND

public static final String HANDLE_PUBLIC_OBJECT_VERSIONING_COMMAND

A HandlePublicObjectVersioningCommand is the command for adding an object with versioning semantics.

See Also:

Constant Field Values

(Published)

HELP_STRING_COMMAND

public static final String HELP_STRING_COMMAND

A HelpStringCommand is the command for storing and retiriving help strings.

See Also:

Constant Field Values

(Published)

IS_CHECKED_OUT_COMMAND

public static final String IS_CHECKED_OUT_COMMAND

A IsCheckedOutCommand is the command for determining whether an object is currently checked out or not.

See Also:

Constant Field Values

(Published)

IS_VERSIONED_COMMAND

public static final String IS_VERSIONED_COMMAND

A IsVersionedCommand is the command for determining whether an object is currently versioned or not.

See Also:

Constant Field Values

(Published)

INVOKE_SELECTOR_AND_LIST_OUTPUT_COMMAND

public static final String INVOKE_SELECTOR_AND_LIST_OUTPUT_COMMAND

A InvokeSelectorAndListOutputCommand is the command for invoking a selector and then listing the output.

See Also:

Constant Field Values

(Published)

INVOKE_SELECTOR_COMMAND

public static final String INVOKE_SELECTOR_COMMAND

A InvokeSelectorCommand is the command for invoking a selector.

See Also:

Constant Field Values

(Published)

LIST_STRING_COMMAND

public static final String LIST_STRING_COMMAND

A ListStringCommand is the command for listing objects as strings.

See Also:

Constant Field Values

(Published)

LOGIN_COMMAND

public static final String LOGIN_COMMAND

A LoginCommand is the login command.

See Also:

Constant Field Values

(Published)

LOGOUT_COMMAND

public static final String LOGOUT_COMMAND

A LogoutCommand is the logout command.

See Also:

Constant Field Values

(Published)

MOVE_COMMAND

public static final String MOVE_COMMAND

A MoveCommand is the command for moving an existing object.

See Also:

Constant Field Values

(Published)

OPEN_SOCKET_COMMAND

public static final String OPEN_SOCKET_COMMAND

An OpenSocketCommand is the protocol command for opening a socket for generic use.

See Also:

Constant Field Values

(Published)

PARSE_STREAM_COMMAND

public static final String PARSE_STREAM_COMMAND

A ParseStreamCommand is the command for parse a content stream.

See Also:

Constant Field Values

(Published)

PASV_COMMAND

public static final String PASV_COMMAND

A PasvCommand is the protocol command for putting a SocketFactory into passive mode.

See Also:

Constant Field Values

(Published)

REMOVE_FOLDER_RELATIONSHIP_COMMAND

public static final String REMOVE_FOLDER_RELATIONSHIP_COMMAND

A RemoveFolderRelationshipCommand is the command for removing a folder relationship.

See Also:

Constant Field Values

(Published)

RENDER_AS_RACI_COMMAND

public static final String RENDER_AS_RACI_COMMAND

A RenderAsRaciCommand is the command for renderering an LibraryObject as a Raci.

See Also:

Constant Field Values

(Published)

RENDER_AS_READER_COMMAND

public static final String RENDER_AS_READER_COMMAND

A RenderAsReaderCommand is the command for renderering an LibraryObject as a Reader.

See Also:

Constant Field Values

(Published)

RENDER_AS_STREAM_COMMAND

public static final String RENDER_AS_STREAM_COMMAND

A RenderAsStreamCommand is the command for renderering an LibraryObject as a InputStream.

See Also:

Constant Field Values

(Published)

SET_ATTRIBUTES_COMMAND

public static final String SET_ATTRIBUTES_COMMAND

A SetAttributesCommand is the command for setting an attribute of LibraryObjects.

See Also:

Constant Field Values

(Published)

SHOW_ALL_PATHS_COMMAND

public static final String SHOW_ALL_PATHS_COMMAND

A ShowAllPathsCommand is the command for showwing all the paths to a given PublicObject.

See Also:

Constant Field Values

(Published)

UPLOAD_FILE_COMMAND

public static final String UPLOAD_FILE_COMMAND

A UploadFileCommand is the command for uploading a file with or without parsing.

See Also:

Constant Field Values

(Published)

VERIFY_COOKIE_COMMAND

public static final String VERIFY_COOKIE_COMMAND

A VerifyCookie is the protocol command for verifying a cookie value.

See Also:

Constant Field Values

(Published)

Constructor Detail

CommandInvoker

public CommandInvoker(LibrarySession session)

Default Constructor

(Published)

Method Detail

invoke

public void invoke(Object invoker,
                   Object args,
                   Object cmdKey)
            throws IfsException

Opaquly runs the command identified by cmdKey.

Parameters:

invoker - handle back to invocation environment.

args - args into the command interrpreted by ArgumentTranslator.

cmdKey - key to identify Command.

Throws:

IfsException

(Published)

registerCommand

public void registerCommand(Object cmdKey,
                            String cmd,
                            ArgumentTranslator argTrans,
                            ResultTranslator resultTrans)
                     throws IfsException

Registers a cmdKey with a command, argument translator, and result translator.

Parameters:

cmdKey - to identify the command.

cmd - the string the represent the command

argTrans - the argument translator

resultTrans - the result translator

Throws:

IfsException

(Published)

registerCommand

public void registerCommand(Object cmdKey,
                            Command cmd,
                            ArgumentTranslator argTrans,
                            ResultTranslator resultTrans)
                     throws IfsException

Registers a cmdKey with a command, argument translator, and result translator.

Parameters:

cmdKey - to identify the command.

cmd - the string the represent the command

argTrans - the argument translator

resultTrans - the result translator

Throws:

IfsException

(Published)

registerCommand

public void registerCommand(Object cmdKey,
                            String cmd)
                     throws IfsException

Registers a cmdKey with a command, where the command is also the ArgumentTranslator and the ResultTranslator.

Parameters:

cmdKey - to identify the command.

cmd - the string the represent the command. This command must implement ArgumentTranslator and ResultTranslator interfaces.

Throws:

IfsException

(Published)

getCommand

public Command getCommand(String cmdName)
                   throws IfsException

Get an instance of the requested command. If the command is not present in the cache, then we create one. If the command is already present in the cache, but a new command class has been registered, then we need to create a new instance of command.

Parameters:

cmdName - The name of the command. It takes in the command key name found in the public static varialbes of this class.

Throws:

IfsException

(Published)