com.ibm.cics.core.connections
Interface IConnectionManager


public interface IConnectionManager

A service that provides a repository for all ConnectionProfiles defined to the connections framework. Enquires all registered IConnectionProviders and uses the association data provided by an IConnectionCredentialsManager to convert sets of ConnectionParameters into ConnectionProfile objects, containing all of the information required to establish a connection.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void addListener(ConnectionManagerListener listener)
          Adds a ConnectionManagerListener to this connection manager.
 ConnectionProfile getConnectionProfile(java.lang.String id)
          Returns a ConnectionProfile identified by the supplied id
 java.util.List<ConnectionProfile> getConnectionProfiles()
          Returns a List of all ConnectionProfiles known to the connections framework.
 java.util.List<ConnectionProfile> getConnectionProfiles(java.lang.String connectionTypeId)
          Returns a List of all ConnectionProfiles for a given connection type id known to the connections framework.
 java.util.Map<IConnectionDescriptor,java.util.List<ConnectionProfile>> getConnectionProfilesByDescriptor()
          Returns a Map of all ConnectionProfiles, indexed by IConnectionDescriptor.
 ICredentialsManager getCredentialsManager()
          Deprecated. replaced by ConnectionsPlugin.getCredentialsManager()
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getCredentialsManager

@Deprecated
ICredentialsManager getCredentialsManager()
Deprecated. replaced by ConnectionsPlugin.getCredentialsManager()

Returns:
the ICredentialsManager

getConnectionProfiles

java.util.List<ConnectionProfile> getConnectionProfiles()
Returns a List of all ConnectionProfiles known to the connections framework.

Returns:
a List of all known ConnectionProfiles, or an empty list if no connections are defined.

getConnectionProfiles

java.util.List<ConnectionProfile> getConnectionProfiles(java.lang.String connectionTypeId)
Returns a List of all ConnectionProfiles for a given connection type id known to the connections framework.

Parameters:
connectionTypeId - the connection type ID to retrieve connection profiles for.
Returns:
a List of all applicable ConnectionProfiles or an empty list if no connections are defined.
See Also:
IConnectionDescriptor

getConnectionProfilesByDescriptor

java.util.Map<IConnectionDescriptor,java.util.List<ConnectionProfile>> getConnectionProfilesByDescriptor()
Returns a Map of all ConnectionProfiles, indexed by IConnectionDescriptor.

Returns:
the Map of all ConnectionProfiles, indexed by IConnectionDescriptor or an empty map if no connections are defined.

getConnectionProfile

ConnectionProfile getConnectionProfile(java.lang.String id)
Returns a ConnectionProfile identified by the supplied id

Parameters:
id - the ID to retrieve a connection configuration for.
Returns:
a ConnectionProfile or null if no such ConnectionProfile exists.

addListener

void addListener(ConnectionManagerListener listener)
Adds a ConnectionManagerListener to this connection manager. The listener will be notified about changes to any ConnectionProfile managed by this service.

Parameters:
listener - the listener to add.


Copyright © 2013 IBM Corp. All Rights Reserved.