|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.tivoli.pd.jadmin.PDAppSvrSpec | +--com.tivoli.pd.jadmin.PDAppSvrSpecLocal
This class specifies the information needed to configure a Java application server that executes Tivoli Access Manager administration Java APIs or authorization Java APIs locally whenever possible. Local operations have better performance than remote operations.
Local API processing requires that a copy of the policy database be stored locally and periodically synchronized with the master copy, thus disk and data security requirements must be taken into consideration when configuring a local mode application server. In addition, not all Java APIs can be performed locally; some operations, such as those that make database updates or access the user registry, require access to remote policy and/or authorization servers.
NOTE: In this release, local mode Tivoli Access Manager administration Java APIs are not supported. Local mode support for Java administration APIs may be available in a future release.
Constructor Summary | |
---|---|
PDAppSvrSpecLocal(java.lang.String configName,
java.lang.String description,
char[] password,
java.util.ArrayList groups,
java.lang.String host,
int port,
java.util.ArrayList plcyServers,
java.util.ArrayList authzServers,
boolean listen,
int dbRefresh,
java.net.URL dbdirURL,
java.util.Locale locale,
PDMessages messages)
Specifies data necessary to configure a Java application server that will use the Tivoli Access Manager administration Java APIs or authorization Java APIs in local mode. |
Method Summary | |
---|---|
java.net.URL |
getDbdirURL()
Returns the location of the policy database directory from this specification. |
int |
getDbRefresh()
Returns the policy database refresh interval, in seconds, from this specification. |
boolean |
isListening()
Returns whether or not the application server listens for policy database updates from this specification. |
void |
setDbdirURL(java.net.URL dbdirURL,
PDMessages messages)
Sets the directory location for the local policy database in this specification object. |
void |
setDbRefresh(int dbRefresh,
PDMessages messages)
Sets the frequency, in seconds, with which the application server polls the policy database for updates in this specification object. |
void |
setIsListening(boolean listen,
PDMessages messages)
Sets whether or not the application server should listen for policy database upate notifications in this specification object. |
Methods inherited from class com.tivoli.pd.jadmin.PDAppSvrSpec |
---|
getAuthzServers, getConfigName, getDescription, getGroups, getHost, getPassword, getPlcyServers, getPort, setAuthzServers, setConfigName, setDescription, setGroups, setHost, setPassword, setPlcyServers, setPort, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public PDAppSvrSpecLocal(java.lang.String configName, java.lang.String description, char[] password, java.util.ArrayList groups, java.lang.String host, int port, java.util.ArrayList plcyServers, java.util.ArrayList authzServers, boolean listen, int dbRefresh, java.net.URL dbdirURL, java.util.Locale locale, PDMessages messages) throws PDException
This application server specification object can be used in the PDAppSvrConfig.configureAppSvr method.
configName
- the name of the application server. The name of the
user and server entities created in the user registry and the Tivoli
Access Manager policy database are constructed from this name and the
host argument. Cannot be null or empty.description
- a description for the application server. Can be
null or empty.password
- the application server's password. If this argument
is null or empty, a random password is generated during
configuration. Otherwise, the password must adhere to the
password policy in effect.groups
- an ArrayList of Strings that are the names of the
groups the application server should be made a member of.
Can be null or empty.host
- the host on which the application server will run.
Cannot be null or empty.port
- the TCP/IP port on which the application server will
listen for communications from the policy server(s). Must
be greater than zero.plcyServers
- a list of PDSvrInfo objects representing
the Tivoli Access Manager policy servers with which the application
server can communicate. At least one policy server must be listed.authzServers
- a list of PDSvrInfo objects representing
the Tivoli Access Manager authorization servers with which the
application server can communicate. At least one
authorization server must be listed.listen
- if true, indicates that the application server
will listen for database update notifications from the policy
server. If false, indicates that the application server will not
listen.dbRefresh
- the frequency, in seconds, that the application
server polls the policy database for updates. The application server's
local cache is rebuilt only if an update is detected.
If a value less than or equal to zero is specified, polling for policy
database updates is disabled.dbdirURL
- the URL for the directory in which the local policy
database will be stored. This URL
cannot be null, it must use the file:
protocol and the path
specified by this URL must be a valid directory on the system.locale
- the locale into which any generated error
or warning messages are translated. May not be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output. Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.Method Detail |
public boolean isListening() throws PDException
public int getDbRefresh() throws PDException
public java.net.URL getDbdirURL() throws PDException
public void setIsListening(boolean listen, PDMessages messages) throws PDException
listen
- if true, indicates that the application server
will listen for database update notifications from the policy
server. If false, indicates that the application server will not
listen.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output. The messages will be
translated into the locale used when this
specification object was instantiated.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public void setDbRefresh(int dbRefresh, PDMessages messages) throws PDException
dbRefresh
- the frequency, in seconds, that the application
server polls the policy database for updates. The application server's
local cache is rebuilt only if an update is detected.
If a value less than or equal to zero is specified, polling for policy
database updates is disabled.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output. The messages will be
translated into the locale used when this
specification object was instantiated.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public void setDbdirURL(java.net.URL dbdirURL, PDMessages messages) throws PDException
dbdirURL
- the URL for the directory in which the local policy
database will be stored. This URL
cannot be null, it must use the file:
protocol and the path
specified by this URL must be a valid directory on the system.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output. The messages will be
translated into the locale used when this
specification object was instantiated.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |