|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.ibm.cics.core.comm.ConnectionConfiguration
public class ConnectionConfiguration
Configuration data to be assigned to an IConnection. The information in this configuration
should be considered connection-specific, and should define all of the parameters required to establish
a connection successfully. Some attributes such as host and port are defined explicitly, and can be set
using the supplied setter methods: #setHost(), #setPort(). Further non-generic attributes can be
specified by using the setExtendedAttribute(String, String) in conjunction with a predefined key,
which an implementation of IConnection can use to retrieve the value by invoking getExtendedAttribute(String).
| Constructor Summary | |
|---|---|
ConnectionConfiguration(ConnectionConfiguration other)
Create a duplicate of an existing connection configuration with a new ID. |
|
ConnectionConfiguration(java.lang.String newID,
ConnectionConfiguration other)
Create a duplicate of an existing connection configuration with a new ID. |
|
ConnectionConfiguration(java.lang.String name,
java.lang.String host,
int port,
java.lang.String credentialsID)
Deprecated. This constructor does not supply a unique ID for the configuration. Use ConnectionConfiguration(String, String, String, int, String, boolean) |
|
ConnectionConfiguration(java.lang.String name,
java.lang.String host,
int port,
java.lang.String userID,
java.lang.String password)
Deprecated. This constructor does not supply a unique ID for the configuration. Use ConnectionConfiguration(String, String, String, int, String, boolean) |
|
ConnectionConfiguration(java.lang.String name,
java.lang.String host,
int port,
java.lang.String userID,
java.lang.String password,
boolean secureHint)
Deprecated. This constructor does not supply a unique ID for the configuration. Use ConnectionConfiguration(String, String, String, int, String, boolean, boolean) |
|
ConnectionConfiguration(java.lang.String id,
java.lang.String name,
java.lang.String host,
int port,
java.lang.String credentialsID)
Construct a new ConnectionConfiguration using the supplied parameters. |
|
ConnectionConfiguration(java.lang.String id,
java.lang.String name,
java.lang.String host,
int port,
java.lang.String credentialsID,
boolean secureHint)
Construct a new ConnectionConfiguration using the supplied parameters. |
|
ConnectionConfiguration(java.lang.String id,
java.lang.String name,
java.lang.String host,
int port,
java.lang.String credentialsID,
boolean secureHint,
boolean confirmedSecurity)
Construct a new ConnectionConfiguration using the supplied parameters. |
|
| Method Summary | |
|---|---|
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
getCredentialsID()
Getter for credentials ID |
java.lang.String |
getExtendedAttribute(java.lang.String key)
Get the value of a specific extended attribute |
java.util.Set<java.lang.String> |
getExtendedKeys()
Get a Set of keys representing extended attributes that are available for this connection configuration. |
java.lang.String |
getHost()
Getter for host |
java.lang.String |
getID()
Getter for ID |
java.lang.String |
getName()
Getter for name |
java.lang.String |
getPassword()
Getter for password |
int |
getPort()
Getter for port |
boolean |
getSecureHint()
Getter for the secure hint |
java.lang.String |
getUserID()
Getter for user ID |
int |
hashCode()
|
boolean |
isSSLConfirmed()
Getter for SSL Confirmation |
void |
setCredentialsID(java.lang.String credentialsID)
Setter for credentials ID |
void |
setExtendedAttribute(java.lang.String key,
java.lang.String value)
Set the value of a specific extended attribute. |
void |
setHost(java.lang.String host)
Setter for host |
void |
setName(java.lang.String name)
Setter for name |
void |
setPassword(java.lang.String password)
Setter for password |
void |
setPort(int port)
Setter for port |
void |
setSecureHint(boolean hint)
Setter for the secure hint |
void |
setSslConfirmation(boolean sslConfirmation)
Setter for SSL Confirmation |
void |
setUserID(java.lang.String userID)
Setter for user ID |
boolean |
staticallyEquals(ConnectionConfiguration other)
Deprecated. connections are not anticipated to change any fields of a connection configuration, so it should be possible to use the regular equals(Object) method to determine
connection configuration equality. |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
@Deprecated
public ConnectionConfiguration(java.lang.String name,
java.lang.String host,
int port,
java.lang.String userID,
java.lang.String password)
ConnectionConfiguration(String, String, String, int, String, boolean)
name - the name of the configurationhost - the host name to connect toport - the port to useuserID - the user ID to authenticatepassword - a password to authenticate with
public ConnectionConfiguration(java.lang.String name,
java.lang.String host,
int port,
java.lang.String userID,
java.lang.String password,
boolean secureHint)
ConnectionConfiguration(String, String, String, int, String, boolean, boolean)
name - the name of the configurationhost - the host name to connect toport - the port to useuserID - the user ID to authenticate aspassword - a password to authenticate withsecureHint - whether or not a secure connection should be established
@Deprecated
public ConnectionConfiguration(java.lang.String name,
java.lang.String host,
int port,
java.lang.String credentialsID)
ConnectionConfiguration(String, String, String, int, String, boolean)
name - the name of the configurationhost - the host name to connect toport - the port to usecredentialsID - the ID of the associated credentials
public ConnectionConfiguration(java.lang.String id,
java.lang.String name,
java.lang.String host,
int port,
java.lang.String credentialsID)
id - the unique ID of this configurationname - the name of the configurationhost - the host name to connect toport - the port to usecredentialsID - the ID of the associated credentials
public ConnectionConfiguration(java.lang.String id,
java.lang.String name,
java.lang.String host,
int port,
java.lang.String credentialsID,
boolean secureHint)
id - the unique ID of this configurationname - the name of the configurationhost - the host name to connect toport - the port to usecredentialsID - the ID of the associated credentialssecureHint - whether or not a secure connection should be established
public ConnectionConfiguration(java.lang.String newID,
ConnectionConfiguration other)
newID - the new ID to useother - the connection configuration to copy.public ConnectionConfiguration(ConnectionConfiguration other)
ConnectionConfiguration(String, ConnectionConfiguration)
to copy an existing connection configuration whilst specifying a new ID.
public ConnectionConfiguration(java.lang.String id,
java.lang.String name,
java.lang.String host,
int port,
java.lang.String credentialsID,
boolean secureHint,
boolean confirmedSecurity)
id - the unique ID of this configurationname - the name of the configurationhost - the host name to connect toport - the port to usecredentialsID - the ID of the associated credentialssecureHint - whether or not a secure connection should be establishedconfirmedSecurity - whether the setting of the secure hint has been verified as accurate| Method Detail |
|---|
public java.lang.String getName()
public void setName(java.lang.String name)
name - the new name to usepublic java.lang.String getHost()
public void setHost(java.lang.String host)
host - host to connect topublic int getPort()
public void setPort(int port)
port - port to connect usingpublic java.lang.String getCredentialsID()
public void setCredentialsID(java.lang.String credentialsID)
credentialsID - ID of the credentials in use by this connection configuration.public java.lang.String getUserID()
public void setUserID(java.lang.String userID)
userID - the user ID to authenticate aspublic java.lang.String getPassword()
public void setPassword(java.lang.String password)
password - the password to authenticate usingpublic java.lang.String toString()
toString in class java.lang.Objectpublic java.util.Set<java.lang.String> getExtendedKeys()
Set of keys representing extended attributes that are available for this connection configuration.
public boolean equals(java.lang.Object obj)
equals in class java.lang.Object@Deprecated public boolean staticallyEquals(ConnectionConfiguration other)
equals(Object) method to determine
connection configuration equality.
public int hashCode()
hashCode in class java.lang.Objectpublic boolean getSecureHint()
public void setSecureHint(boolean hint)
hint - whether or not a secure connection should be attemptedpublic java.lang.String getExtendedAttribute(java.lang.String key)
key - the key of an extended attribute
null if the supplied key does not exist on this connection configuration.
public void setExtendedAttribute(java.lang.String key,
java.lang.String value)
key - key to set a value forvalue - value to setpublic java.lang.String getID()
public boolean isSSLConfirmed()
public void setSslConfirmation(boolean sslConfirmation)
sslConfirmation - whether or not the security setting for this connection configuration has been verified as accurate.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||