com.ibm.soa.parlayx21.multimedia_conference
Interface MultimediaConference

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
MultimediaConference_RI
All Known Implementing Classes:
MultimediaConferenceBindingStub, MultimediaConferenceProxy

public interface MultimediaConference
extends java.rmi.Remote

The multimedia conference interface manages the conference.

The MultimediaConference interface can be used by an application for creating a multimedia conference call and for dynamically managing the participants and the media involved in the call.


Method Summary
 void addMediaForParticipant(java.lang.String conferenceIdentifer, java.net.URI participant, Media media, MediaDirection direction)
          The invocation of addMediaForParticipant requests to add a media stream to the media set used by participant.
 java.lang.String createConference(java.lang.String conferenceType, java.lang.String conferenceDescription, ChargingInformation charging, java.lang.Integer maximumDuration, int maximumNumberOfParticipants, java.net.URI conferenceOwner)
          The invocation of createConference requests to create a multi-media conference with initially no participants connected.
 void deleteMediaForParticipant(java.lang.String conferenceIdentifer, java.net.URI participant, Media media, MediaDirection direction)
          The invocation of deleteMediaForParticipant requests to remove a media stream from the media set used by participant.
 void disconnectParticipant(java.lang.String conferenceIdentifier, java.net.URI participant)
          The invocation of disconnectParticipant requests to disconnect the participant specified by participant from the multi-media conference call identified by conferenceIdentifier.
 void endConference(java.lang.String conferenceIdentifier)
          The invocation of endConference requests to terminate the multi-media conference call identified by conferenceIdentifier.
 ConferenceInfo getConferenceInfo(java.lang.String conferenceIdentifier)
          The invocation of getConferenceInfo requests the information concerning the current status of the multi-media conference call identified by conferenceIdentifier.
 ParticipantInfo getParticipantInfo(java.lang.String conferenceIdentifier, java.net.URI participant)
          The participant information describes the participant.
 ParticipantInfo[] getParticipants(java.lang.String conferenceIdentifier)
          The invocation of getParticipants requests information concerning the current status of each participant of the multi-media conference call identified by conferenceIdentifier.
 void inviteParticipant(java.lang.String conferenceIdentifier, java.net.URI participant)
          The invocation of inviteParticipant requests to add a new participant specified by participant to the multi-media conference call identified by conferenceIdentifier.
 

Method Detail

createConference

java.lang.String createConference(java.lang.String conferenceType,
                                  java.lang.String conferenceDescription,
                                  ChargingInformation charging,
                                  java.lang.Integer maximumDuration,
                                  int maximumNumberOfParticipants,
                                  java.net.URI conferenceOwner)
                                  throws java.rmi.RemoteException,
                                         PolicyException,
                                         ServiceException

The invocation of createConference requests to create a multi-media conference with initially no participants connected. The reference to the new multimedia conference is returned in the output parameter.

The conference termination can be driven either by a user action or by the expiring of a maximum duration. In particular, three possible situations are considered. In the first scenario, the concept of the "conference owner" is used. This user that has the control of the call and when the conference owner leaves the conference, all users are disconnected (such a user could be for instance the reference for the conference billing). In this scenario, the optional part conferenceOwner is present in the request message.

In the second scenario, the conference is terminated when the last participant abandons (in this case the part conferenceOwner is not present).

A third case is when the optional part maximumDuration is present: in this situation, when the maximum duration is reached, the conference is terminated.

The selection of the scenario depends on the presence of the optional parts; if no optional part is present, the conference end condition is the disconnection of the last user in conference, if both are present, the conference is terminated when the duration expires (this case could happen if the information concerning the conference owner is needed for billing purposes).

The values of the maximumDuration and maximumNumberOfParticipants parts must not exceed the corresponding service policies otherwise a policy exception is raised.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.
  * POL0008: Charging not supported.
  * POL0240: Too many participants.
  * POL0242: Maximum duration exceeded.

Parameters:
conferenceType - xsd:string Conference type, for example, one of a list of operator-specific identifiers that indicates how the conference is rendered on the terminals
conferenceDescription - xsd:string A text describing the conference
charging - common:Charging
maximumDuration - xsd:int

If present it represents the maximum duration of the multimedia conference in seconds. If this part is present, it represents the end condition of the conference.

maximumNumberOfParticipants - xsd:int Maximum number of participants allowed
conferenceOwner - xsd:anyURI It is the address of the multimedia conference owner. If this part is present, and the maximumDuration is not present, the conference is terminated when this user disconnects, else this information can be used for billing or other purpose
Returns:

If present, defines the charge per unit of time consumed on the conference call. If the service does not support charging, a PolicyException (POL0008) will be returned.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getConferenceInfo

ConferenceInfo getConferenceInfo(java.lang.String conferenceIdentifier)
                                 throws java.rmi.RemoteException,
                                        PolicyException,
                                        ServiceException

The invocation of getConferenceInfo requests the information concerning the current status of the multi-media conference call identified by conferenceIdentifier.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Parameters:
conferenceIdentifier - xsd:string Conference identifier
Returns:
conferenceInforesult ConferenceInfo Status of the conference
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

endConference

void endConference(java.lang.String conferenceIdentifier)
                   throws java.rmi.RemoteException,
                          PolicyException,
                          ServiceException

The invocation of endConference requests to terminate the multi-media conference call identified by conferenceIdentifier.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

inviteParticipant

void inviteParticipant(java.lang.String conferenceIdentifier,
                       java.net.URI participant)
                       throws java.rmi.RemoteException,
                              PolicyException,
                              ServiceException

The invocation of inviteParticipant requests to add a new participant specified by participant to the multi-media conference call identified by conferenceIdentifier. The media used for the initial connection of the new participant depends on the conference type and the participant's supported media.

The operation will fail if the conference has already reached the maximum number of participants (as specified in the creation operation).

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.
  * POL0240: Too many participants.

Parameters:
conferenceIdentifier - xsd:string Conference identifier
participant - xsd:anyURI New participant invited
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

disconnectParticipant

void disconnectParticipant(java.lang.String conferenceIdentifier,
                           java.net.URI participant)
                           throws java.rmi.RemoteException,
                                  PolicyException,
                                  ServiceException

The invocation of disconnectParticipant requests to disconnect the participant specified by participant from the multi-media conference call identified by conferenceIdentifier.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Parameters:
conferenceIdentifier - xsd:string Conference identifier
participant - xsd:anyURI Participant
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getParticipantInfo

ParticipantInfo getParticipantInfo(java.lang.String conferenceIdentifier,
                                   java.net.URI participant)
                                   throws java.rmi.RemoteException,
                                          PolicyException,
                                          ServiceException

The participant information describes the participant.

The invocation of getParticipantInfo requests information concerning the current status of the participant specified by participant, in the multi-media conference call identified by conferenceIdentifier.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Parameters:
conferenceIdentifier - xsd:string Conference identifier
participant - xsd:anyURI Participant
Returns:
participantInforesult ParticipantInfo Status of the participant
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getParticipants

ParticipantInfo[] getParticipants(java.lang.String conferenceIdentifier)
                                  throws java.rmi.RemoteException,
                                         PolicyException,
                                         ServiceException

The invocation of getParticipants requests information concerning the current status of each participant of the multi-media conference call identified by conferenceIdentifier. The output includes participants already disconnected from the conference (if any).

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Parameters:
conferenceIdentifier - xsd:string Conference identifier
Returns:
participantsresult ParticipantInfo [0..unbounded] Array containing status information for each participant
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

addMediaForParticipant

void addMediaForParticipant(java.lang.String conferenceIdentifer,
                            java.net.URI participant,
                            Media media,
                            MediaDirection direction)
                            throws java.rmi.RemoteException,
                                   PolicyException,
                                   ServiceException

The invocation of addMediaForParticipant requests to add a media stream to the media set used by participant. The operation is executed on a single participant connected to the multi-media conference call identified by conferenceIdentifier. The new media has to be compatible with the type of multimedia conference and the set of media supported by the participant terminal, otherwise the operation will fail.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.
  * POL0241: Unavailable media.

Parameters:
participant - xsd:anyURI Participant
media - Media It identifies the new media stream the participant will receive/send
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

deleteMediaForParticipant

void deleteMediaForParticipant(java.lang.String conferenceIdentifer,
                               java.net.URI participant,
                               Media media,
                               MediaDirection direction)
                               throws java.rmi.RemoteException,
                                      PolicyException,
                                      ServiceException

The invocation of deleteMediaForParticipant requests to remove a media stream from the media set used by participant. The operation is executed on a single participant connected to the multi-media conference call identified by conferenceIdentifier.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Parameters:
participant - xsd:anyURI Participant
media - Media It identifies the media the user is not enabled to use any more
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.