|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
public interface IConnectionProvider
A service that provides a collection of
ConnectionParameters, firing events when any
changes are made to that collection, or to the ConnectionParameters in it.
Nested Class Summary
static classIConnectionProvider.ConnectionParametersAddedEvent
Indicates that a new set of ConnectionParameters was added.
static classIConnectionProvider.ConnectionParametersRemovedEvent
Indicates that an existing set of ConnectionParameters was removed.
static classIConnectionProvider.ConnectionParametersUpdatedEvent
Indicates that an existing set of ConnectionParameters was updated.
static classIConnectionProvider.ConnectionProviderConnectionParametersEvent
Abstract superclass for all ConnectionProviderEvents that pertain to
changes to the provided collection of ConnectionParameters.
static classIConnectionProvider.ConnectionProviderEvent
Abstract superclass for events on IConnectionProviders
static classIConnectionProvider.ConnectionProviderListener
Listener class for IConnectionProviders.
static classIConnectionProvider.ConnectionProviderStaleEvent
Indicates that this connection provider is stale, and should be refreshed.
static classIConnectionProvider.ConnectionProviderStatusChangedEvent
Indicates that the status of this conneciton provider has changed with the latest refresh.
Field Summary
static java.lang.StringCOPYRIGHT
Method Summary
voidaddListener(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
ConnectionParametersgetConnection(java.lang.String connectionId)
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.StringgetDescription()
Returns a description of this connection provider, to be used when representing it in the UI.
java.lang.StringgetId()
IStatusrefresh(IProgressMonitor monitor)
Called by the connections framework when this IConnectionProvider should check for any updates.
Field Detail
COPYRIGHT
static final java.lang.String COPYRIGHT
Method Detail
getId
java.lang.String getId()
IConnectionProvider
getConnection
ConnectionParameters getConnection(java.lang.String connectionId)
ConnectionParameters identified by the supplied ID.
connectionId - the id to use.
ConnectionParameters or null if no such
connection parameters exist.
getConnections
java.util.Collection<ConnectionParameters> getConnections()
ConnectionParameters provided by this IConnectionProvider or
an empty collection if there are none.
Collection of ConnectionParameters or an empty collection.
addListener
void addListener(IConnectionProvider.ConnectionProviderListener listener)
IConnectionProvider.ConnectionProviderListener to this service which is notified of any changes
to the collection of ConnectionParameters provided by this IConnectionProvider
listener - the IConnectionProvider.ConnectionProviderListener to add.
refresh
IStatus refresh(IProgressMonitor monitor)
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.
monitor - an IProgressMonitor to report progress to.
IStatus describing the result of the refresh.
getDescription
java.lang.String getDescription()
Overview
Package
Class
Use
Tree
Serialized
Deprecated
Index
Help
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD
Copyright © 2013 IBM Corp. All Rights Reserved.