com.spectel.bcapi
Interface MultiBridge

All Superinterfaces:

Bridge

public interface MultiBridge
extends Bridge

The MultiBridge interface specifies methods for a collection of implementation specific Bridge connectors.

See Also:

BridgeFactory

Field Summary

static java.lang.String	COMMON_PARAMETER Identifies the bridge parameter that is common across all multi-bridge conferences.
static char	DELIMITER Delimiter used to separate parameter values for multi-bridge

Fields inherited from interface com.spectel.bcapi.Bridge

ACPI_CONNECTION_URL, ACTIVE_SPEAKERS_INCLUDE_QA_QUEUE, AUTO_EXTEND_PORTS, AUTO_EXTEND_PORTS_DEFAULT_OFF, AUTO_EXTEND_PORTS_DEFAULT_ON, AUTO_EXTEND_PORTS_OFF, BRIDGE_NAME, BRIDGE_VERSION, CMD_PORT_NUM, CONF_GAIN, CONF_GAIN_ANYONE, CONF_GAIN_MODERATOR, CONF_GAIN_OFF, CONFERENCE_END, CONFERENCE_EVENT, CONFERENCE_START, CRS_NAME, DATABASE_DRIVER_NAME, DATABASE_URL, DELTA_COMMAND, DIRECTORY_NAME, DISCONNECT_EVENT, DTMF_EVENT, IMPL_TYPE, INCLUDE_OPS_IN_PART_LIST, INTERCEPT_END, INTERCEPT_START, INTERNAL_EVENT, IS_MOD_LECTURE_ALLOWED, LOGGER_DIR, LOGGER_PROPERTIES, MODAPI_USE_SSL, NUM_AVAILABLE_CHANNELS, NUM_CHANNELS, NUM_FAULTED_CHANNELS, NUM_OOS_CHANNELS, OPER_KNOCK, OPER_NUM, OPERATOR_ASSISTANCE, OPERATOR_ASSISTANCE_CONFERENCE, OPERATOR_ASSISTANCE_INDIVIDUAL, OPERATOR_ASSISTANCE_UNAVAILABLE, PAC_EVENT, PARTICIPANT_ENTER, PARTICIPANT_EVENT, PARTICIPANT_EXIT, PARTICIPANT_USER_ENTER, PARTICIPANT_USER_EXIT, PASSWORD, PING_TIMEOUT, PROPERTY_CHANGE, QUEUE_CHANGE, SELF_MUTE, SELF_MUTE_ANYONE, SELF_MUTE_NON_MODERATOR, SELF_MUTE_OFF, SERVICE_NAME, STATE_CHANGE, STATUS_TCP_PORT_NUM, STATUS_UDP_PORT_NUM, SUBCONFERENCE_END, SUBCONFERENCE_START, SYSTEM_NAME, TALKER_EVENT, THROWS_NOTIMPLEMENTED, USER_NAME, XML_LOGGER_PROPERTIES

Method Summary

void	addBridge(java.util.Hashtable parameters) Add a bridge to this collection of bridge instances
java.util.Vector	getBridgeNames() Get a vector containing the BRIDGE_NAME parameters of bridge instances in the collection
java.lang.String	getCommonParameter() Get the conference parameter that is common for all multi-bridge conferences in this MultiBridge instance.
void	removeBridge(java.lang.String bridgeName) Remove a bridge from this collection of bridge instances

Methods inherited from interface com.spectel.bcapi.Bridge

currentTimeMillis, deRegister, disconnect, getAllConferenceIds, getAllConferenceIds, getAllConferenceIds, getCallBrandingTable, getCallBrandingTable, getConference, getConference, getConference, getConference, getConferenceIds, getConferenceIds, getConferenceIds, getDialList, getDialList, getDialListFileNames, getEnterConference, getParameter, getParameters, getParticipant, getReservationGroupFromDNIS, isConnected, openConference, openConference, refreshSystemParameters, register, register, requestDTMFEvents, setAsynchronous, setSynchronous

Field Detail

COMMON_PARAMETER

static final java.lang.String COMMON_PARAMETER

Identifies the bridge parameter that is common across all multi-bridge conferences. This parameter must be passed to the BridgeFactory when instantiating a multi-bridge collection. The parameter "COMMON_PARAMETER" must be defined under the Hashtable or Properties file passed to the getImpl() method. The type of this value is String.

See Also:

Constant Field Values

DELIMITER

static final char DELIMITER

Delimiter used to separate parameter values for multi-bridge

See Also:

Constant Field Values

Method Detail

addBridge

void addBridge(java.util.Hashtable parameters)
               throws BridgeException

Add a bridge to this collection of bridge instances

Parameters:

parameters - details to give BridgeFactory to get an instance of the Bridge to add

Throws:

BridgeException - if the bridge operation fails, the bridge is disconnected or if Bridge cannot be instantiated.

removeBridge

void removeBridge(java.lang.String bridgeName)
                  throws BridgeException

Remove a bridge from this collection of bridge instances

Parameters:

bridgeName - the BRIDGE_NAME parameter of the Bridge instance to remove

Throws:

BridgeException - if the bridge operation fails, the bridge is disconnected or if Bridge cannot be instantiated.

getBridgeNames

java.util.Vector getBridgeNames()

Get a vector containing the BRIDGE_NAME parameters of bridge instances in the collection

Returns:

a Vector of BRIDGE_NAME parameters of bridge instances in the collection

getCommonParameter

java.lang.String getCommonParameter()

Get the conference parameter that is common for all multi-bridge conferences in this MultiBridge instance.

Returns:

the conference parameter that is common for all multi-bridge conferences