sdt.ext.interfaces
Interface SDT_Manager_URI_I


public interface SDT_Manager_URI_I


Method Summary
 PartyInBridgeURI addParty(PartyURI party, BridgeURI toBridge)
          Request that someone be moved from the limbo state onto a bridge This is used for the calling party in an intercepted call attempt.
 java.util.UUID addTrigger(SessionURI session, IPredicate.Expr te, TriggerKind t)
          add a trigger predicate.
 void dropBridge(BridgeURI bridge)
          Drop a bridge from its session.
 void dropParty(PartyInBridgeURI party)
          Remove a party from its bridge
 void dropSession(SessionURI session)
          Drop a session from the environment.
 void dropTrigger(SessionURI session, java.util.UUID trigger)
          drop a trigger
 BridgeURI[] getBridges(SessionURI session)
          Returns a list of bridges available for use within the given Session
 PartyInBridgeURI[] getParticipants(BridgeURI bridge)
          Returns a list of participants in a given bridge instance
 PartyInBridgeURI[] getParticipants(SessionURI session)
          Returns a list of participants in a given session instance
 java.lang.String getParticipantState(PartyInBridgeURI participant)
          Returns the current state of a participant as a string
 SessionURI[] getSessionsURI(java.lang.String app)
          Returns a list of sessions attached to an application
 java.lang.Boolean isNotification(SessionURI session, NotificationType type)
          Tests to see if notification type is set See setNotification for a more detailed explaination of the notification.
 void move(BridgeURI fromBridge, PartyInBridgeURI participant, BridgeURI toBridge)
          Request that someone be moved from one bridge to another within the same session The participant keeps the state and role from the first session to the second.
 BridgeURI newBridge(SessionURI session, Media media, java.net.URI statemachine)
          Request that a new bridge be added to a session
 PartyInBridgeURI newParty(BridgeURI bridge, PartyURI party, Role role, PartyURI requestingParty)
          Request the addition of a new party to a bridge in a session.
 SessionURI newSession(java.lang.String appname)
          Request that a new session be created
 void request(PartyInBridgeURI participant, IEvent event)
          Request a state transition for the specified participant.
 void setNotification(SessionURI session, NotificationType type)
          Sets the notification type for the specified session As network events are being processed by the manager, the application has the ability of having those events forwarded to its server instance.
 

Method Detail

getSessionsURI

SessionURI[] getSessionsURI(java.lang.String app)
                            throws ServerException
Returns a list of sessions attached to an application

Parameters:
app - application identifier
Throws:
ServerException

getBridges

BridgeURI[] getBridges(SessionURI session)
                       throws ServerException
Returns a list of bridges available for use within the given Session

Throws:
ServerException

getParticipants

PartyInBridgeURI[] getParticipants(SessionURI session)
                                   throws ServerException
Returns a list of participants in a given session instance

Throws:
ServerException

getParticipants

PartyInBridgeURI[] getParticipants(BridgeURI bridge)
                                   throws ServerException
Returns a list of participants in a given bridge instance

Throws:
ServerException

getParticipantState

java.lang.String getParticipantState(PartyInBridgeURI participant)
                                     throws ServerException
Returns the current state of a participant as a string

Throws:
ServerException

request

void request(PartyInBridgeURI participant,
             IEvent event)
             throws ServerException
Request a state transition for the specified participant. The transition is specified by its associated event name.

Throws:
ServerException

move

void move(BridgeURI fromBridge,
          PartyInBridgeURI participant,
          BridgeURI toBridge)
          throws ServerException
Request that someone be moved from one bridge to another within the same session The participant keeps the state and role from the first session to the second.

Parameters:
fromBridge - source bridge
party -
toBridge - target bridge This fails if the from- and to- bridges belong to different sessions, or if the participant does not belong to the fromBridge.
Throws:
ServerException

addParty

PartyInBridgeURI addParty(PartyURI party,
                          BridgeURI toBridge)
                          throws ServerException
Request that someone be moved from the limbo state onto a bridge This is used for the calling party in an intercepted call attempt. The party has yet to be on any bridge.

Throws:
ServerException

newSession

SessionURI newSession(java.lang.String appname)
                      throws ServerException
Request that a new session be created

Parameters:
appname - the application requesting the creation
Returns:
identifier for the new session; null if unsuccessful
Throws:
ServerException

dropSession

void dropSession(SessionURI session)
                 throws ServerException
Drop a session from the environment. *NEED NOT* drop bridges associated with the session.

Throws:
ServerException

newBridge

BridgeURI newBridge(SessionURI session,
                    Media media,
                    java.net.URI statemachine)
                    throws ServerException
Request that a new bridge be added to a session

Parameters:
media - specifies the media type (Voice/Video ..)
statemachine - specifies the name of a state machine. [Available state machines are controlled by the SM provider. Each state machine specifies a set of state names, transition names, and a default implementation for each transition.]
Throws:
ServerException

dropBridge

void dropBridge(BridgeURI bridge)
                throws ServerException
Drop a bridge from its session. *NEED NOT* drop parties associated with the bridge.

Throws:
ServerException

newParty

PartyInBridgeURI newParty(BridgeURI bridge,
                          PartyURI party,
                          Role role,
                          PartyURI requestingParty)
                          throws ServerException
Request the addition of a new party to a bridge in a session. The party *cannot* be the calling party in an intercepted call; that situation is handled by . Here, the party can be either the callee in an intercepted call, or an independently specified party. The requestingParty must be the caller, if the new party is the callee in an intercepted call. Otherwise, the requesting party can be set freely.

Returns:
an identifier for the party as connected to a bridge
Throws:
ServerException

dropParty

void dropParty(PartyInBridgeURI party)
               throws ServerException
Remove a party from its bridge

Throws:
ServerException

addTrigger

java.util.UUID addTrigger(SessionURI session,
                          IPredicate.Expr te,
                          TriggerKind t)
                          throws ServerException,
                                 java.io.IOException,
                                 java.net.URISyntaxException,
                                 java.lang.Exception
add a trigger predicate.

Returns:
a unique identity for this trigger, which is used to send out notifications whenever the predicate becomes true.
Throws:
ServerException
java.io.IOException
java.net.URISyntaxException
java.lang.Exception

dropTrigger

void dropTrigger(SessionURI session,
                 java.util.UUID trigger)
                 throws ServerException
drop a trigger

Throws:
ServerException

setNotification

void setNotification(SessionURI session,
                     NotificationType type)
                     throws ServerException
Sets the notification type for the specified session As network events are being processed by the manager, the application has the ability of having those events forwarded to its server instance. Based on the type of notification requested, the event can go through a selection of filters prior to passing to the application server, thus improving the performance of the overall call processing flow.

Parameters:
session - the session whose notification type we wish to set
type - the type of notification we wish the session to have
Throws:
ServerException

isNotification

java.lang.Boolean isNotification(SessionURI session,
                                 NotificationType type)
                                 throws ServerException
Tests to see if notification type is set See setNotification for a more detailed explaination of the notification.

Parameters:
session - the session whose notification type we wish to test
type - the type of notification we are checking for
Returns:
true if the specified type matches the current setting; false otherwise
Throws:
ServerException