Skip navigation links


com.essbase.eas.essbase.server
Class EssbaseCommandListener

java.lang.Object
  extended by com.essbase.eas.framework.server.application.DefaultApplicationPart
      extended by com.essbase.eas.framework.server.application.AbstractCommandListener
          extended by com.essbase.eas.server.AppManCommandListener
              extended by com.essbase.eas.essbase.server.EssbaseCommandListener

All Implemented Interfaces:
ApplicationPart, CommandListener
Direct Known Subclasses:
ApplicationCommandListener, CalcScriptCommandListener, CASCommandListener, DatabaseCommandListener, DatabaseStatusCommandListener, DataFileCommandListener, DataLoadCommandListener, DownloadFileCommandListener, EQDCommandListener, EssbaseCommandStatusListener, EssbaseFileObjectCommandListener, EssbaseLogCommandListener, FilterCommandListener, FnTemplateCommandListener, FunctionCommandListener, LocationAliasCommandListener, LockedObjectsCommandListener, LocksCommandListener, LogAnalyzerCommandListener, LroCommandListener, MacroCommandListener, MaxLCommandListener, NamedObjectCommandListener, OutlineEditorCommandListener, OutlineViewCommandListener, ReportScriptCommandListener, RulesObjectCommandListener, ServerCommandListener, SubstitutionVariableCommandListener, TriggerCommandListener, TriggerSpoolCommandListener, UploadFileCommandListener, UsrGrpCommandListener

public abstract class EssbaseCommandListener
extends AppManCommandListener
Since:
6.5.1
Version:
7.0.0
Author:
Hyperion Solutions

Field Summary
protected static java.lang.String DEADEND
           
protected static java.lang.String DEADEND_KEY
           
protected static java.lang.String FAILED
           
protected static java.lang.String FAILED_KEY
           
protected static java.lang.String NOT_CONNECTED
           
protected static java.lang.String NOT_CONNECTED_KEY
           
protected static java.lang.String NOT_CONNECTING
           
protected static java.lang.String NOT_CONNECTING_KEY
           
protected static java.lang.String RELOGIN
           
protected static java.lang.String RELOGIN_KEY
           
protected  java.util.Map<java.lang.String,CommandRequestInfo> requestMap
           
protected static java.lang.String TOKEN_TIMEOUT1_KEY
           
protected static java.lang.String TOKEN_TIMEOUT2_KEY
           

 

Fields inherited from class com.essbase.eas.framework.server.application.AbstractCommandListener
aliasMap, methodMap, RESULT, THERESULT, UPLOAD

 

Fields inherited from class com.essbase.eas.framework.server.application.DefaultApplicationPart
CHAIN_SEPARATOR, manager, parts, serviceContext, serviceManager, state, STATE_BEFORE_WORKERS_ASSIGNED, STATE_CONSTRUCTED, STATE_DESTROYED, STATE_INITIALIZED, STATE_MANAGED, STATE_NULL, STATE_WORKERS_ASSIGNED, STATE_WORKERS_INITIALIZED, storeService

 

Constructor Summary
EssbaseCommandListener()
           

 

Method Summary
protected  EssSession getEssbaseSession(CommandEvent theEvent, java.lang.String key, boolean wait)
           
 void handleEventException(CommandEvent command, java.lang.Throwable ex)
          implementation of the CommandListener.handleEventException() method.
 void handleEventPost(CommandEvent command, java.lang.Object results)
          implementation of the CommandListener.handleEventPost() method.
 boolean handleEventPrep(CommandEvent command)
          implementation of the CommandListener.handleEventPrep() method.
 boolean set(ServiceContext context, ScopeType type, java.lang.Object key, XMLTransferObject xto)
           
protected  boolean setResult(CommandEvent theEvent, XMLTransferObject xto)
           
protected  boolean validateSession(CommandEvent command)
          This method will give each command listener a chance to do their validation instead of having to have the knowledge in this module

 

Methods inherited from class com.essbase.eas.server.AppManCommandListener
getSession, getSession, getSession, releaseSession

 

Methods inherited from class com.essbase.eas.framework.server.application.AbstractCommandListener
addMethodAlias, addMethodAlias, assignWorkers, buildMethodMap, convertStringValueToArgument, getArgumentsForCommand, getCommands, getMethod, getMethodForAlias, getRoles, getSessionObject, handleEvent, init, isRequestFromSameServer, removeSessionObject, setServiceResult, setSessionObject

 

Methods inherited from class com.essbase.eas.framework.server.application.DefaultApplicationPart
destroy, getManager, getManagerChain, getServiceContext, getServiceManager, getStoreService, initWorkers, requestPart, requestPartPool, setManager

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface com.essbase.eas.framework.server.defs.ApplicationPart
destroy, getManager, getServiceContext, getServiceManager, getStoreService, initWorkers, setManager

 

Field Detail

FAILED_KEY

protected static final java.lang.String FAILED_KEY
See Also:
Constant Field Values

FAILED

protected static final java.lang.String FAILED

RELOGIN_KEY

protected static final java.lang.String RELOGIN_KEY
See Also:
Constant Field Values

RELOGIN

protected static final java.lang.String RELOGIN

DEADEND_KEY

protected static final java.lang.String DEADEND_KEY
See Also:
Constant Field Values

DEADEND

protected static final java.lang.String DEADEND

NOT_CONNECTING_KEY

protected static final java.lang.String NOT_CONNECTING_KEY
See Also:
Constant Field Values

NOT_CONNECTING

protected static final java.lang.String NOT_CONNECTING

NOT_CONNECTED_KEY

protected static final java.lang.String NOT_CONNECTED_KEY
See Also:
Constant Field Values

NOT_CONNECTED

protected static final java.lang.String NOT_CONNECTED

TOKEN_TIMEOUT1_KEY

protected static final java.lang.String TOKEN_TIMEOUT1_KEY
See Also:
Constant Field Values

TOKEN_TIMEOUT2_KEY

protected static final java.lang.String TOKEN_TIMEOUT2_KEY
See Also:
Constant Field Values

requestMap

protected java.util.Map<java.lang.String,CommandRequestInfo> requestMap

Constructor Detail

EssbaseCommandListener

public EssbaseCommandListener()

Method Detail

handleEventPrep

public boolean handleEventPrep(CommandEvent command)
                        throws ApplicationException
Description copied from class: AbstractCommandListener
implementation of the CommandListener.handleEventPrep() method. Inheriting classes should override this method if they need to perform any special processing before the method invocation occurs.
Specified by:
handleEventPrep in interface CommandListener
Overrides:
handleEventPrep in class AppManCommandListener
Parameters:
command - the command event that we are processing.
Returns:
true if Ok to continue, false otherwise
Throws:
ApplicationException

handleEventPost

public void handleEventPost(CommandEvent command,
                            java.lang.Object results)
Description copied from class: AbstractCommandListener
implementation of the CommandListener.handleEventPost() method. Inheriting classes should override this method if they need to perform some post invocation work on the results of the command.
Specified by:
handleEventPost in interface CommandListener
Overrides:
handleEventPost in class AppManCommandListener
Parameters:
command - the command event that we are processing.

handleEventException

public void handleEventException(CommandEvent command,
                                 java.lang.Throwable ex)
                          throws ApplicationException
Description copied from class: AbstractCommandListener
implementation of the CommandListener.handleEventException() method. Inheriting classes should override this if they need to do something special when an exception is thrown during the method invocation.
Specified by:
handleEventException in interface CommandListener
Overrides:
handleEventException in class AppManCommandListener
Throws:
ApplicationException

validateSession

protected boolean validateSession(CommandEvent command)
                           throws MessageException
This method will give each command listener a chance to do their validation instead of having to have the knowledge in this module
Parameters:
hmap - The hash map containig the params
commandName - The command name
Returns:
true if the session is validated
Throws:
MessageException

setResult

protected boolean setResult(CommandEvent theEvent,
                            XMLTransferObject xto)

set

public boolean set(ServiceContext context,
                   ScopeType type,
                   java.lang.Object key,
                   XMLTransferObject xto)

getEssbaseSession

protected EssSession getEssbaseSession(CommandEvent theEvent,
                                       java.lang.String key,
                                       boolean wait)
                                throws MessageException
Throws:
MessageException

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.