Package oracle.as.scheduler.substitution

Class RequestParamSubstitutionHandler

java.lang.Object
oracle.as.scheduler.substitution.RequestParamSubstitutionHandler
All Implemented Interfaces:
SubstitutionHandler
public class RequestParamSubstitutionHandler extends Object implements SubstitutionHandler
This SubstitutionHandler makes the elements of RequestParameters available as substitutions. The name argument is used as the RequestParameters name.

ID: ESS_REQ_PARAM

See Also:

  • Constructor Details

    • RequestParamSubstitutionHandler

      public RequestParamSubstitutionHandler(RequestParameters requestParams)

  • Method Details

    • 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