|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The interface used when working with an instance of a connection profile.
Field Summary | |
static int |
PROP_CONNECTED
Property ID for isConnected() |
static int |
PROP_DESCRIPTION
Property ID for getDescription() |
static int |
PROP_NAME
Property ID for getName() |
static int |
PROP_PROPERTIES
Property ID for getBaseProperties() and
getProperties() |
Method Summary | |
void |
addConnectListener(IConnectListener listener)
Deprecated. use IManagedConnection.removeConnectionListener() |
void |
addPropertyListener(IPropertyListener listener)
Add property listener to this profile. |
IStatus |
connect()
This method blocks until all registered connect listeners have been notified to open connections. |
void |
connect(IJobChangeListener listener)
This method returns immediately after spawning a Job which notifies all registered connect listeners to open connections. |
IConnection |
createConnection(java.lang.String factory)
This method is a shortcut for getProvider()getConnectionFactory(factoryId).createConnection(this). |
IConnection |
createConnection(java.lang.String factoryId,
java.lang.String uid,
java.lang.String pwd)
This method is a shortcut for getProvider()getConnectionFactory(factoryId).createConnection(this,uid,pwd). |
IStatus |
disconnect()
This method blocks until all registered connect listeners have been notified to close connections. |
void |
disconnect(IJobChangeListener listener)
This method returns immediately after spawning a Job which notifies all registered connect listeners to close connections. |
java.util.Properties |
getBaseProperties()
This method returns the properties managed by the base connection profile extension. |
ICategory |
getCategory()
This method is a shortcut for getProvider().getCategory(). |
IConfigurationType |
getConfigurationType()
This method is a shortcut for getProvider().getConfigurationType(). |
java.lang.String |
getDescription()
|
java.lang.String |
getInstanceID()
|
IManagedConnection |
getManagedConnection(java.lang.String type)
|
java.lang.String |
getName()
|
IConnectionProfile |
getParentProfile()
This method returns the connection profile that this connection profile derives from. |
java.util.Map |
getProfileExtensions()
This method is a shortcut for getProvider().getProfileExtensions(). |
java.util.Properties |
getProperties(java.lang.String type)
This method returns the properties associated with a connection profile profile extension. |
IConnectionProfileProvider |
getProvider()
Returns the provider responsible for managing this connection profile. |
java.lang.String |
getProviderId()
This method is a shortcut for getProvider().getProviderId(). |
java.lang.String |
getProviderName()
This method is a shortcut for getProvider().getName(). |
boolean |
isAutoConnect()
|
boolean |
isConnected()
|
void |
removeConnectListener(IConnectListener listener)
Deprecated. use IManagedConnection.removeConnectionListener() |
void |
removePropertyListener(IPropertyListener listener)
|
void |
setBaseProperties(java.util.Properties props)
This method sets the properties managed by the base connection profile extension. |
void |
setConnected(boolean connected)
Deprecated. Use one of the connect() methods instead. This method now delegates to connect(). |
void |
setProperties(java.lang.String type,
java.util.Properties props)
This method sets the properties managed by a specific profile extension. |
Field Detail |
public static final int PROP_CONNECTED
isConnected()
public static final int PROP_PROPERTIES
getBaseProperties()
and
getProperties()
public static final int PROP_NAME
getName()
public static final int PROP_DESCRIPTION
getDescription()
Method Detail |
public java.lang.String getName()
public java.lang.String getDescription()
public boolean isAutoConnect()
public java.lang.String getInstanceID()
public IConnectionProfile getParentProfile()
public java.util.Properties getBaseProperties()
public void setBaseProperties(java.util.Properties props)
props
- the properties to set as the base properties.public java.util.Properties getProperties(java.lang.String type)
type
- the type of properties.
public void setProperties(java.lang.String type, java.util.Properties props)
type
- the type of properties.props
- the properties to set.public void setConnected(boolean connected)
connected
- the connected state.public boolean isConnected()
public IStatus connect()
public void connect(IJobChangeListener listener)
listener
- a job listener that can be used to notify the caller of
the state of the job spawned to open the connections. Can be null.public IStatus disconnect()
public void disconnect(IJobChangeListener listener)
listener
- a job listener that can be used to notify the caller of
the state of the job spawned to close the connections. Can be
null.public void addConnectListener(IConnectListener listener)
listener
- public void removeConnectListener(IConnectListener listener)
listener
- public IManagedConnection getManagedConnection(java.lang.String type)
type
- the ID of the connection factory responsible for creating the
connection
public void addPropertyListener(IPropertyListener listener)
listener
- public void removePropertyListener(IPropertyListener listener)
listener
- public java.lang.String getProviderName()
IConnectionProfileProvider.getConfigurationType()
public java.lang.String getProviderId()
public ICategory getCategory()
IConnectionProfileProvider.getCategory()
public IConfigurationType getConfigurationType()
IConnectionProfileProvider.getConfigurationType()
public java.util.Map getProfileExtensions()
IConnectionProfileProvider.getProfileExtensions()
public IConnection createConnection(java.lang.String factory)
factory
- the connection factory id
IConnectionFactory.createConnection(IConnectionProfile)
public IConnection createConnection(java.lang.String factoryId, java.lang.String uid, java.lang.String pwd)
factoryId
- the connection factory iduid
- the user idpwd
- the user's password
IConnectionFactory.createConnection(IConnectionProfile,String,String)
public IConnectionProfileProvider getProvider()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |