|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.tivoli.pd.jadmin.PDAppSvrSpec
This abstract class encapsulates the basic information needed to configure a Java application server that executes Tivoli Access Manager administration Java APIs or authorization Java APIs. A subclass of PDAppSvrSpec can be used to specify configuration and operating information for a local-mode or remote-mode Java application server.
PDAppSvrSpecLocal
,
PDAppSvrSpecRemote
Method Summary | |
---|---|
java.util.ArrayList |
getAuthzServers()
Returns the list of authorization servers from this specification. |
java.lang.String |
getConfigName()
Returns the application server configuration name from this specification. |
java.lang.String |
getDescription()
Returns the application server description from this specification. |
java.util.ArrayList |
getGroups()
Returns the list of groups the application server should be made a member of from this specification. |
java.lang.String |
getHost()
Returns the application server host from this specification. |
char[] |
getPassword()
Returns the application server password from this specification. |
java.util.ArrayList |
getPlcyServers()
Returns the list of policy servers from this specification. |
int |
getPort()
Returns the application server port from this specification. |
void |
setAuthzServers(java.util.ArrayList authzServers,
PDMessages messages)
Sets the list of authorization servers that the application server will be able to communicate with in this specification object. |
void |
setConfigName(java.lang.String configName,
PDMessages messages)
Sets the application server configuration name in this specification object. |
void |
setDescription(java.lang.String description,
PDMessages messages)
Sets the application server description in this specification object. |
void |
setGroups(java.util.ArrayList groups,
PDMessages messages)
Sets the list of groups the application server should be made a member of in this specification object. |
void |
setHost(java.lang.String host,
PDMessages messages)
Sets the application server host in this specification object. |
void |
setPassword(char[] password,
PDMessages messages)
Sets the application server password in this specification object. |
void |
setPlcyServers(java.util.ArrayList plcyServers,
PDMessages messages)
Sets the list of policy servers that the application server will be able to communicate with in this specification object. |
void |
setPort(int port,
PDMessages messages)
Sets the application server port in this specification object. |
java.lang.String |
toString()
Returns a String representation of this object. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public java.lang.String getConfigName() throws PDException
public java.lang.String getDescription() throws PDException
public char[] getPassword() throws PDException
public java.util.ArrayList getGroups() throws PDException
public java.lang.String getHost() throws PDException
public int getPort() throws PDException
public java.util.ArrayList getPlcyServers() throws PDException
public java.util.ArrayList getAuthzServers() throws PDException
public void setConfigName(java.lang.String configName, PDMessages messages) throws PDException
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.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 setDescription(java.lang.String description, PDMessages messages) throws PDException
description
- a description for the application server.
Cannot be null but can be empty to clear an existing
description in the specification.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 setPassword(char[] password, PDMessages messages) throws PDException
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.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 setGroups(java.util.ArrayList groups, PDMessages messages) throws PDException
groups
- an ArrayList of Strings that are the names of the
groups the application server should be made a member of.
Cannot be null but can be empty to clear the existing group
list in the specification.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 setHost(java.lang.String host, PDMessages messages) throws PDException
host
- the host on which the application server will run.
Cannot be null or empty.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 setPort(int port, PDMessages messages) throws PDException
port
- the TCP/IP port on which the application server will
listen for communications from the policy server(s). Must
be greater than zero.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 setPlcyServers(java.util.ArrayList plcyServers, PDMessages messages) throws PDException
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.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 setAuthzServers(java.util.ArrayList authzServers, PDMessages messages) throws PDException
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.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 java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |