|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConnectionType
Represents a unique type of connection, either inbound or outbound, supported by an adapter type. A connection type has a unique ID (within its containing adapter type) and a set of properties that define the information needed to establish a connection of this type.
The providers of the metadata discovery service implement subinterfaces of the ConnectionType
specialized for the inbound or outbound connection type.
Method Summary | |
---|---|
AdapterType |
getAdapterType()
Gets the type of the adapter that contains this connection. |
ConnectionPersistence |
getConnectionPersistence()
Get the ConnectionPersistence instance that should be used for storing and retrieving connection configuration for this connection type. |
String |
getDescription()
Gets a description of the connection type. |
String |
getDisplayName()
Gets a display name that a tool environment can display to users to represent this connection type. |
String |
getId()
Gets the unique Id for this connection type. |
boolean |
isConnectionConfigurationComplete(ConnectionConfiguration connectionConfiguration)
Verify that given connection configuration is complete, in other word can be reasonably assumed to contain all the information needed to execute the service. |
void |
synchronizeFromPropertyGroupToResourceAdapter(PropertyGroup pg,
ResourceAdapter bean)
Synchronizes from the PropertyGroup to the ResourceAdapter JavaBean. |
void |
synchronizeFromResourceAdapterToPropertyGroup(ResourceAdapter bean,
PropertyGroup pg)
Synchronizes from the ResourceAdapter JavaBean to the PropertyGroup. |
Method Detail |
---|
String getId()
null
.AdapterType getAdapterType()
null
.String getDisplayName()
This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.
ResourceBundle
,
MessageFormat
String getDescription()
This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.
ResourceBundle
,
MessageFormat
ConnectionPersistence getConnectionPersistence() throws MetadataException
null
.
If the returned instance is not null
, the caller must use the returned instance
for all persistence operations related to this connection type.
The instance of the ConnectionPersistence is not limited to have the scope of Connection Type which created it. lt may be appropriate for connection cofigurations from other connection types or even adapter types. It is however guaranteed to be appropriate for the ConnectionType from which it was created.
null
if persistence
is not supported by the discovery service.
MetadataException
- The tools should ask the user which persistence mechanism to use.boolean isConnectionConfigurationComplete(ConnectionConfiguration connectionConfiguration)
connectionConfiguration
- Connection configuration returned from the discovery, the
argument must not be null
true
if configuration is complete, false
otherwisevoid synchronizeFromResourceAdapterToPropertyGroup(ResourceAdapter bean, PropertyGroup pg) throws MetadataException
bean
- The source ResourceAdapter JavaBean.pg
- The target PropertyGroup.
MetadataException
- if any error occured.PropertyGroup
void synchronizeFromPropertyGroupToResourceAdapter(PropertyGroup pg, ResourceAdapter bean) throws MetadataException
pg
- The source PropertyGroup which has user interface updates.bean
- The target outbound ResourceAdapter JavaBean.
MetadataException
- if any error occured.PropertyGroup
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |