|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.cics.core.connections.AbstractConnectionProvider
public abstract class AbstractConnectionProvider
Abstract IConnectionProvider
implementation
Nested Class Summary |
---|
Constructor Summary | |
---|---|
|
AbstractConnectionProvider(java.lang.String id)
|
protected |
AbstractConnectionProvider(java.lang.String id,
ConnectionRegistry registry)
Allows injection of a custom ConnectionRegistry, mostly for testing. |
Method Summary | |
---|---|
void |
addListener(IConnectionProvider.ConnectionProviderListener listener)
Adds a IConnectionProvider.ConnectionProviderListener to this service which is notified of any changes
to the collection of ConnectionParameters provided by this IConnectionProvider |
protected void |
clear()
|
protected ConnectionParameters |
createNewConnectionParameters(java.lang.String internalId,
java.lang.String name,
java.lang.String connectionTypeId,
java.util.Map<java.lang.String,java.lang.String> attributes)
|
ConnectionParameters |
getConnection(java.lang.String configurationId)
Retrieves a set of ConnectionParameters identified by the supplied ID. |
java.util.Collection<ConnectionParameters> |
getConnections()
Gets all ConnectionParameters provided by this IConnectionProvider or
an empty collection if there are none. |
java.lang.String |
getId()
|
protected static java.lang.String |
getInternalId(java.lang.String externalId)
Returns the internal ID for a specified external ID. |
protected abstract IStatus |
getStatus()
|
protected java.lang.String |
getUnusedLocalId()
|
protected abstract java.util.List<ConnectionParameters> |
getUpdatedConfigurations(IProgressMonitor monitor)
This method is called when a connection provider is refreshed, and should return the Collection of configurations available
from this IConnectionProvider |
protected void |
notifyStale()
This method can be called to notify implementors that the connection provider is stale and should be refreshed. |
protected ConnectionParameters |
putConnectionParameters(ConnectionParameters newParameters)
Adds the supplied parameters to the cache |
IStatus |
refresh(IProgressMonitor monitor)
Called by the connections framework when this IConnectionProvider should check for any updates. |
protected void |
removeConnectionParameters(java.lang.String id)
Remove the parameters with the supplied ID. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.cics.core.connections.IConnectionProvider |
---|
getDescription |
Constructor Detail |
---|
public AbstractConnectionProvider(java.lang.String id)
id
- the ID of the connection providerprotected AbstractConnectionProvider(java.lang.String id, ConnectionRegistry registry)
id
- the ID of the connection providerregistry
- ConnectionRegistry to use to look up connection metadataMethod Detail |
---|
protected void clear()
public java.lang.String getId()
getId
in interface IConnectionProvider
IConnectionProvider
public java.util.Collection<ConnectionParameters> getConnections()
IConnectionProvider
ConnectionParameters
provided by this IConnectionProvider
or
an empty collection if there are none.
getConnections
in interface IConnectionProvider
Collection
of ConnectionParameters
or an empty collection.public ConnectionParameters getConnection(java.lang.String configurationId)
IConnectionProvider
ConnectionParameters
identified by the supplied ID.
getConnection
in interface IConnectionProvider
configurationId
- the id to use.
ConnectionParameters
or null
if no such
connection parameters exist.public IStatus refresh(IProgressMonitor monitor)
IConnectionProvider
IConnectionProvider
should check for any updates.
This is the appropriate time to perform any network or disk I/O necessary to check that the set of known
ConnectionParameters
is up to date. An IStatus
object should be returned which describes the
result of the refresh. This can be used to report any problems.
refresh
in interface IConnectionProvider
monitor
- an IProgressMonitor
to report progress to.
IStatus
describing the result of the refresh.protected abstract java.util.List<ConnectionParameters> getUpdatedConfigurations(IProgressMonitor monitor)
Collection
of configurations available
from this IConnectionProvider
monitor
-
protected abstract IStatus getStatus()
IStatus
of this IConnectionProvider
protected void notifyStale()
public void addListener(IConnectionProvider.ConnectionProviderListener listener)
IConnectionProvider
IConnectionProvider.ConnectionProviderListener
to this service which is notified of any changes
to the collection of ConnectionParameters
provided by this IConnectionProvider
addListener
in interface IConnectionProvider
listener
- the IConnectionProvider.ConnectionProviderListener
to add.protected java.lang.String getUnusedLocalId()
protected static java.lang.String getInternalId(java.lang.String externalId)
externalId
-
protected ConnectionParameters putConnectionParameters(ConnectionParameters newParameters)
newParameters
-
protected ConnectionParameters createNewConnectionParameters(java.lang.String internalId, java.lang.String name, java.lang.String connectionTypeId, java.util.Map<java.lang.String,java.lang.String> attributes)
protected void removeConnectionParameters(java.lang.String id)
id
- the ID of the parameters to remove
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |