com.tivoli.pd.jadmin
Class PDAppSvrSpec

java.lang.Object
  com.tivoli.pd.jadmin.PDAppSvrSpec

Direct Known Subclasses:

PDAppSvrSpecLocal, PDAppSvrSpecRemote

public abstract class PDAppSvrSpec
extends java.lang.Object

This abstract class encapsulates the basic information needed to configure a Java application server that executes Security Access Manager administration APIs for Java or authorization APIs for Java. A subclass of PDAppSvrSpec can be used to specify configuration and operating information for a local-mode or remote-mode Java application server.

Modes: Local,Remote

See Also:

PDAppSvrSpecLocal, PDAppSvrSpecRemote

Method Summary

java.lang.String	cipherSuites() Returns the user specified list of cipher suites.
java.util.ArrayList	getAuthzServers() Returns the list of authorization servers from this specification.
boolean	getCertRefresh() Returns the certRefresh flag 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.
boolean	getldapmgmt()
boolean	getldapsslenable()
java.lang.String	getldapsvrs()
java.net.URL	getldaptruststore()
char[]	getldaptustpwd()
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.
boolean	isSSLv3Enabled() Returns the SSL V3 protocol enable flag from this specification.
boolean	isTLSv10Enabled() Returns the TLS V1.0 protocol enable flag from this specification.
boolean	isTLSv11Enabled() Returns the TLS V1.1 protocol enable flag from this specification.
boolean	isTLSv12Enabled() Returns the TLS V1.2 protocol enable flag 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	setCertRefresh(boolean certRefresh, PDMessages messages) Sets the certRefresh flag 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	setLdapOptions(boolean ldapmgmt, java.lang.String ldapsvrs, boolean ldapsslenable, java.net.URL ldaptruststore, char[] ldaptrustpwd)
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

setLdapOptions

public void setLdapOptions(boolean ldapmgmt,
                           java.lang.String ldapsvrs,
                           boolean ldapsslenable,
                           java.net.URL ldaptruststore,
                           char[] ldaptrustpwd)

getldapmgmt

public boolean getldapmgmt()

getldapsslenable

public boolean getldapsslenable()

getldaptruststore

public java.net.URL getldaptruststore()

getldaptustpwd

public char[] getldaptustpwd()

getldapsvrs

public java.lang.String getldapsvrs()

getConfigName

public java.lang.String getConfigName()
                               throws PDException

Returns the application server configuration name from this specification.

Throws:

PDException

getDescription

public java.lang.String getDescription()
                                throws PDException

Returns the application server description from this specification. If no description has been specified, or the description has been cleared, an empty String is returned.

Throws:

PDException

getPassword

public char[] getPassword()
                   throws PDException

Returns the application server password from this specification. If no password has been specified null is returned.

Throws:

PDException

getGroups

public java.util.ArrayList getGroups()
                              throws PDException

Returns the list of groups the application server should be made a member of from this specification. The objects in the ArrayList are Strings representing group names. If no groups have been specified, an empty ArrayList will be returned.

Throws:

PDException

getHost

public java.lang.String getHost()
                         throws PDException

Returns the application server host from this specification.

Throws:

PDException

getPort

public int getPort()
            throws PDException

Returns the application server port from this specification.

Throws:

PDException

getCertRefresh

public boolean getCertRefresh()
                       throws PDException

Returns the certRefresh flag from this specification.

Throws:

PDException

isSSLv3Enabled

public boolean isSSLv3Enabled()
                       throws PDException

Returns the SSL V3 protocol enable flag from this specification.

Throws:

PDException

isTLSv10Enabled

public boolean isTLSv10Enabled()
                        throws PDException

Returns the TLS V1.0 protocol enable flag from this specification.

Throws:

PDException

isTLSv11Enabled

public boolean isTLSv11Enabled()
                        throws PDException

Returns the TLS V1.1 protocol enable flag from this specification.

Throws:

PDException

isTLSv12Enabled

public boolean isTLSv12Enabled()
                        throws PDException

Returns the TLS V1.2 protocol enable flag from this specification.

Throws:

PDException

cipherSuites

public java.lang.String cipherSuites()
                              throws PDException

Returns the user specified list of cipher suites. These must be comma separated valid cipher suite names.

Returns:

the user specified list of cipher suites, or null if not specified.

Throws:

PDException

getPlcyServers

public java.util.ArrayList getPlcyServers()
                                   throws PDException

Returns the list of policy servers from this specification. The objects in the returned ArrayList are PDSvrInfo objects. The returned list will always have at least one element.

Throws:

PDException

getAuthzServers

public java.util.ArrayList getAuthzServers()
                                    throws PDException

Returns the list of authorization servers from this specification. The objects in the returned ArrayList are PDSvrInfo objects. The returned list will always have at least one element.

Throws:

PDException

setConfigName

public void setConfigName(java.lang.String configName,
                          PDMessages messages)
                   throws PDException

Sets the application server configuration name in this specification object.

Parameters:

configName - the name of the application server. The name of the user and server entities created in the user registry and the Security 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.

Throws:

PDException - if an error occurs. This exception might contain error and message codes defined in the product Error Message Reference document.

setDescription

public void setDescription(java.lang.String description,
                           PDMessages messages)
                    throws PDException

Sets the application server description in this specification object.

Parameters:

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.

Throws:

PDException - if an error occurs. This exception might contain error and message codes defined in the product Error Message Reference document.

setPassword

public void setPassword(char[] password,
                        PDMessages messages)
                 throws PDException

Sets the application server password in this specification object.

Parameters:

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.

Throws:

PDException - if an error occurs. This exception might contain error and message codes defined in the product Error Message Reference document.

setGroups

public void setGroups(java.util.ArrayList groups,
                      PDMessages messages)
               throws PDException

Sets the list of groups the application server should be made a member of in this specification object.

Parameters:

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.

Throws:

PDException - if an error occurs. This exception might contain error and message codes defined in the product Error Message Reference document.

setHost

public void setHost(java.lang.String host,
                    PDMessages messages)
             throws PDException

Sets the application server host in this specification object.

Parameters:

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.

Throws:

PDException - if an error occurs. This exception might contain error and message codes defined in the product Error Message Reference document.

setPort

public void setPort(int port,
                    PDMessages messages)
             throws PDException

Sets the application server port in this specification object.

Parameters:

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.

Throws:

PDException - if an error occurs. This exception might contain error and message codes defined in the product Error Message Reference document.

setCertRefresh

public void setCertRefresh(boolean certRefresh,
                           PDMessages messages)
                    throws PDException

Sets the certRefresh flag in this specification object.

Parameters:

certRefresh - enables or disables the application server's automatic refresh of its keystore certificate before the certificate is due to expire.

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.

Throws:

PDException - if an error occurs. This exception might contain error and message codes defined in the product Error Message Reference document.

setPlcyServers

public void setPlcyServers(java.util.ArrayList plcyServers,
                           PDMessages messages)
                    throws PDException

Sets the list of policy servers that the application server will be able to communicate with in this specification object.

Parameters:

plcyServers - a list of PDSvrInfo objects representing the Security 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.

Throws:

PDException - if an error occurs. This exception might contain error and message codes defined in the product Error Message Reference document.

setAuthzServers

public void setAuthzServers(java.util.ArrayList authzServers,
                            PDMessages messages)
                     throws PDException

Sets the list of authorization servers that the application server will be able to communicate with in this specification object.

Parameters:

authzServers - a list of PDSvrInfo objects representing the Security 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.

Throws:

PDException - if an error occurs. This exception might contain error and message codes defined in the product Error Message Reference document.

toString

public java.lang.String toString()

Returns a String representation of this object.

Overrides:

toString in class java.lang.Object