com.spectel.bcapi
Interface Bridge

All Known Subinterfaces:

MultiBridge

public interface Bridge

The Bridge interface is implemented by all implementation specific Bridge connectors. It provides generic functionality for all Avaya Bridges.

A Bridge instance and connection to a running conferencing bridge is created by the BridgeFactory.getImpl() methods. Then Participant and Conference instances can be accessed by methods from the Bridge instance.

Note that unlike Participants and Conferences, Bridge instance parameters are not automatically updated when setting changes are made on the bridge. Most Bridge parameters will only update by calling refreshSystemParameters(). Also unlike Participants and Conferences, the Bridge.getParameter() and getParameters() methods will return null when the network connection to the bridge is disconnected.

See Also:

BridgeFactory

Field Summary

static java.lang.String	ACPI_CONNECTION_URL The connection url to use when establishing a BCAPI connection using the ACPI BCAPI Legacy adapter.
static java.lang.String	ACTIVE_SPEAKERS_INCLUDE_QA_QUEUE Flag to indicate whether unmuted members of the qa queue are included as active speakers.
static java.lang.String	AUTO_EXTEND_PORTS Indicates whether or not the maximum number of participants set for any conference on the bridge may be exceeded with further dial-outs or dial-ins.
static java.lang.Integer	AUTO_EXTEND_PORTS_DEFAULT_OFF State (value = -1) indicates that by default the maximum number of participants set for any conference on the bridge may not be exceeded with further dial-outs or dial-ins.
static java.lang.Integer	AUTO_EXTEND_PORTS_DEFAULT_ON State (value = 1) indicates that by default the maximum number of participants set for any conference on the bridge may be exceeded with further dial-outs or dial-ins.
static java.lang.Integer	AUTO_EXTEND_PORTS_OFF State (value = 0) indicates that the maximum number of participants set for any conference on the bridge may not be exceeded with further dial-outs or dial-ins.
static java.lang.String	BRIDGE_NAME The name or IP address of the bridge that the Bridge instance will connect to.
static java.lang.String	BRIDGE_VERSION Bridge version is defined under this key.
static java.lang.String	CMD_PORT_NUM This OPTIONAL parameter defines the ModAPI command port.
static java.lang.String	CONF_GAIN Indicates who can adjust the gain (voice volumes) of all participants in a conference.
static java.lang.Integer	CONF_GAIN_ANYONE State (value = 2) indicates that any participant can adjust the conference gain.
static java.lang.Integer	CONF_GAIN_MODERATOR State (value = 1) indicates that only moderators can adjust the conference gain.
static java.lang.Integer	CONF_GAIN_OFF State (value = 0) indicates that no participant can adjust the conference gain.
static java.lang.Integer	CONFERENCE_END The conference has ended and can no longer be retrieved from the Bridge via the getConference() method.
static java.lang.Integer	CONFERENCE_EVENT Conference events are generated when any feature or state change occurs to the specific conference.
static java.lang.Integer	CONFERENCE_START The conference has started and can be retrieved from the Bridge via the getConference() method.
static java.lang.String	CRS_NAME The name or IP address of the CRS the Bridge instance will be connected to.
static java.lang.String	DATABASE_DRIVER_NAME The database driver name defaults to "com.informix.jdbc.IfxDriver" If the driver is not present the getCallBrandingTable method and getReservationGroupFromDNIS method will not work.
static java.lang.String	DATABASE_URL The database driver URL defaults to the inetAddress of the BRIDGE_NAME plus the correct ports and default passwords for the Bridge database, This attribute is used at login to override the default database url.
static java.lang.String	DELTA_COMMAND This property specifies whether the API uses sparse parameter setting messages or the full Conference and Channel messages.
static java.lang.String	DIRECTORY_NAME The directory name necessary to establish a valid session with the bridge (log on).
static java.lang.Integer	DISCONNECT_EVENT Disconnect events will be generated when the connection to the bridge is lost.
static java.lang.Integer	DTMF_EVENT DTMF events are generated for events involving DTMF digits being dialed on a specific line.
static java.lang.String	IMPL_TYPE Defines the bridge implementation type.
static java.lang.String	INCLUDE_OPS_IN_PART_LIST The flag to indicate whether to include operators in the Participant List is defined under this key.
static java.lang.Integer	INTERCEPT_END The intercept conference has ended for the conference identified by CONFERENCE_ID.
static java.lang.Integer	INTERCEPT_START The intercept conference has started for the conference identified by CONFERENCE_ID.
static java.lang.Integer	INTERNAL_EVENT Internal events are generated for any events that are considered system updates.
static java.lang.String	IS_MOD_LECTURE_ALLOWED Indicates whether or not moderators can start a conference's lecture mode, muting all non-moderator lines.
static java.lang.String	LOGGER_DIR Directory for the logs to be written to.
static java.lang.String	LOGGER_PROPERTIES The path to the Log4j properties file.
static java.lang.String	MODAPI_USE_SSL When using BridgeFactory.IMPL_MODAPI or BridgeFactory.IMPL_MODAPI_FOR_BCAPI_1_6_OR_HIGHER this parameter controls the use the of SSL encrypted version for the MODAPI protocol unless the ACPI_CONNECTION_URL parameter has been provided.
static java.lang.String	NUM_AVAILABLE_CHANNELS The number of revenue channels on the bridge that are currently not in use.
static java.lang.String	NUM_CHANNELS The number of revenue channels on the bridge.
static java.lang.String	NUM_FAULTED_CHANNELS The number of revenue channels on the bridge that are currently faulted.
static java.lang.String	NUM_OOS_CHANNELS The number of out-of-service revenue channels on the bridge.
static java.lang.Integer	OPER_KNOCK An operator is requesting to join a secured/locked conference.
static java.lang.String	OPER_NUM The operator number of the operator channel to associate with this session.
static java.lang.String	OPERATOR_ASSISTANCE Indicates whether operators provide help to entire conferences or only to the participant who seeks help.
static java.lang.Integer	OPERATOR_ASSISTANCE_CONFERENCE State (value = 1) indicates operator assistance applies to the conference, meaning if a participant in a conference requests help, the operator joins the conference.
static java.lang.Integer	OPERATOR_ASSISTANCE_INDIVIDUAL State (value = 0) indicates operator assistance is individual, meaning only the participant who requests help is temporarily removed from the conference to speak privately with the operator.
static java.lang.Integer	OPERATOR_ASSISTANCE_UNAVAILABLE State (value = 2) indicates operator assistance does not apply.
static java.lang.Integer	PAC_EVENT PAC (PlayAndCollect) event is a participant event generated when playAndCollect data is send by the bridge.
static java.lang.Integer	PARTICIPANT_ENTER A participant has entered the conference.
static java.lang.Integer	PARTICIPANT_EVENT Participant events are generated when any feature or state change occurs to the specific participant, or when a Conference action causes participant state changes.
static java.lang.Integer	PARTICIPANT_EXIT A participant has exited the conference.
static java.lang.Integer	PARTICIPANT_USER_ENTER A participant has entered a user conference.
static java.lang.Integer	PARTICIPANT_USER_EXIT A participant has exited a user conference.
static java.lang.String	PASSWORD The password associated with the user name and used to authenticate the user on the bridge in order to establish a valid session on the bridge.
static java.lang.String	PING_TIMEOUT The number of seconds that the ping message under isConnected() should wait before timing out.
static java.lang.Integer	PROPERTY_CHANGE The Sub-event PROPERTY_CHANGE (value = 22) describes the property changes of a conference, participant, or bridge.
static java.lang.Integer	QUEUE_CHANGE The Q&A queue has changed.
static java.lang.String	SELF_MUTE Indicates who can mute themselves (self-mute).
static java.lang.Integer	SELF_MUTE_ANYONE State (value = 2) indicates that any participant can self-mute.
static java.lang.Integer	SELF_MUTE_NON_MODERATOR State (value = 1) indicates that only non-moderator participants can self-mute.
static java.lang.Integer	SELF_MUTE_OFF State (value = 0) indicates that no participant can self-mute.
static java.lang.String	SERVICE_NAME The user name necessary to establish a valid session with the bridge (log on).
static java.lang.Integer	STATE_CHANGE The Sub-event STATE_CHANGE (value = 21) describes the object state of a conference, participant, or bridge.
static java.lang.String	STATUS_TCP_PORT_NUM This OPTIONAL parameter defines the ModAPI status tcp port.
static java.lang.String	STATUS_UDP_PORT_NUM This OPTIONAL parameter defines the ModAPI status udp port.
static java.lang.Integer	SUBCONFERENCE_END The subconference has ended for the conference identified by CONFERENCE_ID.
static java.lang.Integer	SUBCONFERENCE_START The subconference has started for the conference identified by CONFERENCE_ID.
static java.lang.String	SYSTEM_NAME The name of the bridge.
static java.lang.Integer	TALKER_EVENT Talker events are generated for any Participants creating voice chatter on the bridge.
static java.lang.String	THROWS_NOTIMPLEMENTED By default the compatibility layer from BCAPI 1.x to ACOM 1.5 attempts to fail gracefully without throwing not implemented exceptions.
static java.lang.String	USER_NAME The user name necessary to establish a valid session with the bridge (log on).
static java.lang.String	XML_LOGGER_PROPERTIES The path to the Log4j.xml properties file.

Method Summary

long	currentTimeMillis() Returns the current time on the Bridge in milliseconds since January 1, 1970.
void	deRegister(BridgeListener listener) Remove a listener from the bridge.
void	disconnect() Dispose of Bridge connection.
java.util.Vector	getAllConferenceIds() Return conference IDs of conferences currently being monitored by the Bridge object, including all subconferences and intercept conferences.
java.util.Vector	getAllConferenceIds(boolean argIsForAllReservationGroups) Return conference IDs of conferences currently being monitored by the Bridge object, including all subconferences and intercept conferences.
java.util.Vector	getAllConferenceIds(int argReservationGroup) Return conference IDs of conferences currently being monitored by the Bridge object, including all subconferences and intercept conferences.
CallBrandingTable	getCallBrandingTable() Returns a cached version of the Call Branding Table so that subsequent queries to translate DNIS to reservation group number will not require database access.
CallBrandingTable	getCallBrandingTable(boolean argForceRefresh) Returns a cached version of the Call BrandingTable so that subsequent queries to translate the DNIS to ReservationGroup number will not require database access.
Conference	getConference(java.util.Hashtable params) Get the conference currently being monitored by the Bridge object.
Conference	getConference(java.lang.String conferenceId) Returns the conference that is currently being monitored by the Bridge object.
Conference	getConference(java.lang.String argConfEntryCode, int argReservationGroup) Get the conference currently being monitored by the Bridge object.
Conference	getConference(java.lang.String conferenceId, java.lang.String entryCode) Get the conference currently being monitored by the Bridge object.
java.util.Vector	getConferenceIds() Return conference IDs of conferences currently being monitored by the Bridge object.
java.util.Vector	getConferenceIds(boolean argIsForAllReservationGroups) Return conference IDs of conferences currently being monitored by the Bridge object for the specified reservation group.
java.util.Vector	getConferenceIds(int argReservationGroup) Return conference IDs of conferences currently being monitored by the Bridge object for the specified reservation group.
java.util.Vector	getDialList(java.lang.String dialListFileName) Returns a Vector of the entries of a dial list file on the Bridge, only if that file has no access code.
java.util.Vector	getDialList(java.lang.String dialListFileName, java.lang.String accessCode) Returns a Vector of the entries of a dial list file on the Bridge, if the input accessCode matches the dial list accessCode.
java.util.Vector	getDialListFileNames() Returns a Vector of all the dial list file names on the Bridge.
EnterQueue	getEnterConference() Returns the Enter conference object.
java.lang.Object	getParameter(java.lang.String key) Get the parameter defined by the given key string.
java.util.Hashtable	getParameters() Gets a Hashtable containing the current state of the Bridge object.
Participant	getParticipant(java.lang.String key) Get a participant, whether active or inactive, currently in this bridge.
int	getReservationGroupFromDNIS(java.lang.String argDNIS) This call uses a direct database query to determine the mapping of a DNIS number to a reservation group.
boolean	isConnected() Check the object's connection to bridge.
void	openConference(java.lang.String argConfEntryCode, int argReservationGroup) Open specified conference on the bridge if it is not yet opened.
void	openConference(java.lang.String conferenceId, java.lang.String code) Open specified conference on the bridge if it is not yet opened.
void	refreshSystemParameters() Refreshes all system-related parameters, updating them to the current values on the bridge.
void	register(BridgeListener listener) Register a listener for all events received by this bridge.
void	register(BridgeListener listener, java.lang.Integer eventType, java.lang.String conferenceId, java.lang.String participantId, java.lang.String phoneNumber, java.util.Hashtable parameters) Register a listener for some events received by this bridge.
void	requestDTMFEvents(boolean sendDTMF) Requests or turns off DTMF events.
void	setAsynchronous() Do not wait for command completion.
void	setSynchronous(long timeout) Sets how long we should wait for command completion.

Field Detail

IMPL_TYPE

static final java.lang.String IMPL_TYPE

Defines the bridge implementation type. This value is used by the BridgeFactory to return the correct Bridge instance. Define the parameter "IMPL_TYPE" under the Hashtable or Properties file passed to the getImpl() method.

The type of this value is String.

See Also:

Constant Field Values

ACPI_CONNECTION_URL

static final java.lang.String ACPI_CONNECTION_URL

The connection url to use when establishing a BCAPI connection using the ACPI BCAPI Legacy adapter. This parameter must be defined when using IMPL_TYPE BridgeFactory.IMPL_ACPI. When using BridgeFactory.IMPL_MODAPI or BridgeFactory.IMPL_MODAPI_FOR_BCAPI_1_6_OR_HIGHER this parameter will overide the settings in BRIDGE_NAME, MODAPI_USE_SSL, CMD_PORT_NUM, STATUS_TCP_PORT_NUM, STATUS_UDP_PORT_NUM and OPER_NUM. The parameter "ACPI_CONNECTION_URL" must be defined under the Hashtable or in the Properties file passed to the getImpl() method.

The type of this value is String.

See Also:

Constant Field Values

BRIDGE_NAME

static final java.lang.String BRIDGE_NAME

The name or IP address of the bridge that the Bridge instance will connect to. The parameter "BRIDGE_NAME" must be defined under the Hashtable or in the Properties file passed to the getImpl() method.

The type of this value is String.

See Also:

Constant Field Values

MODAPI_USE_SSL

static final java.lang.String MODAPI_USE_SSL

When using BridgeFactory.IMPL_MODAPI or BridgeFactory.IMPL_MODAPI_FOR_BCAPI_1_6_OR_HIGHER this parameter controls the use the of SSL encrypted version for the MODAPI protocol unless the ACPI_CONNECTION_URL parameter has been provided. Note to connect to a S700 you must specify false. Defaults to true if missing.

Since:

5.1.0.0.0

See Also:

Constant Field Values

CRS_NAME

static final java.lang.String CRS_NAME

The name or IP address of the CRS the Bridge instance will be connected to. The parameter "CRS_NAME" must be defined under the Hashtable or Properties file passed to the getImpl() method for BAPI implementations. The type of this value is String.

See Also:

Constant Field Values

BRIDGE_VERSION

static final java.lang.String BRIDGE_VERSION

Bridge version is defined under this key. User may retrieve Bridge version through getParameter() method with this key. The type of this value is String.

See Also:

Constant Field Values

INCLUDE_OPS_IN_PART_LIST

static final java.lang.String INCLUDE_OPS_IN_PART_LIST

The flag to indicate whether to include operators in the Participant List is defined under this key. User may retrieve flag through getParameter() method with this key. The type of this value is Boolean.

See Also:

Constant Field Values

ACTIVE_SPEAKERS_INCLUDE_QA_QUEUE

static final java.lang.String ACTIVE_SPEAKERS_INCLUDE_QA_QUEUE

Flag to indicate whether unmuted members of the qa queue are included as active speakers. User may retrieve flag through getParameter() method with this key. The type of this value is Boolean.

See Also:

Constant Field Values

LOGGER_PROPERTIES

static final java.lang.String LOGGER_PROPERTIES

The path to the Log4j properties file. This parameter "LOGGER_PROPERTIES" must be defined under the Hashtable or Properties file passed to the getImpl() method in order to enable logging. The type of this value is String.

See Also:

Constant Field Values

XML_LOGGER_PROPERTIES

static final java.lang.String XML_LOGGER_PROPERTIES

The path to the Log4j.xml properties file. This parameter "XML_LOGGER_PROPERTIES" must be defined under the Hashtable or Properties file passed to the getImpl() method in order to enable logging. The type of this value is String.

See Also:

Constant Field Values

LOGGER_DIR

static final java.lang.String LOGGER_DIR

Directory for the logs to be written to. This parameter "LOGGER_DIR" is optionally defined under the Hashtable or Properties file passed to the getImpl() method.

The type of this value is String.

See Also:

Constant Field Values

CMD_PORT_NUM

static final java.lang.String CMD_PORT_NUM

This OPTIONAL parameter defines the ModAPI command port. The value must match the bridge setting for the command port. If not set then the default is 20002. Define the parameter "CMD_PORT_NUM" under the Hashtable or the Properties file passed to the getImpl() method.

The type of this value is String.

This parameter is used only on the Avaya 700/780 Bridge.

See Also:

Constant Field Values

STATUS_TCP_PORT_NUM

static final java.lang.String STATUS_TCP_PORT_NUM

This OPTIONAL parameter defines the ModAPI status tcp port. When not provided, the default value is 5040. Define the parameter "STATUS_TCP_PORT_NUM" under the Hashtable or the Properties file passed to the getImpl() method.

The type of this value is String.

This parameter is used only on the Avaya 700/780 Bridge.

See Also:

Constant Field Values

STATUS_UDP_PORT_NUM

static final java.lang.String STATUS_UDP_PORT_NUM

This OPTIONAL parameter defines the ModAPI status udp port. When not provided, the default value is 5020. Define the parameter "STATUS_UDP_PORT_NUM" under the Hashtable or the Properties file passed to the getImpl() method.

The type of this value is String.

This parameter is used only on the Avaya 700/780 Bridge.

See Also:

Constant Field Values

THROWS_NOTIMPLEMENTED

static final java.lang.String THROWS_NOTIMPLEMENTED

By default the compatibility layer from BCAPI 1.x to ACOM 1.5 attempts to fail gracefully without throwing not implemented exceptions. To turn not implemented exceptions on use the value "true".

The type of this value is String for "true" of Boolean true.

This parameter is used only on the Avaya S6100 Bridge.

See Also:

Constant Field Values

SERVICE_NAME

static final java.lang.String SERVICE_NAME

The user name necessary to establish a valid session with the bridge (log on). Define the parameter "SERVICE_NAME" under the Hashtable or the Properties file passed to the getImpl() method.

The type of this value is String.

This parameter is used only on the Avaya S6100 Bridge.

See Also:

Constant Field Values

DIRECTORY_NAME

static final java.lang.String DIRECTORY_NAME

The directory name necessary to establish a valid session with the bridge (log on). Define the parameter "DIRECTORY_NAME" under the Hashtable or the Properties file passed to the getImpl() method.

The type of this value is String.

This parameter is used only on the Avaya S6100 Bridge.

See Also:

Constant Field Values

USER_NAME

static final java.lang.String USER_NAME

The user name necessary to establish a valid session with the bridge (log on). Define the parameter "USER_NAME" under the Hashtable or the Properties file passed to the getImpl() method.

The type of this value is String.

This parameter is used only on the Avaya 700/780 Bridge.

See Also:

Constant Field Values

PASSWORD

static final java.lang.String PASSWORD

The password associated with the user name and used to authenticate the user on the bridge in order to establish a valid session on the bridge. Define the parameter "PASSWORD" under the Hashtable or the Properties file passed to the getImpl() method.

The type of this value is String.

This parameter is used only on the Avaya 700/780 Bridge.

See Also:

Constant Field Values

OPER_NUM

static final java.lang.String OPER_NUM

The operator number of the operator channel to associate with this session. When a value of 0 is used, the bridge will associate the next available operator channel with this session. If the value used is either less than 0 or greater than the highest operator number defined on the bridge, the bridge will associate the next available operator channel with this session. Define the parameter "OPER_NUM" under the Hashtable or the Properties file passed to the getImpl() method.

The type of this value is String.

This parameter is used only on the Avaya 700/780 Bridge.

See Also:

Constant Field Values

DATABASE_URL

static final java.lang.String DATABASE_URL

The database driver URL defaults to the inetAddress of the BRIDGE_NAME plus the correct ports and default passwords for the Bridge database, This attribute is used at login to override the default database url.

See Also:

Constant Field Values

DATABASE_DRIVER_NAME

static final java.lang.String DATABASE_DRIVER_NAME

The database driver name defaults to "com.informix.jdbc.IfxDriver" If the driver is not present the getCallBrandingTable method and getReservationGroupFromDNIS method will not work. This attribute is used at login to override the default database driver name.

See Also:

Constant Field Values

PING_TIMEOUT

static final java.lang.String PING_TIMEOUT

The number of seconds that the ping message under isConnected() should wait before timing out. The default is 10 seconds. Define the parameter "PING_TIMEOUT" under the Hashtable or the Properties file passed to the getImpl() method.

The type of this value is String.

This parameter is used only on the Avaya 700/780 Bridge.

See Also:

Constant Field Values

DELTA_COMMAND

static final java.lang.String DELTA_COMMAND

This property specifies whether the API uses sparse parameter setting messages or the full Conference and Channel messages. If delta command is "true" then only the changed fields are included in the command request, otherwise all fields are set at once. Allowed values are "true" or "false". If omitted the default value is "true". Define the parameter "DELTA_COMMAND" under the Hashtable or the Properties file passed to the getImpl() method.

The type of this value is String.

This parameter is used only on the Avaya 700/780 Bridge.

See Also:

Constant Field Values

NUM_CHANNELS

static final java.lang.String NUM_CHANNELS

The number of revenue channels on the bridge. Users may update this value to the current bridge state with refreshSystemParameters().

The type of this value is Integer.

This parameter is used only on the Avaya 700/780 Bridge.

Since:

1.2

See Also:

Constant Field Values

NUM_AVAILABLE_CHANNELS

static final java.lang.String NUM_AVAILABLE_CHANNELS

The number of revenue channels on the bridge that are currently not in use. Users may update this value to the current bridge state with refreshSystemParameters().

The type of this value is Integer.

This parameter is used only on the Avaya 700/780 Bridge.

Since:

1.2

See Also:

Constant Field Values

NUM_FAULTED_CHANNELS

static final java.lang.String NUM_FAULTED_CHANNELS

The number of revenue channels on the bridge that are currently faulted. Users may update this value to the current bridge state with refreshSystemParameters().

The type of this value is Integer.

This parameter is used only on the Avaya 700/780 Bridge.

Since:

1.2

See Also:

Constant Field Values

NUM_OOS_CHANNELS

static final java.lang.String NUM_OOS_CHANNELS

The number of out-of-service revenue channels on the bridge. Users may update this value to the current bridge state with refreshSystemParameters().

The type of this value is Integer.

This parameter is used only on the Avaya 700/780 Bridge.

Since:

1.2

See Also:

Constant Field Values

SYSTEM_NAME

static final java.lang.String SYSTEM_NAME

The name of the bridge. Users may update this value to the current bridge state with refreshSystemParameters().

The type of this value is String.

This parameter is used only on the Avaya 700/780 Bridge.

Since:

1.2

See Also:

Constant Field Values

OPERATOR_ASSISTANCE

static final java.lang.String OPERATOR_ASSISTANCE

Indicates whether operators provide help to entire conferences or only to the participant who seeks help. Users may update this value to the current bridge state with refreshSystemParameters().

The type of this value is Integer.

This parameter is used only on the Avaya 700/780 Bridge.

Since:

1.2

See Also:

OPERATOR_ASSISTANCE_INDIVIDUAL, OPERATOR_ASSISTANCE_CONFERENCE, Constant Field Values

CONF_GAIN

static final java.lang.String CONF_GAIN

Indicates who can adjust the gain (voice volumes) of all participants in a conference. Users may update this value to the current bridge state with refreshSystemParameters().

The type of this value is Integer.

This parameter is used only on the Avaya 700/780 Bridge.

Since:

1.2

See Also:

CONF_GAIN_OFF, CONF_GAIN_MODERATOR, CONF_GAIN_ANYONE, Constant Field Values

IS_MOD_LECTURE_ALLOWED

static final java.lang.String IS_MOD_LECTURE_ALLOWED

Indicates whether or not moderators can start a conference's lecture mode, muting all non-moderator lines. Users may update this value to the current bridge state with refreshSystemParameters().

The type of this value is Boolean.

This parameter is used only on the Avaya 700/780 Bridge.

Since:

1.2

See Also:

Constant Field Values

SELF_MUTE

static final java.lang.String SELF_MUTE

Indicates who can mute themselves (self-mute). Users may update this value to the current bridge state with refreshSystemParameters().

The type of this value is Integer.

This parameter is used only on the Avaya 700/780 Bridge.

Since:

1.2

See Also:

SELF_MUTE_OFF, SELF_MUTE_NON_MODERATOR, SELF_MUTE_ANYONE, Constant Field Values

AUTO_EXTEND_PORTS

static final java.lang.String AUTO_EXTEND_PORTS

Indicates whether or not the maximum number of participants set for any conference on the bridge may be exceeded with further dial-outs or dial-ins. Users may update this value to the current bridge state with refreshSystemParameters().

The type of this value is Integer. The "AUTO_EXTEND_PORTS" parameter is read-only and can be accessed via the getParameter() method.

This parameter is used only on the Avaya 700/780 Bridge.

Since:

1.4

See Also:

AUTO_EXTEND_PORTS_OFF, AUTO_EXTEND_PORTS_DEFAULT_ON, AUTO_EXTEND_PORTS_DEFAULT_OFF, Constant Field Values

CONFERENCE_EVENT

static final java.lang.Integer CONFERENCE_EVENT

Conference events are generated when any feature or state change occurs to the specific conference. For example, calling lock() will secure the conference. The API returns an event with EVENT_TYPE equal to CONFERENCE_EVENT (i.e. 1) and a CONFERENCE_ID equal to (Conference Id) to the listener . Conference start and conference end events not only trigger conference events, but also the update in the QA participant list. The latter informs the user that the QA list has changed and recommends that an update be performed via the Conference.getQAParticipants().

PARTICIPANT_EVENT

static final java.lang.Integer PARTICIPANT_EVENT

Participant events are generated when any feature or state change occurs to the specific participant, or when a Conference action causes participant state changes. For example, the former may occur if a user calls mute(). The participant becomes muted and the API generates an event with EVENT_TYPE equal to PARTICIPANT_EVENT (i.e. 2) and PARTICIPANT_ID equal to (Participant Id). The Conference.lecture() method is an example of a Conference action that causes participant state changes. This method causes the Conference object to enter lecture mode, therefore producing a CONFERENCE_EVENT. Additionally, this causes the Participant objects (except Moderators) in the Conference to become muted. The API generates a PARTICIPANT_EVENT for each participant (except Moderators) in the conference.

TALKER_EVENT

static final java.lang.Integer TALKER_EVENT

Talker events are generated for any Participants creating voice chatter on the bridge. The talker event will have the EVENT_TYPE equal to TALKER_EVENT (i.e. 3), the SUB_EVENT_TYPE equal to STATE_CHANGE, and the PARTICIPANT_ID equal to (Participant Id). This event does not have a Conference Id.

Whether or not a Participant is currently speaking is determined by its Participant.IS_TALKING parameter.

See Also:

Participant.IS_TALKING

INTERNAL_EVENT

static final java.lang.Integer INTERNAL_EVENT

Internal events are generated for any events that are considered system updates. A few examples include Participant disconnects, a Participant object becoming an operator, and participants moving between internal conferences. The internal event will have the EVENT_TYPE equal to INTERNAL_EVENT (i.e. 4) and no conference or Participant Id.

DISCONNECT_EVENT

static final java.lang.Integer DISCONNECT_EVENT

Disconnect events will be generated when the connection to the bridge is lost. This can occur if the API receives a shutdown event from bridge (i.e. when the bridge is shut down for maintenance), network I/O errors, or peer crashes. There is no participant or conference id involved. Upon receiving a DISCONNECT_EVENT, the API application has to restart after the bridge or network is up. The disconnect event will have the EVENT_TYPE equal to DISCONNECT_EVENT (i.e. 5) and SUB_EVENT_TYPE of state change (i.e. 21)

DTMF_EVENT

static final java.lang.Integer DTMF_EVENT

DTMF events are generated for events involving DTMF digits being dialed on a specific line. The DTMF event will have the EVENT_TYPE equal to DTMF_EVENT and sub-event of PROPERTY_CHANGE. PARTICIPANT_ID and CONFERENCE_ID will also be set to the Ids of the line (Participant) on which the keys were dialed and the Conference the Participant is in. The DTMF event will also contain DTMF_TIMESTAMP, representing the approximate time that the keys were dialed, and DTMF_STRING, which is a String representing the keys dialed.

Since:

1.2

STATE_CHANGE

static final java.lang.Integer STATE_CHANGE

The Sub-event STATE_CHANGE (value = 21) describes the object state of a conference, participant, or bridge. State refers to conference features such as Q/A and polling or participant features such as mute/unmute. A hashtable parameter list will be populated when generating events.

Refer to the Programmer's manual for information on the parameter pairs.

PROPERTY_CHANGE

static final java.lang.Integer PROPERTY_CHANGE

The Sub-event PROPERTY_CHANGE (value = 22) describes the property changes of a conference, participant, or bridge. Property changes include changes to any physical property of the conference, participant, or bridge. A hashtable parameter list will be populated when generating events.

Refer to the Programmer's manual for information on the parameter pairs.

CONFERENCE_START

static final java.lang.Integer CONFERENCE_START

The conference has started and can be retrieved from the Bridge via the getConference() method. CONFERENCE_START value = 23.

CONFERENCE_END

static final java.lang.Integer CONFERENCE_END

The conference has ended and can no longer be retrieved from the Bridge via the getConference() method. CONFERENCE_END value = 24.

QUEUE_CHANGE

static final java.lang.Integer QUEUE_CHANGE

The Q&A queue has changed. It is recommended that an updated queue be retrieved via the Conference.getQAParticipants() method. QUEUE_CHANGE value = 25.

PARTICIPANT_ENTER

static final java.lang.Integer PARTICIPANT_ENTER

A participant has entered the conference. A PROPERTY_CHANGE for the participant will also be generated. PARTICIPANT_ENTER value = 26.

PARTICIPANT_EXIT

static final java.lang.Integer PARTICIPANT_EXIT

A participant has exited the conference. A PROPERTY_CHANGE for the participant will also be generated. PARTICIPANT_EXIT value = 27.

SUBCONFERENCE_START

static final java.lang.Integer SUBCONFERENCE_START

The subconference has started for the conference identified by CONFERENCE_ID. SUBCONFERENCE_START value = 28;

SUBCONFERENCE_END

static final java.lang.Integer SUBCONFERENCE_END

The subconference has ended for the conference identified by CONFERENCE_ID. SUBCONFERENCE_END value = 29;

INTERCEPT_START

static final java.lang.Integer INTERCEPT_START

The intercept conference has started for the conference identified by CONFERENCE_ID. INTERCEPT_START value = 30.

INTERCEPT_END

static final java.lang.Integer INTERCEPT_END

The intercept conference has ended for the conference identified by CONFERENCE_ID. INTERCEPT_END value = 31.

PARTICIPANT_USER_ENTER

static final java.lang.Integer PARTICIPANT_USER_ENTER

A participant has entered a user conference. This event is only generated when a participant moves into a user conference. PARTICIPANT_USER_ENTER value = 32.

PARTICIPANT_USER_EXIT

static final java.lang.Integer PARTICIPANT_USER_EXIT

A participant has exited a user conference. This event is only generated when a participant moves out of a user conference. PARTICIPANT_USER_EXIT value = 33.

OPER_KNOCK

static final java.lang.Integer OPER_KNOCK

An operator is requesting to join a secured/locked conference. Subevent type of a conference event. OPER_KNOCK value = 34.

Since:

1.3

PAC_EVENT

static final java.lang.Integer PAC_EVENT

PAC (PlayAndCollect) event is a participant event generated when playAndCollect data is send by the bridge. It contains the status: (0 - matchNotFound, 1 - matchFound, 2 - minNotMet, 3 - maxExceeded, 4 - timeout, 5 - canceled.) and the dtmf digits entered (could be empty).

OPERATOR_ASSISTANCE_INDIVIDUAL

static final java.lang.Integer OPERATOR_ASSISTANCE_INDIVIDUAL

State (value = 0) indicates operator assistance is individual, meaning only the participant who requests help is temporarily removed from the conference to speak privately with the operator.

Since:

1.2

OPERATOR_ASSISTANCE_CONFERENCE

static final java.lang.Integer OPERATOR_ASSISTANCE_CONFERENCE

State (value = 1) indicates operator assistance applies to the conference, meaning if a participant in a conference requests help, the operator joins the conference.

Since:

1.2

OPERATOR_ASSISTANCE_UNAVAILABLE

static final java.lang.Integer OPERATOR_ASSISTANCE_UNAVAILABLE

State (value = 2) indicates operator assistance does not apply. This is used on the Crystal bridge with no operator assistance.

Since:

2.0

CONF_GAIN_OFF

static final java.lang.Integer CONF_GAIN_OFF

State (value = 0) indicates that no participant can adjust the conference gain.

Since:

1.2

CONF_GAIN_MODERATOR

static final java.lang.Integer CONF_GAIN_MODERATOR

State (value = 1) indicates that only moderators can adjust the conference gain.

Since:

1.2

CONF_GAIN_ANYONE

static final java.lang.Integer CONF_GAIN_ANYONE

State (value = 2) indicates that any participant can adjust the conference gain.

SELF_MUTE_OFF

static final java.lang.Integer SELF_MUTE_OFF

State (value = 0) indicates that no participant can self-mute.

Since:

1.2

SELF_MUTE_NON_MODERATOR

static final java.lang.Integer SELF_MUTE_NON_MODERATOR

State (value = 1) indicates that only non-moderator participants can self-mute.

Since:

1.2

SELF_MUTE_ANYONE

static final java.lang.Integer SELF_MUTE_ANYONE

State (value = 2) indicates that any participant can self-mute.

Since:

1.2

AUTO_EXTEND_PORTS_OFF

static final java.lang.Integer AUTO_EXTEND_PORTS_OFF

State (value = 0) indicates that the maximum number of participants set for any conference on the bridge may not be exceeded with further dial-outs or dial-ins. This setting can not be changed in the Conference Scheduler.

Since:

1.4

AUTO_EXTEND_PORTS_DEFAULT_ON

static final java.lang.Integer AUTO_EXTEND_PORTS_DEFAULT_ON

State (value = 1) indicates that by default the maximum number of participants set for any conference on the bridge may be exceeded with further dial-outs or dial-ins. Nevertheless this setting can be changed in the Conference Scheduler on a per-conference basis.

Since:

1.4

See Also:

Conference.AUTO_EXTEND_PARTICIPANTS

AUTO_EXTEND_PORTS_DEFAULT_OFF

static final java.lang.Integer AUTO_EXTEND_PORTS_DEFAULT_OFF

State (value = -1) indicates that by default the maximum number of participants set for any conference on the bridge may not be exceeded with further dial-outs or dial-ins. Nevertheless this setting can be changed in the Conference Scheduler on a per-conference basis.

Since:

1.4

See Also:

Conference.AUTO_EXTEND_PARTICIPANTS

Method Detail

getParameters

java.util.Hashtable getParameters()

Gets a Hashtable containing the current state of the Bridge object. This method will return null when not connected to the bridge.

Common parameters

• IMPL_TYPE - String - the implementation type of this bridge
• BRIDGE_NAME - String - the name or IP address of the bridge

ModAPI specific parameters

• CMD_PORT_NUM - Integer - the command port
• USER_NAME - Integer - the user name used to log on to the bridge
• PASSWORD - Integer - the password associated with the user name
• OPER_NUM - Integer - the operator number of the operator channel

Returns:

Hashtable of properties, or null when not connected to the bridge

getParameter

java.lang.Object getParameter(java.lang.String key)

Get the parameter defined by the given key string. This method will return null when not connected to the bridge.

Parameters:

key - The String value identifying the desired parameter.

Returns:

The parameter associated with the given key, null means not found, or not connected to the bridge.

See Also:

getParameters()

disconnect

void disconnect()
                throws BridgeException

Dispose of Bridge connection.

Throws:

BridgeException - if API fails to disconnect

isConnected

boolean isConnected()

Check the object's connection to bridge.

Returns:

is this object currently connected to the bridge?

setAsynchronous

void setAsynchronous()

Do not wait for command completion.

setSynchronous

void setSynchronous(long timeout)

Sets how long we should wait for command completion.

This method is only implemented on the Avaya 7000 Bridge.

Parameters:

timeout - Milliseconds to wait for command to complete

getConferenceIds

java.util.Vector getConferenceIds()

Return conference IDs of conferences currently being monitored by the Bridge object. This list does not contain any subconferences and intercept conferences.

Versions of this method using IMPL_TYPE=MODAPI will return CONFERENCE_ID from reservation group zero only.

Versions of this method using IMPL_TYPE=MODAPI_FOR_BCAPI_1_6_OR_HIGHER will return CONFERENCE_ID from all reservation groups.

Returns:

Vector containing conference IDs or an empty Vector if a list is not available

See Also:

getConference(java.lang.String)

getConferenceIds

java.util.Vector getConferenceIds(int argReservationGroup)

Return conference IDs of conferences currently being monitored by the Bridge object for the specified reservation group. This list does not contain any subconferences and intercept conferences.

Parameters:

argReservationGroup - The reservation group number associated with the conferences being returned.

Returns:

Vector containing conference IDs or an empty Vector if a list is not available

Since:

1.6

See Also:

getConference(java.lang.String)

getConferenceIds

java.util.Vector getConferenceIds(boolean argIsForAllReservationGroups)

Return conference IDs of conferences currently being monitored by the Bridge object for the specified reservation group. This list does not contain any subconferences and intercept conferences.

Parameters:

argIsForAllReservationGroups - true will return list of all active conferences regardless of the reservation group false will return active conferences in reservation group zero only.

Returns:

Vector containing conference IDs or an empty Vector if a list is not available

Since:

1.6

See Also:

getConference(java.lang.String)

getAllConferenceIds

java.util.Vector getAllConferenceIds()

Return conference IDs of conferences currently being monitored by the Bridge object, including all subconferences and intercept conferences.

Versions of this method using IMPL_TYPE=MODAPI will return CONFERENCE_ID from reservation group zero only.

Versions of this method using IMPL_TYPE=MODAPI_FOR_BCAPI_1_6_OR_HIGHER will return CONFERENCE_ID from all reservation groups.

Returns:

Vector containing conference IDs of all active conferences or an empty Vector if a list is not available.

Since:

1.1

getAllConferenceIds

java.util.Vector getAllConferenceIds(int argReservationGroup)

Return conference IDs of conferences currently being monitored by the Bridge object, including all subconferences and intercept conferences.

Parameters:

argReservationGroup - The reservation group number associated with the conferences being returned.

Returns:

Vector containing conference IDs or an empty Vector if a list is not available

Since:

1.6

See Also:

getConference(java.lang.String)

getAllConferenceIds

java.util.Vector getAllConferenceIds(boolean argIsForAllReservationGroups)

Return conference IDs of conferences currently being monitored by the Bridge object, including all subconferences and intercept conferences.

Parameters:

argIsForAllReservationGroups - true will return list of all active conferences regardless of the reservation group false will return active conferences in reservation group zero only.

Returns:

Vector containing conference IDs or an empty Vector if a list is not available

Since:

1.6

See Also:

getConference(java.lang.String)

getConference

Conference getConference(java.lang.String conferenceId)

Returns the conference that is currently being monitored by the Bridge object.

Returns:

Conference object or null if it isn't available

getEnterConference

EnterQueue getEnterConference()

Returns the Enter conference object. This is the system conference that lines that do not enter a correct conference passcode get sent to, to wait for operator intervention (if the bridge is so configured). As a system conference, the Enter conference does not support most user conference functionality, such as lecture, start time, etc.

getConference

Conference getConference(java.lang.String conferenceId,
                         java.lang.String entryCode)
                         throws BridgeException

Get the conference currently being monitored by the Bridge object.



An asynchronous call immediately returns a reference to the conference object. A synchronous call waits until the first conference event is received before it returns a reference to the conference object.

Parameters:

conferenceId - Conference Id of the conference

entryCode - Conference code used to authenticate the request

Returns:

The specified conference being monitored or null if it is not available.

Throws:

BridgeException - if the bridge operation fails, the bridge is disconnected, or if the Conference code is incorrect.

getConference

Conference getConference(java.lang.String argConfEntryCode,
                         int argReservationGroup)
                         throws BridgeException

Get the conference currently being monitored by the Bridge object.



An asynchronous call immediately returns a reference to the conference object. A synchronous call waits until the first conference event is received before it returns a reference to the conference object.

Parameters:

argConfEntryCode - Conference code used to authenticate the request

argReservationGroup - The reservation group number associated with the confEntryCode

Returns:

The specified conference being monitored or null if it is not available.

Throws:

BridgeException - if the bridge operation fails, the bridge is disconnected, or if the Conference code is incorrect.

getConference

Conference getConference(java.util.Hashtable params)
                         throws BridgeException

Get the conference currently being monitored by the Bridge object.



An asynchronous call immediately returns a reference to the conference object. A synchronous call waits until the first conference event is received before it returns a reference to the conference object.

Parameters:

params - Set of parameters the conference must match.

Returns:

The specified conference being monitored or null if it is not available.

Throws:

BridgeException - when the bridge operation fails, the bridge is disconnected, or a Conference with matching parameters can not be found.

getParticipant

Participant getParticipant(java.lang.String key)

Get a participant, whether active or inactive, currently in this bridge.

Parameters:

key - The participant id.

Returns:

The participant whose ID was passed or null if no such participant.

Since:

1.1

openConference

void openConference(java.lang.String conferenceId,
                    java.lang.String code)
                    throws BridgeException

Open specified conference on the bridge if it is not yet opened. A conference is normally only opened on the bridge when a line is placed to it. The conference must be opened before you can dial a line out of it. NOTE: The conferenceId parameter is ignored. Please use only the code parameter.

Parameters:

conferenceId - (ignored)

code - Conference code to authenticate open attempt, developer should favor participant code for opening rooms because moderator code is not unique for all call flows.

Throws:

BridgeException - if the bridge operation fails

openConference

void openConference(java.lang.String argConfEntryCode,
                    int argReservationGroup)
                    throws BridgeException

Open specified conference on the bridge if it is not yet opened. A conference is normally only opened on the bridge when a line is placed to it. The conference must be opened before you can dial a line out of it. NOTE: The conferenceId parameter is ignored. Please use only the code parameter.

Parameters:

argConfEntryCode - Conference code to authenticate open attempt, developer should favor participant code for opening rooms because moderator code is not unique for all call flows.

argReservationGroup - The reservation group associated with the Conference Entry Code, use zero for the default reservation group.

Throws:

BridgeException - if the bridge operation fails

currentTimeMillis

long currentTimeMillis()
                       throws BridgeException

Returns the current time on the Bridge in milliseconds since January 1, 1970.

Returns:

the current time on the Bridge in milliseconds

Throws:

BridgeException - if the bridge is disconnected

register

void register(BridgeListener listener)

Register a listener for all events received by this bridge.

Parameters:

listener - The Bridge Listener to add.

register

void register(BridgeListener listener,
              java.lang.Integer eventType,
              java.lang.String conferenceId,
              java.lang.String participantId,
              java.lang.String phoneNumber,
              java.util.Hashtable parameters)

Register a listener for some events received by this bridge. The events received by the listener are determined by the filter parameters passed in the method call.

Parameters:

listener - The Bridge Listener to add.

eventType - Event types to listen for, or null to listen for allevent types.

conferenceId - Conference ID of a particular conference's events, or null for events received by any conference.

participantId - The ID of a particular participant's events, or null for events received by any participant.

phoneNumber - Phone number for a specific participant's events, or null for events received by any participant. NOTE: An empty string will never match an event's phone number.

parameters - Optional parameters to filter events received. May be null.

deRegister

void deRegister(BridgeListener listener)

Remove a listener from the bridge.

Parameters:

listener - The Bridge Listener to remove from the bridge.

getDialListFileNames

java.util.Vector getDialListFileNames()
                                      throws BridgeException

Returns a Vector of all the dial list file names on the Bridge.

Throws:

BridgeException - if there is a problem with the bridge request or connection

See Also:

getDialList(java.lang.String)

getDialList

java.util.Vector getDialList(java.lang.String dialListFileName)
                             throws BridgeException

Returns a Vector of the entries of a dial list file on the Bridge, only if that file has no access code. Each entry is a Hashtable with the keys Participant.NAME, Participant.IS_MODERATOR, Participant.PHONE_NUM, Participant.QA_PRIORITY, Participant.COMPANY.

Throws:

BridgeException - if there is a problem with the connection, the dial list of that name is not found, or there is a dial list access code.

See Also:

Participant.NAME, Participant.IS_MODERATOR, Participant.PHONE_NUM, Participant.QA_PRIORITY, Participant.COMPANY, getDialListFileNames(), getDialList(String,String), Conference.DIAL_LIST

getDialList

java.util.Vector getDialList(java.lang.String dialListFileName,
                             java.lang.String accessCode)
                             throws BridgeException

Returns a Vector of the entries of a dial list file on the Bridge, if the input accessCode matches the dial list accessCode. Each entry is a Hashtable with the keys Participant.NAME, Participant.IS_MODERATOR, Participant.PHONE_NUM, Participant.QA_PRIORITY, Participant.COMPANY.

Throws:

BridgeException - if there is a problem with the connection, the dial list of that name is not found, or the dial list access code does not match the input access code.

See Also:

Participant.NAME, Participant.IS_MODERATOR, Participant.PHONE_NUM, Participant.QA_PRIORITY, Participant.COMPANY, getDialListFileNames(), getDialList(String), Conference.DIAL_LIST

refreshSystemParameters

void refreshSystemParameters()
                             throws BridgeException

Refreshes all system-related parameters, updating them to the current values on the bridge.

Throws:

BridgeException - if there is a problem with the connection, or if the bridge fails on the client request.

Since:

1.2

requestDTMFEvents

void requestDTMFEvents(boolean sendDTMF)
                       throws BridgeException

Requests or turns off DTMF events.

Parameters:

sendDTMF - true if requesting DTMF events. false if turning DTMF events off.

Throws:

BridgeException - if there is a problem with the connection, or if the bridge fails on the client request.

Since:

1.2

getCallBrandingTable

CallBrandingTable getCallBrandingTable()
                                       throws BridgeException

Returns a cached version of the Call Branding Table so that subsequent queries to translate DNIS to reservation group number will not require database access.

Please call this method as few times as possible.

Returns:

CallBrandingTable cached version of the call branding table

Throws:

BridgeException - if there is a problem with the connection, or if the bridge fails on the client request.

getCallBrandingTable

CallBrandingTable getCallBrandingTable(boolean argForceRefresh)
                                       throws BridgeException

Returns a cached version of the Call BrandingTable so that subsequent queries to translate the DNIS to ReservationGroup number will not require database access.

Parameters:

argForceRefresh - True if Forcing a refresh of the cached call branding table

Returns:

CallBrandingTable cached version of the call branding table

Throws:

BridgeException - if there is a problem with the connection, or if the bridge fails on the client request.

getReservationGroupFromDNIS

int getReservationGroupFromDNIS(java.lang.String argDNIS)
                                throws BridgeException

This call uses a direct database query to determine the mapping of a DNIS number to a reservation group. It should only be used sparingly, the prefered means of converting DNIS to reservation group should be to use Bridge.getReservationGroup() and then used the cached version of CallBrandingTable.getReservationGroupFromDNIS() to reduce direct database queries.

Parameters:

argDNIS - The incoming DNIS to map to the phone number

Returns:

The Reservation group number based on the database matching algorythm

Throws:

BridgeException - if there is a problem with the connection, or if the bridge fails on the client request.