com.ibm.cics.core.comm
Interface IConnectionDescriptor


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 IConnections for that type, and meta-information about the connection type, e.g. what IConnectionDescriptor.ExtendedAttributes 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 ExtendedAttributes 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

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

DEFAULT_PORT

static final java.lang.String DEFAULT_PORT
See Also:
Constant Field Values
Method Detail

getId

java.lang.String getId()
Returns the unique ID of this connection type.

Returns:
the unique ID of this connection type.

getName

java.lang.String getName()
Returns the name of this connection type, suitable for use in user interfaces.

Returns:
the name of this connection type, suitable for use in user interfaces.

createConnection

IConnection createConnection()
                             throws ConnectionException
Creates a new instance of the IConnection implementation for this connection type.

Returns:
a new instance of the IConnection implementation for this connection type.
Throws:
ConnectionException - if the IConnection implementation can not be successfully created.

getCategory

IConnectionCategory getCategory()
Returns the IConnectionCategory this connection type belongs to.

Returns:
the IConnectionCategory this connection type belongs to.

isSSLEnabled

boolean isSSLEnabled()
Returns whether or not this connection type supports SSL.

Returns:
whether or not this connection type supports SSL.

getExtendedAttributes

java.util.List<IConnectionDescriptor.ExtendedAttribute> getExtendedAttributes()
Returns a List of all available ExtendedAttributes for this IConnectionDescriptor.

Returns:
a List of ExtendedAttributes, which may be empty.

getExtendedAttribute

IConnectionDescriptor.ExtendedAttribute getExtendedAttribute(java.lang.String nameOfExtendedAttribute)
Returns a specific ExtendedAttribute identified by the supplied name.

Parameters:
nameOfExtendedAttribute -
Returns:
an ExtendedAttribute or null if no such attribute exists.

getChildCategories

@Deprecated
java.util.List<java.lang.String> getChildCategories()
Deprecated. no longer used.

Returns a list of all child connection categories for this IConnectionDescriptor

Returns:
a List of child connection category IDs, which may be empty.

getContributor

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.

Returns:
a plugin id, or null

isTransient

boolean isTransient()
Determines whether or not connections of this type are transient, i.e. Should not be user-creatable or exportable.



Copyright © 2013 IBM Corp. All Rights Reserved.