com.sapportals.connector.metadata
Interface IConnectorMetaData

All Superinterfaces:

javax.resource.cci.ResourceAdapterMetaData

public interface IConnectorMetaData

extends javax.resource.cci.ResourceAdapterMetaData

Provides metadata for this connector

Version:

1.0

Field Summary

static int	UNBOUNDED use these constants to declare unbounded variable values
static int	UNDEFINED use these constants to declare undefined variable values

Method Summary

java.util.Set	getAdditionalProperties() returns additional properties names and values supported by the connector
java.lang.String	getAdditionalPropertyValue(java.lang.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
java.lang.String	getDefaultDateFormat() Returns the default date format when using a query
java.lang.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
java.util.Set	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

public static final int UNBOUNDED

use these constants to declare unbounded variable values

UNDEFINED

public static final int UNDEFINED

use these constants to declare undefined variable values

Method Detail

getMaxConnections

public int getMaxConnections()

Returns the number of maximum connections supported by the connector

Returns:

integer

getConnectionDefaultTimeout

public int getConnectionDefaultTimeout()

Returns the default timeout in milliseconds for obtaining a connection

Returns:

integer

getExecutionDefaultTimeout

public int getExecutionDefaultTimeout()

Returns the default time in milliseconds for executing a function

Returns:

integer

getQueryDefaultTimeout

public int getQueryDefaultTimeout()

Returns the default time in milliseconds for executing a query

Returns:

integer

getDefaultDateFormat

public java.lang.String getDefaultDateFormat()

Returns the default date format when using a query

Returns:

String

getDefaultTimeFormat

public java.lang.String getDefaultTimeFormat()

Returns the default date format when using a query

Returns:

String

getFirstIndex

public int getFirstIndex()

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

Returns:

0 or 1

getCapabilities

public 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

See Also:

ICapabilities

retrieveAdditionalPropertiesNames

public java.util.Set retrieveAdditionalPropertiesNames()

returns additional properties supported by the connector

Returns:

Set of properties names

getAdditionalPropertyValue

public java.lang.String getAdditionalPropertyValue(java.lang.String propertyName)

Returns a value of a given property name

Returns:

String The value of the property

getAdditionalProperties

public java.util.Set getAdditionalProperties()

returns additional properties names and values supported by the connector

Returns:

Set of properties names and values