Skip navigation links

com.essbase.eas.server.fireforget
Class FireAndForgetCommandListener

java.lang.Object
com.essbase.eas.framework.server.application.DefaultApplicationPart
com.essbase.eas.framework.server.application.AbstractCommandListener
com.essbase.eas.server.fireforget.FireAndForgetCommandListener

All Implemented Interfaces:

ApplicationPart, CommandListener

public class FireAndForgetCommandListener

extends AbstractCommandListener

FireAndForgetCommandListener Holds utility commands of fire-and-forget

Since:

6.2.0

Version:

6.5.4

Author:

Brendan Gaul

Field Summary

static java.lang.String	NO_USER
static java.lang.String	NO_USER_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

FireAndForgetCommandListener()

Method Summary

boolean	fafGetAllStatus(CommandEvent theEvent, ServiceContext context) Report all work done asynchronously.
boolean	fafGetStatus(CommandEvent theEvent, ServiceContext context, java.lang.String username) Report by user on work done asynchronously
void	fafRemoveItem(CommandEvent theEvent, ServiceContext theContext, java.lang.String workID) Remove work item by ID.
void	fafRetrieveFileResult(CommandEvent theEvent, ServiceContext theContext, java.lang.String workID) Retrieves file result of FAF action (e.g., reports)
CommandDescriptor[]	getCommands() Implementation of the CommandListener.getCommands() method.
boolean	handleEventPrep(CommandEvent commandEvent) implementation of the CommandListener.handleEventPrep() method.

Methods inherited from class com.essbase.eas.framework.server.application.AbstractCommandListener

addMethodAlias, addMethodAlias, assignWorkers, buildMethodMap, convertStringValueToArgument, getArgumentsForCommand, getMethod, getMethodForAlias, getRoles, getSessionObject, handleEvent, handleEventException, handleEventPost, 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

NO_USER_KEY

public static final java.lang.String NO_USER_KEY

See Also:

Constant Field Values

NO_USER

public static java.lang.String NO_USER

Constructor Detail

FireAndForgetCommandListener

public FireAndForgetCommandListener()

Method Detail

handleEventPrep

public boolean handleEventPrep(CommandEvent commandEvent)
                        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 AbstractCommandListener

Parameters:

commandEvent - the command event that we are processing.

Returns:

true if Ok to continue, false otherwise

Throws:

ApplicationException

fafGetStatus

public boolean fafGetStatus(CommandEvent theEvent,
                            ServiceContext context,
                            java.lang.String username)

Report by user on work done asynchronously

Parameters:

theEvent - - the event

context - - the context

username - - the EAS user to get status for

fafGetAllStatus

public boolean fafGetAllStatus(CommandEvent theEvent,
                               ServiceContext context)

Report all work done asynchronously.

Parameters:

theEvent - - the command event

context - - the service context

Returns:

true if successful

fafRemoveItem

public void fafRemoveItem(CommandEvent theEvent,
                          ServiceContext theContext,
                          java.lang.String workID)

Remove work item by ID.

Parameters:

theEvent - - the command event

theContext - - the service context

workID - - the work id for this item

fafRetrieveFileResult

public void fafRetrieveFileResult(CommandEvent theEvent,
                                  ServiceContext theContext,
                                  java.lang.String workID)

Retrieves file result of FAF action (e.g., reports)

Parameters:

theEvent - - the command event

theContext - - the service context

workID - - the identifier for this process

getCommands

public CommandDescriptor[] getCommands()

Description copied from class: AbstractCommandListener

Implementation of the CommandListener.getCommands() method. This is an empty implementation and should be overridden by any derived classes that use the new introspection method of discovering commands.

Specified by:

getCommands in interface CommandListener

Overrides:

getCommands in class AbstractCommandListener

Returns:

a zero-length array of CommandDescriptor objects.

Skip navigation links