|
Avaya Conferencing Provider API | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.avaya.conferencing.api.acp.control.AbstractConferencingObject<Connection>
com.avaya.conferencing.api.acp.control.Connection
public abstract class Connection
A connection to an Avaya Conferencing Provider.
| Field Summary | |
|---|---|
static java.lang.String |
ACTIVE
The property name for isActive(). |
static java.lang.String |
CONFERENCE_CALL_FLOWS
The property name for getConferenceCallFlows(). |
static java.lang.String |
DESCRIPTION
The property name for getDescription() |
static java.lang.String |
DISCONNECT_REASONS
The property name for getDisconnectReasons(). |
static java.lang.String |
INBOUND_CALL_FLOWS
The property name for getInboundCallFlows(). |
static java.lang.String |
MEDIA_RESOURCE_POOLS
The property name for getMediaResourcePools(). |
static java.lang.String |
MESSAGE_SETS
The property name for the getMessageSets() call. |
static java.lang.String |
NAME
The property name for getName() |
static java.lang.String |
OPEN
The property name for isOpen(). |
static java.lang.String |
PARTICIPANT_ANNOUNCERS
The property name for getParticipantAnnouncers(). |
static java.lang.String |
QA_PRIORITIES
The property name for getQAPriorities(). |
static java.lang.String |
RECORD_PARTICIPANT_NAME_MODES
The property name for getRecordParticipantNameModes(). |
static java.lang.String |
ROOMS
The property name for getRooms(). |
static java.lang.String |
SUPPORTED_URI_SCHEMES
The property name for getSupportedURISchemes(). |
| Fields inherited from class com.avaya.conferencing.api.acp.control.AbstractConferencingObject |
|---|
VERBOSE_TO_STRING |
| Fields inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObject |
|---|
STATE |
| Constructor Summary | |
|---|---|
Connection()
|
|
| Method Summary | ||
|---|---|---|
void |
addConferenceListener(ConferenceListener listener)
Registers a ConferenceListener against this Connection. |
|
void |
addEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener)
Registers a PropertyChangeListener against all properties of the EndPoints in this container. |
|
void |
addEndPointPropertyChangeListener(java.lang.String property,
java.beans.PropertyChangeListener listener)
Registers a PropertyChangeListener against a specific property of the EndPoints in this container. |
|
abstract
|
applyDefaults(T operation)
Populates this Connection's defaults into the operation. |
|
abstract void |
close()
Closes the connection. |
|
java.util.Iterator<Conference> |
conferenceIterator()
Returns an iterator of the connection Conferences. |
|
java.util.Iterator<Conference> |
conferenceIterator(Filter<? super Conference>... filters)
Returns an iterator of the connection Conferences that match the specified filters. |
|
java.util.Iterator<Conference> |
conferenceIterator(Filter<? super Conference> filter)
Returns an iterator of the connection Conferences that match the specified filters. |
|
java.util.Iterator<EndPoint> |
endPointIterator()
Returns an iterator of the conference EndPoints. |
|
java.util.Iterator<EndPoint> |
endPointIterator(Filter<? super EndPoint>... filters)
Returns an iterator of the conference EndPoints. |
|
Conference |
findConference(Reference<Conference> ref)
Find and retrieve the specified Conference. |
|
EndPoint |
findEndPoint(Reference<EndPoint> ref)
Find and retrieve the specified EndPoint. |
|
abstract java.util.Set<Verb> |
getAllVerbsAs(java.lang.Class<? extends ConferencingObject<?>> childClass,
java.lang.Class<? extends CPAuthentication> authClass)
Returns all possible verbs that the specified type of authentication could be allowed to execute against the specified type of ConferencingObject. |
|
abstract java.util.Set<java.lang.Class<? extends CPAuthentication>> |
getAuthentications()
Returns the authentications that are supported by this connection. |
|
abstract
|
getAvailableResources(java.lang.Class<T> type)
Gets the available ConnectionSpecificResource instances of a specified type that this Connection provides. |
|
ConferenceCallFlow[] |
getConferenceCallFlows()
Gets the available ConferenceCallFlow instances that this Connection provides. |
|
java.util.Collection<Conference> |
getConferences()
Returns the Conferences of this Connection. |
|
java.util.Collection<Conference> |
getConferences(Filter<? super Conference> filters)
Returns the Conferences of this Connection matching the specified filters. |
|
abstract java.util.Set<State> |
getDefaultEndPointStates(java.lang.Class<? extends CPAuthentication> clazz)
Returns the set of States that an EndPoint, with the supplied authentication class, will have by default or null if the supplied authentication is not associated with an EndPoint (i.e. |
|
java.lang.String |
getDescription()
Gets the description of the ConferencingProvider to which this Connection is connected. |
|
EndPoint.DisconnectReason[] |
getDisconnectReasons()
Gets the available EndPoint.DisconnectReason instances that this Connection provides. |
|
java.util.Collection<EndPoint> |
getEndPoints()
Returns the EndPoints of this EndPointContainer. |
|
java.util.Collection<EndPoint> |
getEndPoints(Filter<? super EndPoint>... filters)
Returns the EndPoints of this EndPointContainer which match a specific Filters. |
|
InboundCallFlow[] |
getInboundCallFlows()
Gets the available InboundCallFlow instances that this Connection provides. |
|
MediaResourcePool[] |
getMediaResourcePools()
Gets the available MediaResourcePool names that are available on the Connection. |
|
MessageSet[] |
getMessageSets()
Gets a collection of the prompt sets available on this connection. |
|
java.lang.String |
getName()
Gets the name of the ConferencingProvider to which this Connection is connected. |
|
OperationFactory |
getOperationFactory()
Getter for property 'operationFactory'. |
|
Conference.ParticipantAnnouncer[] |
getParticipantAnnouncers()
Gets the available EndPoint.DisconnectReason instances that this Connection provides. |
|
EndPoint.QAPriority[] |
getQAPriorities()
Gets the available EndPoint.QAPriority instances that this Connection provides. |
|
RecordParticipantNameMode[] |
getRecordParticipantNameModes()
Gets the available RecordParticipantNameModes that this Connection provides. |
|
Room[] |
getRooms()
Gets the available Room instances that this Connection provides. |
|
abstract
|
getSupportedProperties(java.lang.Class<T> type)
Returns the properties that are known/supported for a specific ConferencingObject class on this connection. |
|
java.lang.String[] |
getSupportedURISchemes()
Gets the URI schemes supported by this connection. |
|
boolean |
isActive()
Tells whether the Connection is the 'active' or 'standby' Connection |
|
boolean |
isOpen()
Returns true if the connection is open. |
|
Conference |
lookupConference(Reference<Conference> ref)
Find and retrieve the specified Conference. |
|
EndPoint |
lookupEndPoint(Reference<EndPoint> ref)
Find and retrieve the specified EndPoints. |
|
void |
removeConferenceListener(ConferenceListener listener)
Unregisters a ConferenceListener previously registered against this connection. |
|
void |
removeEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener)
Unregisters a PropertyChangeListener previously registered against all properties of the EndPoints in this container. |
|
void |
removeEndPointPropertyChangeListener(java.lang.String property,
java.beans.PropertyChangeListener listener)
Unregisters a PropertyChangeListener previously registered against a specific property of the EndPoints in this container. |
|
| Methods inherited from class com.avaya.conferencing.api.acp.control.AbstractConferencingObject |
|---|
equals, execute, getVerbs, hashCode, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.avaya.conferencing.api.acp.control.EndPointContainer |
|---|
addDTMFListener, removeDTMFListener |
| Methods inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObjectContainer |
|---|
addChildListener, addChildListener, addChildPropertyChangeListener, addChildPropertyChangeListener, childClassIterator, childIterator, childIterator, findChild, findParents, getAllChildren, getAllChildren, getChildClasses, getChildren, getChildren, lookupChild, lookupParents, removeChildListener, removeChildListener, removeChildPropertyChangeListener, removeChildPropertyChangeListener |
| Methods inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObject |
|---|
addAvailableVerbsChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, execute, executeAs, getAllVerbs, getAllVerbsAs, getAllVerbsAs, getConnection, getId, getProperties, getProperties, getPropertyClass, getPropertyClasses, getPropertyType, getPropertyValue, getPropertyValues, getState, getVerbs, getVerbsAs, removeAvailableVerbsChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener |
| Field Detail |
|---|
public static final java.lang.String NAME
public static final java.lang.String OPEN
public static final java.lang.String ACTIVE
public static final java.lang.String DESCRIPTION
public static final java.lang.String DISCONNECT_REASONS
public static final java.lang.String CONFERENCE_CALL_FLOWS
public static final java.lang.String INBOUND_CALL_FLOWS
public static final java.lang.String ROOMS
public static final java.lang.String MEDIA_RESOURCE_POOLS
public static final java.lang.String MESSAGE_SETS
public static final java.lang.String SUPPORTED_URI_SCHEMES
public static final java.lang.String PARTICIPANT_ANNOUNCERS
public static final java.lang.String QA_PRIORITIES
public static final java.lang.String RECORD_PARTICIPANT_NAME_MODES
| Constructor Detail |
|---|
public Connection()
| Method Detail |
|---|
public final void addConferenceListener(ConferenceListener listener)
listener - The ConferenceListener.public abstract <T extends Operation> void applyDefaults(T operation)
T - The operation class.operation - The operation.public abstract void close()
public final java.util.Iterator<Conference> conferenceIterator()
public final java.util.Iterator<Conference> conferenceIterator(Filter<? super Conference> filter)
filter - The filter.
public final java.util.Iterator<Conference> conferenceIterator(Filter<? super Conference>... filters)
filters - The filters.
public final Conference findConference(Reference<Conference> ref)
throws UnknownChildObjectException
ref - The Conference reference.
UnknownChildObjectException - if the Conference does not exist.public abstract <T extends ConnectionSpecificResource> T[] getAvailableResources(java.lang.Class<T> type)
T - The type of ConnectionSpecificResource to query.type - The class of ConnectionSpecificResource to query.
public final java.util.Collection<Conference> getConferences()
collection.isEmpty() is preferable to 0 == collection.size() as the
latter may block until the entire collection is loaded.
public final java.util.Collection<Conference> getConferences(Filter<? super Conference> filters)
collection.isEmpty() is preferable to 0 ==
collection.size() as the latter may block until the entire collection is loaded.
filters - The filters.
public final java.lang.String getName()
public final java.lang.String getDescription()
public final EndPoint.DisconnectReason[] getDisconnectReasons()
connection.getAvailableResources(EndPoint.DisconnectReason.class)
or connection.getPropertyValue(Connection.DISCONNECT_REASONS).
public final EndPoint.QAPriority[] getQAPriorities()
connection.getAvailableResources(EndPoint.QAPriority.class) or connection.getPropertyValue(Connection.QA_PRIORITIES).
public final Conference.ParticipantAnnouncer[] getParticipantAnnouncers()
connection.getAvailableResources(EndPoint.DisconnectReason.class)
or connection.getPropertyValue(Connection.DISCONNECT_REASONS).
public final ConferenceCallFlow[] getConferenceCallFlows()
connection.getAvailableResources(ConferenceCallFlow.class) or
connection.getPropertyValue(Connection.CONFERENCE_CALL_FLOWS).
public final InboundCallFlow[] getInboundCallFlows()
connection.getAvailableResources(InboundCallFlow.class) or
connection.getPropertyValue(Connection.INBOUND_CALL_FLOWS).
public OperationFactory getOperationFactory()
public final MessageSet[] getMessageSets()
public final MediaResourcePool[] getMediaResourcePools()
Connection.getAvailableResources(MediaResource.class) or Connection.getPropertyValue(Connection.MEDIA_RESOURCES)
public final Room[] getRooms()
connection.getAvailableResources(Room.class) or
connection.getPropertyValue(Connection.ROOMS).
public final RecordParticipantNameMode[] getRecordParticipantNameModes()
connection.getAvailableResources(RecordParticipantNameMode.class)
or connection.getPropertyValue(Connection.RECORD_PARTICIPANT_NAME_MODES).
public abstract <T extends ConferencingObject<T>> java.util.Set<java.lang.String> getSupportedProperties(java.lang.Class<T> type)
ConferencingObject.getProperties() on all the instances of type but does not require the caller to
have obtained any instances of type.
Each ConferencingObject class has a set of properties. The minimum set of properties corresponds to
those for which a getter (i.e. isXXX() or getXXX() method) and a matching property name constant are defined in
the interface class. Different connections may support additional connection specific properties that expose
additional information about the ConferencingObject instances on that connection. When an instance
of the ConferencingObject is available, the properties supported by that ConferencingObject can be queried using ConferencingObject.getProperties().
Use this method when you need to get the list of property names for a specific ConferencingObject
class before an instance of that class is available.
Note: A connection may have more than one implementation of a specific ConferencingObject class. For
example there may be multiple types of Conference supported on a specific Connection
implementation. While these different implementations are required to support the same minimum set of properties
(e.g. those defined in the Conference interface), they are not required to support the same
connection specific properties. In other words, just because a property name is returned by getSupportedProperties(Class) does not imply that the property is supported by all instances of the ConferencingObject on this connection.
T - The type of ConferencingObject whose supported properties are to be queried.type - The class of ConferencingObject whose supported properties are to be queried.
java.lang.IllegalArgumentException - If the type argument is not one of this connections child classes,
that is if ConferencingObjectContainer.getChildClasses().contains(type) returns
false.public final java.lang.String[] getSupportedURISchemes()
connection that supports only the tel and sip
schemes, then the following will be true:connection.getSupportedURISchemes().length == 2;
// the order of the elements is undefined Arrays.asList(connection.getSupportedURISchemes()).contains("tel") == true; Arrays.asList(connection.getSupportedURISchemes()).contains("sip") == true; Arrays.asList(connection.getSupportedURISchemes()).contains("sips") == false;
public final boolean isOpen()
true if the connection is open.
true if the connection is open.public final boolean isActive()
public final Conference lookupConference(Reference<Conference> ref)
ref - The Conference reference.
null if the Conference does not exist.public final void removeConferenceListener(ConferenceListener listener)
listener - The ConferenceListener.public abstract java.util.Set<java.lang.Class<? extends CPAuthentication>> getAuthentications()
public abstract java.util.Set<State> getDefaultEndPointStates(java.lang.Class<? extends CPAuthentication> clazz)
null if the supplied authentication is not associated with an EndPoint (i.e. does not extend CPEndPointAuthentication).
clazz - The authentication.
null if the supplied authentication is not associated with an
EndPoint.
public abstract java.util.Set<Verb> getAllVerbsAs(java.lang.Class<? extends ConferencingObject<?>> childClass,
java.lang.Class<? extends CPAuthentication> authClass)
childClass - The type of child object.authClass - The specified type of authentication.
public final java.util.Iterator<EndPoint> endPointIterator()
endPointIterator in interface EndPointContainer<Connection>public final java.util.Iterator<EndPoint> endPointIterator(Filter<? super EndPoint>... filters)
endPointIterator in interface EndPointContainer<Connection>filters - The filters to use.
public final EndPoint findEndPoint(Reference<EndPoint> ref)
throws UnknownChildObjectException
findEndPoint in interface EndPointContainer<Connection>ref - The EndPoint reference.
UnknownChildObjectException - if the EndPoint does not exist.public final java.util.Collection<EndPoint> getEndPoints()
collection.isEmpty() is preferable to 0 == collection.size() as the
latter may block until the entire collection is loaded.
getEndPoints in interface EndPointContainer<Connection>public final java.util.Collection<EndPoint> getEndPoints(Filter<? super EndPoint>... filters)
collection.isEmpty()
is preferable to 0 == collection.size() as the latter may block until the entire collection is
loaded.
getEndPoints in interface EndPointContainer<Connection>filters - The filters which must be matched.
public final EndPoint lookupEndPoint(Reference<EndPoint> ref)
lookupEndPoint in interface EndPointContainer<Connection>ref - The EndPoint reference.
null if the EndPoint does not exist.public final void addEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener)
addEndPointPropertyChangeListener in interface EndPointContainer<Connection>listener - The PropertyChangeListener.
public final void addEndPointPropertyChangeListener(java.lang.String property,
java.beans.PropertyChangeListener listener)
addEndPointPropertyChangeListener in interface EndPointContainer<Connection>property - The property to listen for changes on.listener - The PropertyChangeListener.public final void removeEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener)
removeEndPointPropertyChangeListener in interface EndPointContainer<Connection>listener - The PropertyChangeListener.
public final void removeEndPointPropertyChangeListener(java.lang.String property,
java.beans.PropertyChangeListener listener)
removeEndPointPropertyChangeListener in interface EndPointContainer<Connection>property - The property to listen for changes on.listener - The PropertyChangeListener.
|
Avaya Conferencing Provider API | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||