com.metamatrix.console.connections
Class ConnectionInfo

java.lang.Object
  extended by com.metamatrix.console.connections.ConnectionInfo

public class ConnectionInfo
extends java.lang.Object


Constructor Summary
ConnectionInfo(java.lang.String serverURL, java.lang.String user, char[] password, java.lang.String applicationName)
           
 
Method Summary
 void close()
          Close the underlying connection.
 boolean equals(java.lang.Object obj)
           
 java.lang.String getApplicationName()
           
 java.lang.String getClusterName()
           
 java.lang.String getHost()
           
 java.util.List getHosts()
           
 char[] getPassword()
           
 java.lang.String getPort()
           
 java.util.List getPorts()
           
 ServerAdmin getServerAdmin()
          Get a ServerAdmin object.
 ServerConnection getServerConnection()
          Get an adminAPIConnection.
 ServerConnection getServerConnection(boolean create)
          Get a ServerIConnection.
 MetaMatrixSessionID getSessionID()
           
 java.lang.String getURL()
           
 java.lang.String getUser()
           
 int hashCode()
           
 boolean isConnectedHost(java.lang.String hostName)
           
 boolean isConnectedHost(java.lang.String hostName, java.lang.String port)
           
 ServerConnection login()
          Create a new ServerConnection.
 ServerConnection relogin()
           
 void setApplicationName(java.lang.String applicationName)
           
 void setPassword(char[] password)
           
 void setUser(java.lang.String user)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConnectionInfo

public ConnectionInfo(java.lang.String serverURL,
                      java.lang.String user,
                      char[] password,
                      java.lang.String applicationName)
Method Detail

setUser

public void setUser(java.lang.String user)

getUser

public java.lang.String getUser()

getURL

public java.lang.String getURL()

getHost

public java.lang.String getHost()

getHosts

public java.util.List getHosts()

getPort

public java.lang.String getPort()

getPorts

public java.util.List getPorts()

getPassword

public char[] getPassword()

getApplicationName

public java.lang.String getApplicationName()

setApplicationName

public void setApplicationName(java.lang.String applicationName)

setPassword

public void setPassword(char[] password)

isConnectedHost

public boolean isConnectedHost(java.lang.String hostName)

isConnectedHost

public boolean isConnectedHost(java.lang.String hostName,
                               java.lang.String port)

getClusterName

public java.lang.String getClusterName()

getServerConnection

public ServerConnection getServerConnection(boolean create)
Get a ServerIConnection.

Parameters:
create - If true, create the connection if it doesn't already exist.
Returns:
Since:
4.3

getSessionID

public MetaMatrixSessionID getSessionID()

getServerConnection

public ServerConnection getServerConnection()
Get an adminAPIConnection. Create it if it doesn't already exist.

Returns:
Since:
4.3

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

login

public ServerConnection login()
                       throws ConnectionException,
                              CommunicationException,
                              LogonException
Create a new ServerConnection.

Returns:
Throws:
ConnectionException - if login failed.
CommunicationException - if the server was unreachable.
LogonException
Since:
4.3

relogin

public ServerConnection relogin()
                         throws MetaMatrixComponentException
Throws:
MetaMatrixComponentException

close

public void close()
Close the underlying connection.

Since:
4.3

getServerAdmin

public ServerAdmin getServerAdmin()
                           throws AdminException,
                                  LogonException,
                                  CommunicationException
Get a ServerAdmin object. Make sure to call ServerAdmin.close() when you're done with it. TODO: cache this? Need to make sure it gets closed when the console exits.

Throws:
CommunicationException
AdminException
LogonException


Copyright © 2009. All Rights Reserved.