com.spectel.bcapi
Class BridgeFactory

java.lang.Object
  com.spectel.bcapi.BridgeFactory

public class BridgeFactory
extends java.lang.Object

This is a factory class to get all implementation specific instances of the Bridge interface.

See Also:

Bridge

Field Summary

static java.lang.String	IMPL_ACPI Implementation type for the ACPI adapter.
static java.lang.String	IMPL_BAPI_700_2_X Implementation type BAPI for 7000 version 2.x Bridges
static java.lang.String	IMPL_BAPI_7000_9_0 Implementation type BAPI for 7000 version 9.0 Bridges
static java.lang.String	IMPL_BAPI_7000_9_1 Implementation type BAPI for 7000 version 9.1 Bridges
static java.lang.String	IMPL_BAPI_7000_9_2 Implementation type BAPI for 7000 version 9.2 Bridges
static java.lang.String	IMPL_BAPI_7000_9_3 Implementation type BAPI for 7000 version 9.3 Bridges
static java.lang.String	IMPL_BAPI_7000_9_4 Implementation type BAPI for 7000 version 9.4 Bridges
static java.lang.String	IMPL_BAPI_7000_9_5 Implementation type BAPI for 7000 version 9.5 Bridges
static java.lang.String	IMPL_BAPI_SIMULATOR Implementation type BAPI for bridge simulator
static java.lang.String	IMPL_CRYSTAL Implementation type for Crystal Bridges
static java.lang.String	IMPL_MODAPI Implementation type ModAPI for CS700 Bridges
static java.lang.String	IMPL_MODAPI_FOR_BCAPI_1_6_OR_HIGHER Implementation type Modapi for CS700 BCAPI version 1.6 The legacy algorythm used to getConference(argConferenceEntryCode) would search the MODERATOR_CODE attribute and return the first match even if the moderator code field contained a value that was really a leader-pin.
static java.lang.String	IMPL_MULTIBRIDGE Implementation type MULTIBRIDGE for use with a collection of Bridges
static java.lang.String	IMPL_SIMULATOR Implementation type for simulator.
static java.lang.String	loggerPropertyFile Log4J configuration file for the logger.

Method Summary

static java.lang.String	getApiVersion() Deprecated. As of CMAPI 1.1, replaced by the standard methods java.lang.Package.getImplementationVersion() and java.lang.Package.getSpecificationVersion()
static Bridge	getImpl(java.util.Hashtable parameters) Get an implementation specific instance of the abstract Bridge class.
static Bridge	getImpl(java.lang.String fullPathToPropertyFile) Instantiates an object of type bridge with parameters defined in a properties file.
static int	getMajorVersion() Deprecated. As of CMAPI 1.1, replaced by the standard method java.lang.Package.getSpecificationVersion()
static int	getMinorVersion() Deprecated. As of CMAPI 1.1, replaced by the standard method java.lang.Package.getSpecificationVersion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

loggerPropertyFile

public static java.lang.String loggerPropertyFile

Log4J configuration file for the logger.

IMPL_ACPI

public static final java.lang.String IMPL_ACPI

Implementation type for the ACPI adapter.

See Also:

Constant Field Values

IMPL_MODAPI

public static final java.lang.String IMPL_MODAPI

Implementation type ModAPI for CS700 Bridges

See Also:

Constant Field Values

IMPL_MODAPI_FOR_BCAPI_1_6_OR_HIGHER

public static java.lang.String IMPL_MODAPI_FOR_BCAPI_1_6_OR_HIGHER

Implementation type Modapi for CS700 BCAPI version 1.6

The legacy algorythm used to getConference(argConferenceEntryCode) would search the MODERATOR_CODE attribute and return the first match even if the moderator code field contained a value that was really a leader-pin. This is flawed because leader-pins are not unique. The new implementation, uses IS_LEADER_PIN and has a LEADER_PIN field on the conferenceare and the getConference routines will not match uniquely to the moderator-code field.

IMPL_SIMULATOR

public static final java.lang.String IMPL_SIMULATOR

Implementation type for simulator.

See Also:

Constant Field Values

IMPL_CRYSTAL

public static final java.lang.String IMPL_CRYSTAL

Implementation type for Crystal Bridges

See Also:

Constant Field Values

IMPL_BAPI_700_2_X

public static final java.lang.String IMPL_BAPI_700_2_X

Implementation type BAPI for 7000 version 2.x Bridges

See Also:

Constant Field Values

IMPL_BAPI_7000_9_0

public static final java.lang.String IMPL_BAPI_7000_9_0

Implementation type BAPI for 7000 version 9.0 Bridges

See Also:

Constant Field Values

IMPL_BAPI_7000_9_1

public static final java.lang.String IMPL_BAPI_7000_9_1

Implementation type BAPI for 7000 version 9.1 Bridges

See Also:

Constant Field Values

IMPL_BAPI_7000_9_2

public static final java.lang.String IMPL_BAPI_7000_9_2

Implementation type BAPI for 7000 version 9.2 Bridges

See Also:

Constant Field Values

IMPL_BAPI_7000_9_3

public static final java.lang.String IMPL_BAPI_7000_9_3

Implementation type BAPI for 7000 version 9.3 Bridges

See Also:

Constant Field Values

IMPL_BAPI_7000_9_4

public static final java.lang.String IMPL_BAPI_7000_9_4

Implementation type BAPI for 7000 version 9.4 Bridges

See Also:

Constant Field Values

IMPL_BAPI_7000_9_5

public static final java.lang.String IMPL_BAPI_7000_9_5

Implementation type BAPI for 7000 version 9.5 Bridges

See Also:

Constant Field Values

IMPL_BAPI_SIMULATOR

public static final java.lang.String IMPL_BAPI_SIMULATOR

Implementation type BAPI for bridge simulator

See Also:

Constant Field Values

IMPL_MULTIBRIDGE

public static final java.lang.String IMPL_MULTIBRIDGE

Implementation type MULTIBRIDGE for use with a collection of Bridges

See Also:

Constant Field Values

Method Detail

getImpl

public static Bridge getImpl(java.util.Hashtable parameters)
                      throws BridgeException

Get an implementation specific instance of the abstract Bridge class.

Parameters:

parameters - details of specific Bridge implementation

Returns:

implementation specific instance of Bridge

Throws:

BridgeException - If any parameters passed are invalid or missing, or the creation of the Bridge object fails.

getImpl

public static final Bridge getImpl(java.lang.String fullPathToPropertyFile)
                            throws BridgeException,
                                   java.io.IOException

Instantiates an object of type bridge with parameters defined in a properties file.

Parameters:

fullPathToPropertyFile - Defines the location of the properties file which holds the default parameters for a bridge object.

Returns:

A bridge object holding a valid session with a physical bridge.

Throws:

BridgeException - When any passed parameters are invalid or missing, or when the creation of the Bridge object fails.

java.io.IOException - When the reading of the properties file fails.

getApiVersion

public static final java.lang.String getApiVersion()

Deprecated. As of CMAPI 1.1, replaced by the standard methods java.lang.Package.getImplementationVersion() and java.lang.Package.getSpecificationVersion()

Retrieve the API version number. This value may be used to instantiate a versioned bridge object. Will return a string specifying failure on failure to read the version number.

Returns:

The version string.

getMajorVersion

public static int getMajorVersion()

Deprecated. As of CMAPI 1.1, replaced by the standard method java.lang.Package.getSpecificationVersion()

Get major version number of the API

Returns:

major version number of the API, or -1 on failure to read the version number.

getMinorVersion

public static int getMinorVersion()

Deprecated. As of CMAPI 1.1, replaced by the standard method java.lang.Package.getSpecificationVersion()

Get minor version number of the API

Returns:

minor version number of the API, or -1 on failure to read the version number.