oracle.as.scheduler.substitution

Class RequestSubstitutionHandler

java.lang.Object

oracle.as.scheduler.substitution.RequestSubstitutionHandler

All Implemented Interfaces:

SubstitutionHandler

public class RequestSubstitutionHandler
extends Object
implements SubstitutionHandler

Aggregate substitution handler for RequestContextSubstitutionHandler and RequestParamSubstitutionHandler. This handler has its own prefix: "ESS_REQ" that can be used for either RequestExecutionContext or RequestParameters substitution.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Used to release any resources the handler may have claimed, such as open files or connections.
boolean	containsKey(String name) Reports whether the handler can return a value to substitute for name.
String	get(String name) Gets the value which will be used to replace the token.
String	getId() An identifier that can be used to request that a specific handler (or set of handlers) should be used for a substitution.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public 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(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

Parameters:

name - the key value being checked

Returns:

Returns true if it can handle name, false otherwise

get

public String get(String name)

Description copied from interface: SubstitutionHandler

Gets 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, then get() should return a non-null String.

Specified by:

get in interface SubstitutionHandler

Parameters:

name - The key value for the substitution

Returns:

the value. This 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