oracle.ifs.core.handlers

Class ScriptHandler

java.lang.Object

oracle.ifs.core.handlers.AuditEventHandlerAdapter

oracle.ifs.core.handlers.ScriptHandler

All Implemented Interfaces:

AuditEventHandler

public class ScriptHandler
extends AuditEventHandlerAdapter

ScriptHandler implements the AuditEventHandler interface, and handles a special event used to execute a set of ScriptOperations on behalf of the system user.

Author:

Dave Long

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ScriptHandler.LocalScriptDriver LocalScriptDriver extends EcmScriptDriver to capture the log output, so that a result document can be created to show the results.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYSTEM__SCRIPT_OPERATIONS_REQUESTED Custom event type for a script operations request.

Fields inherited from class oracle.ifs.core.handlers.AuditEventHandlerAdapter

DEFAULT_BATCHSIZE

Constructor Summary

Constructors

Constructor and Description
ScriptHandler()

Method Summary

Modifier and Type	Method and Description
protected void	createScriptResultDocument(LibrarySession session, String path, StringBuffer result) Create a document with the script results, as indicated by the specified path.
protected String	getDefaultScriptOperationsClass() Returns the fully qualified operations class name to use by default in executing the script operations, or null if the default shouldbe used.
void	handleEventPosted(AuditEventHandlerContext context) Called when at least one registered event is posted.
void	handleInitialize(AuditEventHandlerContext context) Initializes this handler.
void	handleTimerExpired(AuditEventHandlerContext context) Called when the timer for this AuditEventHandler expires.
protected boolean	isValidEvent(AuditEventHandlerContext context, LibrarySession session, AuditEvent event) Verify that the event represents a valid request by a valid user.
protected void	processEvent(AuditEventHandlerContext context, AuditEvent event) Process an event, by executing a set of script operations.

Methods inherited from class oracle.ifs.core.handlers.AuditEventHandlerAdapter

deleteEvents, getAuditHandlerSpecification, getAuditSpecification, getHandlerProperty, handleDispose, markProcessingCompleted, markProcessingStarted, processEvents, processEvents, processEvents, selectEvents, selectEvents, selectMaximumEventId, setHandlerProperty, setProcessingStarted

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM__SCRIPT_OPERATIONS_REQUESTED

public static final String SYSTEM__SCRIPT_OPERATIONS_REQUESTED

Custom event type for a script operations request.

Double underscore is intentional, as this is the name of this custom event.

See Also:

Constant Field Values

Constructor Detail

ScriptHandler

public ScriptHandler()

Method Detail

handleInitialize

public void handleInitialize(AuditEventHandlerContext context)
                      throws Exception

Description copied from class: AuditEventHandlerAdapter

Initializes this handler.

Called immediately after construction.

Specified by:

handleInitialize in interface AuditEventHandler

Overrides:

handleInitialize in class AuditEventHandlerAdapter

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

Exception - if the operation fails

handleEventPosted

public void handleEventPosted(AuditEventHandlerContext context)
                       throws Exception

Description copied from class: AuditEventHandlerAdapter

Called when at least one registered event is posted.

Specified by:

handleEventPosted in interface AuditEventHandler

Overrides:

handleEventPosted in class AuditEventHandlerAdapter

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

Exception - if the operation fails

handleTimerExpired

public void handleTimerExpired(AuditEventHandlerContext context)
                        throws Exception

Description copied from class: AuditEventHandlerAdapter

Called when the timer for this AuditEventHandler expires.

Specified by:

handleTimerExpired in interface AuditEventHandler

Overrides:

handleTimerExpired in class AuditEventHandlerAdapter

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

Exception - if the operation fails

processEvent

protected void processEvent(AuditEventHandlerContext context,
                            AuditEvent event)
                     throws IfsException

Process an event, by executing a set of script operations.

Delete the event after processing.

Overrides:

processEvent in class AuditEventHandlerAdapter

Parameters:

context - the AuditEventHandlerContext to use for processing

event - the event to process

Throws:

IfsException - if the operation fails

isValidEvent

protected boolean isValidEvent(AuditEventHandlerContext context,
                               LibrarySession session,
                               AuditEvent event)
                        throws IfsException

Verify that the event represents a valid request by a valid user.

Parameters:

context - the AuditEventHandlerContext to use for processing

session - the session context

event - the event to process

Throws:

IfsException - if the operation fails

getDefaultScriptOperationsClass

protected String getDefaultScriptOperationsClass()

Returns the fully qualified operations class name to use by default in executing the script operations, or null if the default shouldbe used.

Returns:

the fully qualified operations class name

Throws:

IfsException - if the operation fails

createScriptResultDocument

protected void createScriptResultDocument(LibrarySession session,
                                          String path,
                                          StringBuffer result)
                                   throws IfsException

Create a document with the script results, as indicated by the specified path.

Parameters:

session - the session context

path - the path to the document to create

result - the script results that should be the content of the document

Throws:

IfsException - if the operation fails