oracle.as.scheduler.substitution
Class RequestContextSubstitutionHandler

java.lang.Object
  oracle.as.scheduler.substitution.RequestContextSubstitutionHandler

All Implemented Interfaces:

ReqParamCtxtSubstitutionHandler, SubstitutionHandler

public class RequestContextSubstitutionHandler
extends java.lang.Object
implements ReqParamCtxtSubstitutionHandler

This SubstitutionHandler makes the elements of ReqeustExecutionContext available as substitutions.

ID: ESS_REQ_CONTEXT

It provides the following elements:

Name	Context element
REQUEST_ID	getRequestID()
IS_RESUMED	isResumed()
PAUSED_STATE	getPausedState()
REQUEST_HANDLE	getRequestHandle()

This handler is always available in ReqParamCtxtSubstitutor and does not need to be explicitly referenced.

Since:

release specific (what release of product did this appear in)

Version:

$Header: ess/src/oracle/as/scheduler/substitution/RequestContextSubstitutionHandler.java /main/3 2008/07/15 12:10:43 cfuentes Exp $

Author:

cfuentes

See Also:

SubstitutionHandler, ReqParamCtxtSubstitutor

Constructor Summary

RequestContextSubstitutionHandler()

Method Summary

void	close() Used to release any resources the handler may have claimed, such as open files or connections.
boolean	containsKey(java.lang.String name) Reports whether the handler can return a value to substitute for name.
java.lang.String	get(java.lang.String name) Returns the value which will be used to replace the token.
java.lang.String	getId() An identifier that can be used to request that a specific handler (or set of handlers) should be used for a substitution.
void	initialize(RequestExecutionContext context, RequestParameters requestParams) Used to pass the data that the handlers may use for their internal logic.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestContextSubstitutionHandler

public RequestContextSubstitutionHandler()

Method Detail

initialize

public void initialize(RequestExecutionContext context,
                       RequestParameters requestParams)

Description copied from interface: ReqParamCtxtSubstitutionHandler

Used to pass the data that the handlers may use for their internal logic.

Specified by:

initialize in interface ReqParamCtxtSubstitutionHandler

Parameters:

context - The execution context to be used for substitution.

requestParams - The request parameters from which to extract data.

getId

public java.lang.String getId()

Description copied from interface: SubstitutionHandler

An identifier that can be used to request that a specific handler (or set of handlers) should be used for a substitution.

The returned ID should adhere to basic identifier rules, e.g., it should consist of letters, numbers, and underscores only. A null, blank, or invalid ID may result in the handler being skipped.

The method getId() may be called at any time.

Specified by:

getId in interface SubstitutionHandler

Returns:

Handler identifier

containsKey

public boolean containsKey(java.lang.String name)

Description copied from interface: SubstitutionHandler

Reports whether the handler can return a value to substitute for name. If containsKey returns false, then this handler will not be used for substituting name.

Specified by:

containsKey in interface SubstitutionHandler

Returns:

Returns true if it can handle name, false otherwise

get

public java.lang.String get(java.lang.String name)

Description copied from interface: SubstitutionHandler

Returns the value which will be used to replace the token. If name is not supported, then get() should return null. Conversely, if the handler returns true for containsKey(name), then get() should return a non-null String.

Specified by:

get in interface SubstitutionHandler

Parameters:

name - The key value for the substitution

Returns:

New value, may contain other substitution tokens.

close

public void close()

Description copied from interface: SubstitutionHandler

Used to release any resources the handler may have claimed, such as open files or connections.

Specified by:

close in interface SubstitutionHandler