|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IConnectionDescriptor
Meta-object describing a particular type of IConnection
, associated with a specific IConnectionCategory
.
An IConnectionDescriptor publishes the name of a connection type, a means of creating new instances of IConnection
s
for that type, and meta-information about the connection type, e.g. what IConnectionDescriptor.ExtendedAttribute
s are available.
Nested Class Summary | |
---|---|
static interface |
IConnectionDescriptor.ExtendedAttribute
Meta-object describing an extended attribute that should be available on a ConnectionConfiguration . |
static class |
IConnectionDescriptor.ExtendedAttributeType
Describes the type of an extended attribute |
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
static java.lang.String |
DEFAULT_PORT
|
Method Summary | |
---|---|
IConnection |
createConnection()
Creates a new instance of the IConnection implementation for this connection type. |
IConnectionCategory |
getCategory()
Returns the IConnectionCategory this connection type belongs to. |
java.util.List<java.lang.String> |
getChildCategories()
Deprecated. no longer used. |
java.lang.String |
getContributor()
Returns the id of the plugin which contributed this IConnectionDescriptor , or null if this
descriptor was not contributed by a plugin. |
IConnectionDescriptor.ExtendedAttribute |
getExtendedAttribute(java.lang.String nameOfExtendedAttribute)
Returns a specific ExtendedAttribute identified by the supplied name. |
java.util.List<IConnectionDescriptor.ExtendedAttribute> |
getExtendedAttributes()
Returns a List of all available ExtendedAttribute s for this IConnectionDescriptor . |
java.lang.String |
getId()
Returns the unique ID of this connection type. |
java.lang.String |
getName()
Returns the name of this connection type, suitable for use in user interfaces. |
boolean |
isSSLEnabled()
Returns whether or not this connection type supports SSL. |
boolean |
isTransient()
Determines whether or not connections of this type are transient, i.e. |
Field Detail |
---|
static final java.lang.String COPYRIGHT
static final java.lang.String DEFAULT_PORT
Method Detail |
---|
java.lang.String getId()
java.lang.String getName()
IConnection createConnection() throws ConnectionException
IConnection
implementation for this connection type.
IConnection
implementation for this connection type.
ConnectionException
- if the IConnection
implementation can not be successfully created.IConnectionCategory getCategory()
IConnectionCategory
this connection type belongs to.
IConnectionCategory
this connection type belongs to.boolean isSSLEnabled()
java.util.List<IConnectionDescriptor.ExtendedAttribute> getExtendedAttributes()
List
of all available ExtendedAttribute
s for this IConnectionDescriptor
.
List
of ExtendedAttributes
, which may be empty.IConnectionDescriptor.ExtendedAttribute getExtendedAttribute(java.lang.String nameOfExtendedAttribute)
ExtendedAttribute
identified by the supplied name.
nameOfExtendedAttribute
-
ExtendedAttribute
or null
if no such attribute exists.@Deprecated java.util.List<java.lang.String> getChildCategories()
IConnectionDescriptor
List
of child connection category IDs, which may be empty.java.lang.String getContributor()
IConnectionDescriptor
, or null
if this
descriptor was not contributed by a plugin.
boolean isTransient()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |