com.sapportals.connector.metadata

Interface IConnectorMetaData

All Superinterfaces:

ResourceAdapterMetaData

public interface IConnectorMetaData
extends ResourceAdapterMetaData

Provides metadata for this connector

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNBOUNDED use these constants to declare unbounded variable values
static int	UNDEFINED use these constants to declare undefined variable values

Method Summary

Modifier and Type	Method and Description
Set	getAdditionalProperties() returns additional properties names and values supported by the connector
String	getAdditionalPropertyValue(String propertyName) Returns a value of a given property name
ICapabilities	getCapabilities(IConnectionSpec connectionSpec) returns the capabilities of this connector
int	getConnectionDefaultTimeout() Returns the default timeout in milliseconds for obtaining a connection
String	getDefaultDateFormat() Returns the default date format when using a query
String	getDefaultTimeFormat() Returns the default date format when using a query
int	getExecutionDefaultTimeout() Returns the default time in milliseconds for executing a function
int	getFirstIndex() Returns the integer indicating the first element in an list either 0 or 1
int	getMaxConnections() Returns the number of maximum connections supported by the connector
int	getQueryDefaultTimeout() Returns the default time in milliseconds for executing a query
Set<String>	retrieveAdditionalPropertiesNames() returns additional properties supported by the connector

Methods inherited from interface javax.resource.cci.ResourceAdapterMetaData

getAdapterName, getAdapterShortDescription, getAdapterVendorName, getAdapterVersion, getInteractionSpecsSupported, getSpecVersion, supportsExecuteWithInputAndOutputRecord, supportsExecuteWithInputRecordOnly, supportsLocalTransactionDemarcation

Field Detail

UNBOUNDED

static final int UNBOUNDED

use these constants to declare unbounded variable values

See Also:

Constant Field Values

UNDEFINED

static final int UNDEFINED

use these constants to declare undefined variable values

See Also:

Constant Field Values

Method Detail

getMaxConnections

int getMaxConnections()

Returns the number of maximum connections supported by the connector

Returns:

integer

getConnectionDefaultTimeout

int getConnectionDefaultTimeout()

Returns the default timeout in milliseconds for obtaining a connection

Returns:

integer

getExecutionDefaultTimeout

int getExecutionDefaultTimeout()

Returns the default time in milliseconds for executing a function

Returns:

integer

getQueryDefaultTimeout

int getQueryDefaultTimeout()

Returns the default time in milliseconds for executing a query

Returns:

integer

getDefaultDateFormat

String getDefaultDateFormat()

Returns the default date format when using a query

Returns:

String

getDefaultTimeFormat

String getDefaultTimeFormat()

Returns the default date format when using a query

Returns:

String

getFirstIndex

int getFirstIndex()

Returns the integer indicating the first element in an list either 0 or 1

Returns:

0 or 1

getCapabilities

ICapabilities getCapabilities(IConnectionSpec connectionSpec)
                       throws ConnectorException

returns the capabilities of this connector

Parameters:

connectionSpec - An IConnectionSpec object (could be null in case the capabilities are not per specific connection)

Returns:

ICapbilities interface

Throws:

ConnectorException - if connector is failed

See Also:

ICapabilities

retrieveAdditionalPropertiesNames

Set<String> retrieveAdditionalPropertiesNames()

returns additional properties supported by the connector

Returns:

Set of properties names

getAdditionalPropertyValue

String getAdditionalPropertyValue(String propertyName)

Returns a value of a given property name

Parameters:

propertyName - is a name of property

Returns:

String The value of the property

getAdditionalProperties

Set getAdditionalProperties()

returns additional properties names and values supported by the connector

Returns:

Set of properties names and values