|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.tivoli.pd.jadmin.PDAdmin
Utility class used to perform initialization and shut down operations needed by the Tivoli Access Manager Administration Java component classes.
Certain default values used in initialization can be overridden by
specifying properties. The supported properties keys have names in the
form PDADMIN_XXX_PROPERTY
and are defined in this
class. The properties can be specified on the command line through Java's
-D flag or can be passed in to the
initialize(String, Properties, PDMessages)
method through the
Properties argument.
Field Summary | |
---|---|
static java.lang.String |
AZN_PLUGINSTAT_ATTR
Attribute containing the status returned from the execution of a method within a Tivoli Access Manager Administration Service plugin shared library. |
static java.lang.String |
AZN_RESULTS_ATTR
Attribute containing the results returned from the execution of a method within a Tivoli Access Manager Administration Service plugin shared library. |
static com.tivoli.pd.jras.pdjlog.PDJMessageLogger |
msgLog
|
static java.lang.String |
PDADMIN_PDJLOGCFG_PROPERTY
These constants are externalized constants that are used in support of more than one PDAdmin class |
static com.tivoli.pd.jras.pdjlog.PDJTraceLogger |
trcLog
|
Method Summary | |
---|---|
static java.lang.String |
getProgramName()
Returns the program name used to initialize this component. |
static void |
initialize(java.lang.String progName,
PDMessages messages)
Performs initialization needed by the Tivoli Access Manager Administration Java classes. |
static void |
initialize(java.lang.String progName,
java.util.Properties properties,
PDMessages messages)
Performs initialization needed by the Tivoli Access Manager Administration Java classes. |
static boolean |
isInited()
Indicates whether this component has been initialized or not. |
static void |
shutdown(PDMessages messages)
Performs shut down needed by the Tivoli Access Manager Administration Java classes. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static com.tivoli.pd.jras.pdjlog.PDJTraceLogger trcLog
public static com.tivoli.pd.jras.pdjlog.PDJMessageLogger msgLog
public static final java.lang.String PDADMIN_PDJLOGCFG_PROPERTY
public static final java.lang.String AZN_RESULTS_ATTR
public static final java.lang.String AZN_PLUGINSTAT_ATTR
Method Detail |
public static void initialize(java.lang.String progName, java.util.Properties properties, PDMessages messages) throws PDException
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.
progName
- the program name that will appear in trace and
message logs for the Tivoli Access Manager
Administration Java classes.properties
- a Properties object that contains key/value pairs
used for initialization operations. Supported keys are
PDADMIN_*_PROPERTY constants defined in this class.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input; might contain zero or more
informational or warning messages on output.PDException
- if the component cannot be initialized properly.
In exception cases, the component is not initialized and the reference
count is not incremented; therefore shut down should not be called.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static void initialize(java.lang.String progName, PDMessages messages) throws PDException
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.
progName
- the program name that will appear in trace and
message logs for the Tivoli Access Manager
Administration Java classes.messages
- in/out parameter;
empty PDMessages on input; might contain zero or more
informational or warning messages on output.PDException
- if the component cannot be initialized properly.
In exception cases, the component is not initialized and the reference
count is not incremented; therefore shut down should not be called.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static void shutdown(PDMessages messages) throws PDException
This method requires the
javax.security.auth.AuthPermission("PDAdmin")
permission.
messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.PDException
- if the component cannot be shut down properly.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static boolean isInited()
initialize
method can be called multiple times,
but only the first invocation will actually cause intialization
operations to take place.
All callers of initialize
must call shutdown
so that the necessary cleanup
can take place.
public static java.lang.String getProgramName()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |