Skip navigation links

Oracle Enterprise Scheduler Java API Reference
11g Release 1 (11.1.1.7)
E26229-06


oracle.as.scheduler.substitution
Class EssEnvSubstitutionHandler

java.lang.Object
  extended by oracle.as.scheduler.substitution.EssEnvSubstitutionHandler

All Implemented Interfaces:
SubstitutionHandler

public class EssEnvSubstitutionHandler
extends java.lang.Object
implements SubstitutionHandler

Substitute from the environment. This may be from JVM system properties, environment variables, values obtained from JRF, etc.

Since:
11.1.1.5
Version:
$Header: EssEnvSubstitutionHandler.java 08-apr-2011.17:04:03 kbittler Exp $
Author:
kbittler

Constructor Summary
EssEnvSubstitutionHandler()
           

 

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.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

EssEnvSubstitutionHandler

public EssEnvSubstitutionHandler()

Method Detail

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)
                    throws SubstitutionException
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
Throws:
SubstitutionException - if an error occurs accessing the keys.

get

public java.lang.String get(java.lang.String name)
                     throws SubstitutionException
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.
Throws:
SubstitutionException - if an error occurs accessing the value.

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

Skip navigation links

Oracle Enterprise Scheduler Java API Reference
11g Release 1 (11.1.1.7)
E26229-06


Copyright © 2008, 2013, Oracle and/or its affiliates. All rights reserved.