Skip navigation links

com.essbase.eas.framework.client.defs.command
Class UICommandManager

java.lang.Object
com.essbase.eas.framework.defs.command.DefaultCommandManager
com.essbase.eas.framework.client.defs.command.UICommandManager

All Implemented Interfaces:

CommandManager

public class UICommandManager

extends DefaultCommandManager

Manages sending UI requests to a server.

Since:

7.0.0

Version:

7.0.0

Author:

Hank Cox

Field Summary

Fields inherited from class com.essbase.eas.framework.defs.command.DefaultCommandManager

BAD_CLASS_ARGUMENT, COMMAND_IS_NULL, LISTENER_IS_NULL, MANIFEST_CMDMGR_KEY, MANIFEST_LISTENER_KEY, MANIFEST_VALUE, NULL_CLASS_ARGUMENT, NULL_CM_ARGUMENT, REQUEST_IS_NULL, requestor, resources

Constructor Summary

UICommandManager()

Method Summary

boolean	performLogin() Perform the processing necessary to log a user in.
boolean	performLogin(boolean reuseSession) Implementation of the performLogin() method from the CommandManager interface.
CommandResult	routeCommand(java.lang.Object component, CommandRequest request) routes a command to the correct place.
boolean	routeResultsToListeners(CommandRequest request, CommandResult results, int counter) routes the results of a command to the registered listeners, if there are any
CommandResult	sendCommand(CommandRequest request)
CommandResult	sendCommand(java.awt.Component object, CommandRequest request)
BinaryMessage	sendCommandGetBinary(java.lang.String command, java.util.Properties params, java.lang.Class resultClass, byte[] data, boolean background, boolean secure) overrides the DefaultCommandManager.sendCommandGetBinary() method.
CommandResult	sendCommandGetResult(java.lang.String command, java.util.Properties params, byte[] data, boolean background, boolean secure) overrides the DefaultCommandManager.sendCommandGetString() method.
CommandResult	sendCommandGetResult(java.lang.String command, java.util.Properties params, java.lang.Class resultClass, byte[] data, boolean background, boolean secure)
java.lang.String	sendCommandGetString(java.lang.String command, java.util.Properties params, byte[] data, boolean background, boolean secure) overrides the DefaultCommandManager.sendCommandGetString() method.

Methods inherited from class com.essbase.eas.framework.defs.command.DefaultCommandManager

addCommandManager, addResultListener, cachePropertyObject, getCachedPropertyObject, getCommandManagerFor, getCommandManagers, getFirstCommandManager, getRequestor, getReservedCommands, removeAllCommandManagers, removeCommandManager, removeCommandManager, removeResultListener, routeThreadedCommand, sendCommand, sendCommandGetInputStream, sendCommandGetString, sendThreadedCommand, setRequestor

Methods inherited from class java.lang.Object

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

Constructor Detail

UICommandManager

public UICommandManager()

Method Detail

sendCommand

public CommandResult sendCommand(CommandRequest request)
                          throws java.io.IOException,
                                 CommandRequestException

Throws:

java.io.IOException

CommandRequestException

sendCommand

public CommandResult sendCommand(java.awt.Component object,
                                 CommandRequest request)
                          throws java.io.IOException,
                                 CommandRequestException

Throws:

java.io.IOException

CommandRequestException

performLogin

public boolean performLogin()
                     throws FrameworkException

Perform the processing necessary to log a user in. This is called when a session is timed out. Displays the DefaultLoginDialog.

Specified by:

performLogin in interface CommandManager

Overrides:

performLogin in class DefaultCommandManager

Returns:

true if the user has logged in and false otherwise

Throws:

FrameworkException

performLogin

public boolean performLogin(boolean reuseSession)
                     throws FrameworkException

Implementation of the performLogin() method from the CommandManager interface.

Specified by:

performLogin in interface CommandManager

Overrides:

performLogin in class DefaultCommandManager

Parameters:

reuseSession - login using an existing command requestor if possible

Returns:

true if succeeds to login

Throws:

FrameworkException

sendCommandGetString

public java.lang.String sendCommandGetString(java.lang.String command,
                                             java.util.Properties params,
                                             byte[] data,
                                             boolean background,
                                             boolean secure)
                                      throws java.io.IOException

overrides the DefaultCommandManager.sendCommandGetString() method. Changes the cursor to the wait cursor and back; adds checking for Swing event processing.

Specified by:

sendCommandGetString in interface CommandManager

Overrides:

sendCommandGetString in class DefaultCommandManager

Parameters:

command - the command to send

params - the parameters for the command

background - whether to use background processing for this command

data - binary data to send to the mid-tier as part of the command.

secure - whether to send this command in a secure mode.

Returns:

a String representing the results.

Throws:

java.io.IOException

sendCommandGetResult

public CommandResult sendCommandGetResult(java.lang.String command,
                                          java.util.Properties params,
                                          byte[] data,
                                          boolean background,
                                          boolean secure)
                                   throws java.io.IOException

overrides the DefaultCommandManager.sendCommandGetString() method. Changes the cursor to the wait cursor and back; adds checking for Swing event processing.

Specified by:

sendCommandGetResult in interface CommandManager

Overrides:

sendCommandGetResult in class DefaultCommandManager

Parameters:

command - the command to send

params - the parameters for the command

background - whether to use background processing for this command

Returns:

a String representing the results.

Throws:

java.io.IOException

sendCommandGetResult

public CommandResult sendCommandGetResult(java.lang.String command,
                                          java.util.Properties params,
                                          java.lang.Class resultClass,
                                          byte[] data,
                                          boolean background,
                                          boolean secure)
                                   throws java.io.IOException

Specified by:

sendCommandGetResult in interface CommandManager

Overrides:

sendCommandGetResult in class DefaultCommandManager

Throws:

java.io.IOException

sendCommandGetBinary

public BinaryMessage sendCommandGetBinary(java.lang.String command,
                                          java.util.Properties params,
                                          java.lang.Class resultClass,
                                          byte[] data,
                                          boolean background,
                                          boolean secure)
                                   throws java.io.IOException

overrides the DefaultCommandManager.sendCommandGetBinary() method. Changes the cursor to the wait cursor and back; adds checking for Swing event processing.

Specified by:

sendCommandGetBinary in interface CommandManager

Overrides:

sendCommandGetBinary in class DefaultCommandManager

Parameters:

command - the command to send

params - the parameters for the command

resultClass - the class of the expected binary message results.

background - whether to use background processing for this command

data - byte array to be sent as part of this command.

secure - whether to send this command in a secure mode.

Returns:

a String representing the results.

Throws:

java.io.IOException

routeCommand

public CommandResult routeCommand(java.lang.Object component,
                                  CommandRequest request)
                           throws CommandRequestException,
                                  java.io.IOException

Description copied from interface: CommandManager

routes a command to the correct place. This method should not be called by classes outside the inheritance hierarchy of the CommandManager interface.

Specified by:

routeCommand in interface CommandManager

Overrides:

routeCommand in class DefaultCommandManager

Parameters:

component - a supplemental component that the implementing class can act upon; for instance, if the implementing class is on a UI-based platform, then this component could be a Swing-based component for which setting the wait cursor would be appropriate.

request - the command being requested

Returns:

the results of the command.

Throws:

CommandRequestException - if the request isn't properly formatted.

java.io.IOException

routeResultsToListeners

public boolean routeResultsToListeners(CommandRequest request,
                                       CommandResult results,
                                       int counter)

Description copied from class: DefaultCommandManager

routes the results of a command to the registered listeners, if there are any

Specified by:

routeResultsToListeners in interface CommandManager

Overrides:

routeResultsToListeners in class DefaultCommandManager

Parameters:

request - the command request

results - the command results

counter - tracks how many times this command has been attempted. The command result listener can use this to determine if it is worth retrying the command again.

Returns:

true if the command should be retried; false if it shouldn't.

Skip navigation links