com.tivoli.pd.jcfg
Class SvrSslCfg
java.lang.Object
|
+--com.tivoli.pd.jcfg.SvrSslCfg
- public final class SvrSslCfg
- extends java.lang.Object
This program configures, unconfigures and modifies the configuration
information of a Tivoli Access Manager Java application server.
A successful configuration run of this program creates user account and
server entries in the Tivoli Access Manager user registry. Locally, the
output of a successful configuration run is a configuration file and a Java
keystore file that securely stores a client certificate. The certificate
allows callers to make authenticated use of Tivoli Access Manager services.
Once a configuration file has been created, the contents can be modified
by various options within this program. The information in the
configuration file is used at runtime by the Java application server.
A successful unconfiguration run of this program removes the user and
server entries from the Tivoli Access Manager user registry and cleans up
the local configuration and keystore files. The unconfigure operation is
designed to fail only in the event that the policy server is unreachable or
the caller is unauthorized to perform the steps needed for unconfiguration.
Other errors encountered during unconfiguration are ignored so that all
necessary unconfiguration steps are attempted.
Method Summary |
static void |
main(java.lang.String[] argv)
Each invocation of the SvrSslCfg program requires an action to be
specified with the -action flag. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SvrSslCfg
public SvrSslCfg()
main
public static void main(java.lang.String[] argv)
throws PDException
- Each invocation of the SvrSslCfg program requires an action to be
specified with the
-action
flag. The following actions
are supported:
- config - Configure an application server. This creates
user and server information in the Tivoli Access Manager user registry
and creates local configuration and keystore files.
- unconfig - Unconfigure an application server. This removes
the user and server information in the Tivoli Access Manager user
registry that was created during configuration, removes the local
keystore file and removes all information added to the local
configuration file during configuration. The configuration file is not
removed entirely. This operation is designed to fail only in
the event that the caller is unauthorized to perform the steps needed
for unconfiguration or if the policy server cannot be contacted. Other
errors encountered during unconfiguration are ignored so that all
necessary unconfiguration steps are attempted. This allows
unconfiguration to succeed when an application server's user registry
information or local configuration information has been deleted by
mistake.
- replcert - Replace an application server's client
certificate. The new certificate replaces the existing certificate
in the application server's keystore file.
- addsvr - Add policy server or authorization server
information to the application server's configuration file.
- rmsvr - Remove policy server or authorization server
information from the application server's configuration file.
- chgsvr - Change policy server or authorization server
information in the application server's configuration file.
- setport - Set the port on which the application server
listens. This update is made only to the application server's
configuration file.
- setdblisten - Set whether or not the application server
listens for policy database update notifications. This update is made
only to the application server's configuration file. (For local-mode
application servers only.)
- setdbdir - Set the directory in which the application server
stores a local copy of the policy database. This update is made only
to the application server's configuration file. (For local-mode
application servers only.)
- setdbref - Set the interval at which the application server
refreshes its local copy of the policy database. This update is made
only to the application server's configuration file. (For local-mode
application servers only.)
Each action requires its own set of input parameters as described
by the flags below:
- config
- admin_id - A Tivoli Access Manager user with administrative
privileges. Required.
- admin_pwd - The administrative user's password. Required.
- appsvr_id - The application server's name. Required.
- port - The TCP/IP port on which the application server will
listen for communications from the policy server(s). Required.
- mode - The mode in which the application server will process
requests. Must be either
local
or remote
.
Required.
- policysvr - The Tivoli Access Manager policy servers with which the
application server will communicate. The format is
host:port:rank,host1:port1:rank1,... where rank denotes priority.
Required.
- authzsvr - The Tivoli Access Manager authorization servers with
which the application server will communicate. The format is
host:port:rank,host1:port1:rank1,... where rank denotes priority.
Required.
- cfg_file - A fully qualified filename that will contain
configuration data for the application server. Required.
- key_file - A fully qualified filename that will contain
the application servers's certificate and keystore. Required.
- appsvr_pwd - The password for the application server's user
account. Optional; the default is an autogenerated password.
- host - The host on which the application server will run.
Optional; the default is the local host.
- dblisten - Whether or not the application server will listen for
local policy database updates. Must be one of
true
or
false
. Optional; the default is false
.
This parameter is ignored if the mode parameter is remote
.
- dbdir - A valid directory in which the local policy database will
be stored. Optional; the default is the directory of the specified key
file. This parameter is ignored if the mode parameter is
remote
.
- dbrefresh - The frequency, in seconds, that an application server
operating in local mode will poll for policy database updates.
Optional, and the value must be greater than or equal to zero; the
default is 7200 seconds. This parameter is ignored if the mode parameter
is
remote
.
- cfg_action - The action to take when creating the configuration
and keystore files. Optional, and the value must be either
create
or replace
; the default is
replace
.
- unconfig
- admin_id - A Tivoli Access Manager user with administrative
privileges. Required.
- admin_pwd - The administrative user's password. Required.
- appsvr_id - The application server's name. Required.
- policysvr - The Tivoli Access Manager policy servers with which the
application server will communicate. The format is
host:port:rank,host1:port1:rank1,... where rank denotes priority.
Required.
- cfg_file - A fully qualified filename that contains
configuration data for the application server. If the application
server's configuration file has been corrupted or deleted, a
temporary file may be specified. Required.
- host - The host on which the application server runs.
Optional; the default is the local host.
- replcert
- admin_pwd - The administrative user's password. Required.
- appsvr_id - The application server's name. Required.
- cfg_file - A fully qualified filename that contains configuration
data for the application server. Required.
- addsvr
- policysvr - A Tivoli Access Manager policy server.
The format is host:port:rank where rank denotes priority.
Only one of -policysvr and -authzsvr must be specified.
- authzsvr - A Tivoli Access Manager authorization server.
The format is host:port:rank where rank denotes priority.
Only one of -policysvr and -authzsvr must be specified.
- cfg_file - A fully qualified filename that contains configuration
data for the application server. Required.
- rmsvr
- policysvr - A Tivoli Access Manager policy server.
The format is host:port:rank where rank denotes priority.
Only one of -policysvr and -authzsvr must be specified.
- authzsvr - A Tivoli Access Manager authorization server.
The format is host:port:rank where rank denotes priority.
Only one of -policysvr and -authzsvr must be specified.
- cfg_file - A fully qualified filename that contains configuration
data for the application server. Required.
- chgsvr
- policysvr - A Tivoli Access Manager policy server.
The format is host:port:rank where rank denotes priority.
Only one of -policysvr and -authzsvr must be specified.
- authzsvr - A Tivoli Access Manager authorization server.
The format is host:port:rank where rank denotes priority.
Only one of -policysvr and -authzsvr must be specified.
- cfg_file - A fully qualified filename that contains configuration
data for the application server. Required.
- setport
- port - The TCP/IP port on which the application server will
listen for communications from the policy server(s). Required.
- cfg_file - A fully qualified filename that contains configuration
data for the application server. Required.
- setdblisten
- dblisten - Whether or not the application server will listen for
local policy database updates. Must be one of
true
or
false
. Required.
- cfg_file - A fully qualified filename that contains configuration
data for the application server. Required.
- setdbdir
- dbdir - A valid directory in which the local policy database will
be stored. Required.
- cfg_file - A fully qualified filename that contains configuration
data for the application server. Required.
- setdbref
- dbrefresh - The frequency, in seconds, that an application server
operating in local mode will poll for policy database updates.
Must be greater than or equal to zero. Required.
- cfg_file - A fully qualified filename that contains configuration
data for the application server. Required.