4.1.0.610 20071213

ch.ecma.csta.binding
Class AttachMediaService

java.lang.Object
  extended by ch.ecma.csta.CastorObject
      extended by ch.ecma.csta.binding.AttachMediaService
All Implemented Interfaces:
java.io.Serializable

public class AttachMediaService
extends ch.ecma.csta.CastorObject
implements java.io.Serializable

Not supported.
Attaches an existing call to a media service instance for the purpose of transmitting media stream data to the call or receiving media stream data from the call.

The attachment is made at a connection associated with a media attachment device (MAD). The attachment may be performed by the switching function selecting a MAD and adding it to the call by means of a call control request(s) (for example, Conference Call, Transfer Call, Deflect Call, Directed Pickup Call, Join Call), or may be performed via a device already in the call (that has media access capabilities). At the completion of this service request a MediaAttachedEvent is generated on monitors associated with the specified call or device. This event may contain the associated mediaStreamID for accessing the media service instance.

The service request specifies a media service instance by choosing appropriate values for the mediaServiceType and mediaServiceInstanceID parameters, and a connectionMode parameter that specifies how the attachment is to be made.

The roles played by the various devices in the call, and the means by which the attachment is performed, depend upon the connectionMode. The connectionMode consists of a set of values that specify the call control service(s) that is to be applied to the connection so that the MAD can be added to the call, or the value of direct, which specifies that the MAD is already part of the call.

Refer to the specification of the call control service(s) associated with the specified connectionMode for a description of both the operational model and the connection state transitions..

The monitoring event sequence for both device-type and call-type monitoring are Call Control events (dependent upon the connectionMode parameter) and a Media Attached event.

Note that the Media Attached event may be generated before other call control events associated with adding the media access device to the call.

CSTA Functional Implementation:

  1. If the computing function is monitoring the call or any devices in the call, it will be prepared to receive the call control events, if any, associated with adding the media access device to the call (for example, Conferenced, Transferred, Held) events.
  2. The specification of the call control service(s) (service description, operational model, CSTA Functional Requirements, etc.) that are described by the connectionMode parameter apply to the Attach Media service.
  3. Multiple attachments to media services for the same call and connection are possible. However, implementations may place limits on the number of such attachments. Each additional attachment may or may not involve a conference/transfer operation (as in the case of the first attachment). If the computing function tries to attach a mediaServiceType to a connection that already has that mediaServiceType attached, the request will be rejected by the switching function.
  4. Authentication with the media service is not implied by a positive acknowledgement to an Attach Media Service service request. The computing function will open a session to and authenticate to the media service through the appropriate mechanisms.
  5. Versioning of the media service is supported via a separate mediaServiceVersion parameter. With respect to this service, however, different versions of a media service are treated as if they were different media services.
  6. The switching function may place restrictions on the services that may be applied to a media access device. As a result, the computing function should always use the DetachMediaService service to release the binding of the media service instance from the call rather than trying to manipulate the media access device directly using other call control services.
  7. The mediaConnection and mediaDevice parameters in the positive acknowledgement to this service will be provided only if the connectionMode parameter in the service request is any value other than "direct".

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
AttachMediaService()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Note: hashCode() has not been overriden
 ConnectionID getConnection()
          Returns the value of field 'connection'.
 ConnectionMode getConnectionMode()
          Returns the value of field 'connectionMode'.
 CSTACommonArguments getExtensions()
          Returns the value of field 'extensions'.
 java.lang.String getMediaServiceInstanceID()
          Returns the value of field 'mediaServiceInstanceID'.
 MediaServiceType getMediaServiceType()
          Returns the value of field 'mediaServiceType'.
 java.lang.Long getMediaServiceVersion()
          Returns the value of field 'mediaServiceVersion'.
 LocalConnectionState getRequestedConnectionState()
          Returns the value of field 'requestedConnectionState'.
 boolean isValid()
          Method isValid
 void marshal(org.xml.sax.ContentHandler handler)
          Method marshal
 void marshal(java.io.Writer out)
          Method marshal
 void setConnection(ConnectionID connection)
          Sets the value of field 'connection'.
 void setConnectionMode(ConnectionMode connectionMode)
          Sets the value of field 'connectionMode'.
 void setExtensions(CSTACommonArguments extensions)
          Sets the value of field 'extensions'.
 void setMediaServiceInstanceID(java.lang.String mediaServiceInstanceID)
          Sets the value of field 'mediaServiceInstanceID'.
 void setMediaServiceType(MediaServiceType mediaServiceType)
          Sets the value of field 'mediaServiceType'.
 void setMediaServiceVersion(java.lang.Long mediaServiceVersion)
          Sets the value of field 'mediaServiceVersion'.
 void setRequestedConnectionState(LocalConnectionState requestedConnectionState)
          Sets the value of field 'requestedConnectionState'.
static AttachMediaService unmarshalAttachMediaService(java.io.Reader reader)
          Method unmarshalAttachMediaService
 void validate()
          Method validate
 
Methods inherited from class ch.ecma.csta.CastorObject
getOldSessionID, hashCode, setOldSessionID, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AttachMediaService

public AttachMediaService()
Method Detail

equals

public boolean equals(java.lang.Object obj)
Note: hashCode() has not been overriden

Overrides:
equals in class ch.ecma.csta.CastorObject
Parameters:
obj -
Returns:
boolean

getConnection

public ConnectionID getConnection()
Returns the value of field 'connection'. The field 'connection' has the following description: Specifies the connection at the attaching device. Mandatory.

Returns:
ConnectionID

getConnectionMode

public ConnectionMode getConnectionMode()
Returns the value of field 'connectionMode'. The field 'connectionMode' has the following description: Specifies the requested media service connection mode. Mandatory.

The complete set of possible values is:

Returns:
ConnectionMode

getExtensions

public CSTACommonArguments getExtensions()
Returns the value of field 'extensions'.

Returns:
CSTACommonArguments

getMediaServiceInstanceID

public java.lang.String getMediaServiceInstanceID()
Returns the value of field 'mediaServiceInstanceID'. The field 'mediaServiceInstanceID' has the following description: Specifies the desired media service instance. Optional.

Returns:
String

getMediaServiceType

public MediaServiceType getMediaServiceType()
Returns the value of field 'mediaServiceType'. The field 'mediaServiceType' has the following description: Specifies the requested media service type. Mandatory.

Returns:
MediaServiceType

getMediaServiceVersion

public java.lang.Long getMediaServiceVersion()
Returns the value of field 'mediaServiceVersion'. The field 'mediaServiceVersion' has the following description: Specifies the version of the media services. Optional.

Returns:
Long

getRequestedConnectionState

public LocalConnectionState getRequestedConnectionState()
Returns the value of field 'requestedConnectionState'. The field 'requestedConnectionState' has the following description: Specifies the connection state in which the MAD will be at the time that the Media Attached event is generated. Optional.

Returns:
LocalConnectionState

isValid

public boolean isValid()
Method isValid

Returns:
boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Method marshal

Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Method marshal

Parameters:
handler -
Throws:
java.io.IOException
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

setConnection

public void setConnection(ConnectionID connection)
Sets the value of field 'connection'. The field 'connection' has the following description: Specifies the connection at the attaching device. Mandatory.

Parameters:
connection - the value of field 'connection'.

setConnectionMode

public void setConnectionMode(ConnectionMode connectionMode)
Sets the value of field 'connectionMode'. The field 'connectionMode' has the following description: Specifies the requested media service connection mode. Mandatory.

The complete set of possible values is:

Parameters:
connectionMode - the value of field 'connectionMode'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)
Sets the value of field 'extensions'.

Parameters:
extensions - the value of field 'extensions'.

setMediaServiceInstanceID

public void setMediaServiceInstanceID(java.lang.String mediaServiceInstanceID)
Sets the value of field 'mediaServiceInstanceID'. The field 'mediaServiceInstanceID' has the following description: Specifies the desired media service instance. Optional.

Parameters:
mediaServiceInstanceID - the value of field 'mediaServiceInstanceID'.

setMediaServiceType

public void setMediaServiceType(MediaServiceType mediaServiceType)
Sets the value of field 'mediaServiceType'. The field 'mediaServiceType' has the following description: Specifies the requested media service type. Mandatory.

Parameters:
mediaServiceType - the value of field 'mediaServiceType'

setMediaServiceVersion

public void setMediaServiceVersion(java.lang.Long mediaServiceVersion)
Sets the value of field 'mediaServiceVersion'. The field 'mediaServiceVersion' has the following description: Specifies the version of the media services. Optional.

Parameters:
mediaServiceVersion - the value of field 'mediaServiceVersion'.

setRequestedConnectionState

public void setRequestedConnectionState(LocalConnectionState requestedConnectionState)
Sets the value of field 'requestedConnectionState'. The field 'requestedConnectionState' has the following description: Specifies the connection state in which the MAD will be at the time that the Media Attached event is generated. Optional.

Parameters:
requestedConnectionState - the value of field 'requestedConnectionState'.

unmarshalAttachMediaService

public static AttachMediaService unmarshalAttachMediaService(java.io.Reader reader)
                                                      throws org.exolab.castor.xml.MarshalException,
                                                             org.exolab.castor.xml.ValidationException
Method unmarshalAttachMediaService

Parameters:
reader -
Returns:
AttachMediaService
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Method validate

Throws:
org.exolab.castor.xml.ValidationException

4.1.0.610 20071213

Copyright 2004 Avaya Inc All Rights Reserved.