Package oracle.as.scheduler.substitution

Interface SubstitutionHandler

All Known Implementing Classes:
AppEnvSubstitutionHandler, CcwSubstitutionHandler, EssEnvSubstitutionHandler, RequestContextSubstitutionHandler, RequestParamSubstitutionHandler, RequestSubstitutionHandler
public interface SubstitutionHandler
Interface for handlers used by classes implementing Substitutor.
See Also:

  • Method Summary

    Modifier and Type
    Method
    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.

  • Method Details

    • getId

      String getId()
      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.

      Returns:
      Handler identifier

    • containsKey

      boolean containsKey(String name) throws SubstitutionException
      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.
      Parameters:
      name - the key value being checked
      Returns:
      Returns true if it can handle name, false otherwise
      Throws:
      SubstitutionException - if an error occurs accessing the keys.

    • get

      String get(String name) throws SubstitutionException
      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.
      Parameters:
      name - The key value for the substitution
      Returns:
      the value. This may contain other substitution tokens.
      Throws:
      SubstitutionException - if an error occurs accessing the value.

    • close

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