|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.pd.jadmin.PDSvrInfo
This class encapsulates the location (host name and port number) and preference ranking of a Tivoli Access Manager server entry in an application server's configuration file. An instance of this class can represent either a policy server or an authorization server.
Modes: Local,Remote
Constructor Summary | |
---|---|
PDSvrInfo(java.lang.String host,
int port,
int rank,
java.util.Locale locale,
PDMessages messages)
Construct a PDSvrInfo with the input host, port number and rank. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Returns a copy of this object. |
boolean |
equals(java.lang.Object obj)
Determines whether this PDSvrInfo is equivalent to the input object. |
java.lang.String |
getHost()
Returns the name of the host that this Tivoli Access Manager server runs on. |
int |
getPort()
Returns the TCP/IP port that this Tivoli Access Manager server communicates on. |
int |
getRank()
Returns the preference rank assigned to this Tivoli Access Manager server. |
void |
setHost(java.lang.String host,
PDMessages messages)
Sets the name of the host that this Tivoli Access Manager server runs on. |
void |
setPort(int port,
PDMessages messages)
Sets the TCP/IP port that this Tivoli Access Manager server communicates on. |
void |
setRank(int rank,
PDMessages messages)
Sets the preference rank of this Tivoli Access Manager server. |
java.lang.String |
toString()
Returns a String representation of this object. |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public PDSvrInfo(java.lang.String host, int port, int rank, java.util.Locale locale, PDMessages messages) throws PDException
host
- the host name of the machine on which the
Tivoli Access Manager server is running. This should be a
fully-qualified Domain Name Service (DNS) host name. Cannot be null
or empty.port
- the TCP/IP port on which the Access Manager server is
listening. Must be greater than 0.rank
- the rank of the server with respect to other servers of
its type in a configuration file. Servers are ranked in ascending order,
so that a server with rank 1 has a higher preference than a server with
rank 2. Must be a positive number.locale
- the locale into which any generated error
or warning messages are translated. Cannot 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 java.lang.String getHost() throws PDException
PDException
public int getPort() throws PDException
PDException
public int getRank() throws PDException
PDException
public void setHost(java.lang.String host, PDMessages messages) throws PDException
host
- the host name of the machine on which the
Tivoli Access Manager server is running. This should be a
fully-qualified Domain Name Service (DNS) host name. 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
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 Tivoli Access Manager server is
listening. Must be greater than 0.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
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 setRank(int rank, PDMessages messages) throws PDException
rank
- the rank of the server with respect to other servers of
its type in a configuration file. Servers are ranked in ascending order,
so that a server with rank 1 has a higher preference than a server with
rank 2. Must be a positive number.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
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 boolean equals(java.lang.Object obj)
public java.lang.Object clone()
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |