Remote Systems
v6.4.1

com.ibm.etools.systems.model
Interface SystemConnectionPool

All Known Implementing Classes:
SystemConnectionPoolImpl

public interface SystemConnectionPool


Field Summary
static String copyright
           
 
Method Summary
 boolean addConnection(SystemConnection conn)
          Add a new connection to the list.
 SystemConnection cloneConnection(SystemConnectionPool targetPool, SystemConnection conn, String aliasName)
          Duplicates a given connection in this list within this list or another list.
 SystemConnection createConnection(String systemType, String aliasName, String hostName)
          Create a connection.
 SystemConnection createConnection(String systemType, String aliasName, String hostName, String description)
          Create a connection.
 SystemConnection createConnection(String systemType, String aliasName, String hostName, String description, String defaultUserId, int defaultUserIdLocation)
          Create a connection.
 void deleteConnection(SystemConnection conn)
          Removes a given connection from the list and deletes it from disk.
 SystemConnection getConnection(int pos)
          Return the connection at the given zero-based offset
 SystemConnection getConnection(String aliasName)
          Return a connection given its name.
 int getConnectionCount()
          Return the number of SystemConnection objects within this pool.
 int getConnectionPosition(SystemConnection conn)
          Return the zero-based position of a SystemConnection object within its profile.
 EList getConnections()
           
 String getName()
           
 SystemConnection[] getSystemConnections()
          Return array of connections in this pool
 SystemProfile getSystemProfile()
          Return the system profile that owns this connection pool
 void moveConnections(SystemConnection[] conns, int delta)
          Move existing connections a given number of positions in the same pool.
 void orderConnections(String[] names)
          Order connections according to user preferences.
 void renameConnection(SystemConnection conn, String newName)
          Renames a given connection in the list.
 void renameConnectionPool(String newName)
          Rename this connection pool.
 void save()
           
 void save(SystemConnection connection)
           
 void setName(String value)
           
 void updateConnection(SystemConnection conn, String systemType, String aliasName, String hostName, String description, String defaultUserId, int defaultUserIdLocation)
          Update an existing connection given the new information.
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

getSystemProfile

public SystemProfile getSystemProfile()
Return the system profile that owns this connection pool


renameConnectionPool

public void renameConnectionPool(String newName)
Rename this connection pool.


getSystemConnections

public SystemConnection[] getSystemConnections()
Return array of connections in this pool


createConnection

public SystemConnection createConnection(String systemType,
                                         String aliasName,
                                         String hostName)
                                  throws Exception
Create a connection.

Throws:
Exception

createConnection

public SystemConnection createConnection(String systemType,
                                         String aliasName,
                                         String hostName,
                                         String description)
                                  throws Exception
Create a connection.

Throws:
Exception

createConnection

public SystemConnection createConnection(String systemType,
                                         String aliasName,
                                         String hostName,
                                         String description,
                                         String defaultUserId,
                                         int defaultUserIdLocation)
                                  throws Exception
Create a connection.

Throws:
Exception

updateConnection

public void updateConnection(SystemConnection conn,
                             String systemType,
                             String aliasName,
                             String hostName,
                             String description,
                             String defaultUserId,
                             int defaultUserIdLocation)
                      throws Exception
Update an existing connection given the new information. This method:

Parameters:
conn - SystemConnection to be updated
systemType - system type matching one of the system type names defined via the systemtype extension point.
aliasName - unique connection name.
hostName - ip name of host.
description - optional description of the connection. Can be null.
defaultUserId - userId to use as the default for the subsystems.
defaultUserIdLocation - where to set the given default user Id. See ISystemUserIdConstants
Throws:
Exception

getConnection

public SystemConnection getConnection(String aliasName)
Return a connection given its name.


getConnection

public SystemConnection getConnection(int pos)
Return the connection at the given zero-based offset


addConnection

public boolean addConnection(SystemConnection conn)
Add a new connection to the list.


deleteConnection

public void deleteConnection(SystemConnection conn)
Removes a given connection from the list and deletes it from disk.

This will:

Parameters:
conn - SystemConnection object to remove

renameConnection

public void renameConnection(SystemConnection conn,
                             String newName)
                      throws Exception
Renames a given connection in the list. This will:

Parameters:
conn - SystemConnection object to rename
newName - The new name to give that connection.
Throws:
Exception

getConnectionPosition

public int getConnectionPosition(SystemConnection conn)
Return the zero-based position of a SystemConnection object within its profile.


getConnectionCount

public int getConnectionCount()
Return the number of SystemConnection objects within this pool.


cloneConnection

public SystemConnection cloneConnection(SystemConnectionPool targetPool,
                                        SystemConnection conn,
                                        String aliasName)
                                 throws Exception
Duplicates a given connection in this list within this list or another list.

Parameters:
targetPool - The SystemConnectionPool to hold the copied connection. Can equal this connection, as long as alias name is unique
conn - SystemConnection object (within our pool) to clone
Throws:
Exception

moveConnections

public void moveConnections(SystemConnection[] conns,
                            int delta)
Move existing connections a given number of positions in the same pool. If the delta is negative, they are all moved up by the given amount. If positive, they are all moved down by the given amount.

TODO PROBLEM: CAN'T RE-ORDER FOLDERS SO CAN WE SUPPORT THIS ACTION?

Parameters:
conns - Array of SystemConnections to move.

orderConnections

public void orderConnections(String[] names)
Order connections according to user preferences. Called after restore.


save

public void save()
          throws Exception
Throws:
Exception

save

public void save(SystemConnection connection)
          throws Exception
Throws:
Exception

getName

public String getName()
Returns:
The value of the Name attribute

setName

public void setName(String value)
Parameters:
value - The new value of the Name attribute

getConnections

public EList getConnections()
Returns:
The list of Connections references

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.