com.tivoli.pd.jadmin
Class PDAdmin

java.lang.Object
  |
  +--com.tivoli.pd.jadmin.PDAdmin

public final class PDAdmin
extends java.lang.Object

Utility class used to perform initialization and shutdown operations needed by the Policy Director Admin API component classes.


Method Summary
static java.lang.String getProgramName()
          Return the program name used to initialize this component.
static void initialize(java.lang.String progName, PDMessages messages)
          Perform initialization needed by the Policy Director Admin API classes.
static boolean isInited()
          Indicates whether this component has been initialized or not.
static void shutdown(PDMessages messages)
          Perform shutdown needed by the Policy Director Admin API classes.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

initialize

public static void initialize(java.lang.String progName,
                              PDMessages messages)
                       throws PDException
Perform initialization needed by the Policy Director Admin API classes. This method should be called before using any of the classes. Each call to this method increments a reference count, but only the first invocation executes initialization operations. On subsequent calls, a warning message is returned in the messages argument to indicate a previous initialization. Any returned warning messages or exception text is translated into the default locale.

Every call to this method must be coupled with a call to shutdown so that the necessary cleanup can take place.

This method requires the javax.security.auth.AuthPermission("PDAdmin") permission.

Parameters:
progName - the program name that will appear in trace and message logs for the Policy Director Admin API classes.
messages - in/out parameter; empty PDMessages on input; may contain zero or more informational or warning messages on output.
Throws:
PDException - if the component cannot be initialized properly. In exception cases, the component is not initialized and the reference count is not incremented; therefore shutdown should not be called. This exception may contain error and message codes defined in the product Error Message Reference document.

shutdown

public static void shutdown(PDMessages messages)
                     throws PDException
Perform shutdown needed by the Policy Director Admin API classes. Currently, re-initialization after shutdown is not supported, and once shutdown has been executed, the classes should no longer be used. This method first decrements a reference count. The actual shutdown operations are executed only if the decremented reference count is zero. On calls that decrement the reference count but do not execute shutdown, a warning message is returned in the messages argument. Any returned warning messages or exception text is translated into the default locale.

This method requires the javax.security.auth.AuthPermission("PDAdmin") permission.

Parameters:
messages - in/out parameter; empty PDMessages on input; may contain zero or more informational or warning messages on output.
Throws:
PDException - if the component cannot be shutdown properly. This exception may contain error and message codes defined in the product Error Message Reference document.

isInited

public static boolean isInited()
Indicates whether this component has been initialized or not. The initialize method may be called multiple times, but only the first invocation will actually cause intialization operations to take place.

All callers of initialize(), the first and later ones, must call shutdown so that the necessary cleanup can take place.

Returns:
true, if this component has been initialized and has not been shutdown; false, if this component has not been initialized, or has been shutdown.

getProgramName

public static java.lang.String getProgramName()
Return the program name used to initialize this component. This program name will appear in message and trace output generated by the component. Null is returned if the component is not initialized.