|
JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.util.EventObject | +--jain.protocol.ip.mgcp.JainMgcpEvent | +--jain.protocol.ip.mgcp.JainMgcpCommandEvent | +--jain.protocol.ip.mgcp.message.CreateConnection
An MGCP CreateConnection command, expressed as an event object, sent by a Call Agent to a Media Gateway to request the Gateway to create a connection between two endpoints. This command elicits a CreateConnectionResponse event.
CreateConnectionResponse
, Serialized FormFields inherited from class java.util.EventObject |
source |
Constructor Summary | |
CreateConnection(java.lang.Object source,
CallIdentifier callIdentifier,
EndpointIdentifier endpointIdentifier,
ConnectionMode mode)
Constructs a new CreateConnection (Command) Event object. |
Method Summary | |
BearerInformation |
getBearerInformation()
Gets the Bearer Information parameter. |
CallIdentifier |
getCallIdentifier()
Gets the Call Identifier. |
LocalOptionValue[] |
getLocalConnectionOptions()
Gets the Local Connection Options parameter. |
ConnectionMode |
getMode()
Gets the Mode parameter. |
NotificationRequestParms |
getNotificationRequestParms()
Gets the Notification Request parameters. |
NotifiedEntity |
getNotifiedEntity()
Gets the Notified Entity. |
ConnectionDescriptor |
getRemoteConnectionDescriptor()
Gets the Remote Connection Descriptor parameter. |
EndpointIdentifier |
getSecondEndpointIdentifier()
Gets the Second Endpoint Identifier. |
void |
setBearerInformation(BearerInformation bearerInformation)
Sets the Bearer Information parameter. |
void |
setCallIdentifier(CallIdentifier callIdentifier)
Sets the Call Identifier. |
void |
setLocalConnectionOptions(LocalOptionValue[] localConnectionOptions)
Sets the Local Connection Options parameter. |
void |
setMode(ConnectionMode mode)
Sets the Mode parameter. |
void |
setNotificationRequestParms(NotificationRequestParms notificationRequestParms)
Sets the Notification Request parameters. |
void |
setNotifiedEntity(NotifiedEntity notifiedEntity)
Sets the Notified Entity. |
void |
setRemoteConnectionDescriptor(ConnectionDescriptor remoteConnectionDescriptor)
Sets the Remote Connection Descriptor parameter. |
void |
setSecondEndpointIdentifier(EndpointIdentifier secondEndpointIdentifier)
Sets the Second Endpoint Identifier. |
java.lang.String |
toString()
Overrides java.lang.Object.toString(). |
Methods inherited from class jain.protocol.ip.mgcp.JainMgcpCommandEvent |
BuildCommandHeader, getEndpointIdentifier, setEndpointIdentifier |
Methods inherited from class jain.protocol.ip.mgcp.JainMgcpEvent |
BuildListParmLine, getObjectIdentifier, getTransactionHandle, setTransactionHandle |
Methods inherited from class java.util.EventObject |
getSource |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public CreateConnection(java.lang.Object source, CallIdentifier callIdentifier, EndpointIdentifier endpointIdentifier, ConnectionMode mode) throws java.lang.IllegalArgumentException
callIdentifier
- A globally unique parameter that identifies the call (or session) to which this
connection belongs.endpointIdentifier
- Name for the endpoint in the gateway where this command executes.mode
- Indicates the mode of operation for this side of the connection; e.g., send, receive, etc.java.lang.IllegalArgumentException
- Thrown if the call identifier, endpoint identifier, or mode parameter is null-valued.Method Detail |
public BearerInformation getBearerInformation()
public CallIdentifier getCallIdentifier()
public LocalOptionValue[] getLocalConnectionOptions()
public ConnectionMode getMode()
public NotificationRequestParms getNotificationRequestParms()
NotificationRequestParms
public NotifiedEntity getNotifiedEntity()
public ConnectionDescriptor getRemoteConnectionDescriptor()
public EndpointIdentifier getSecondEndpointIdentifier()
public void setBearerInformation(BearerInformation bearerInformation)
bearerInformation
- Optional parameter, used to encapsulate bearer information (i.e., encoding method) in
this command.public void setCallIdentifier(CallIdentifier callIdentifier) throws java.lang.IllegalArgumentException
callIdentifier
- A globally unique parameter that identifies the call (or session) to which this
connection belongs.java.lang.IllegalArgumentException
- Thrown if the call identifier parameter is null-valued.public void setLocalConnectionOptions(LocalOptionValue[] localConnectionOptions)
localConnectionOptions
- Optional parameter. A list of local connection option values. Used by the Call Agent to direct the handling
of the connection by the gateway.public void setMode(ConnectionMode mode) throws java.lang.IllegalArgumentException
mode
- Indicates the mode of operation for this side of the connection; e.g., send, receive, etc.java.lang.IllegalArgumentException
- Thrown if the mode parameter is null-valued.public void setNotificationRequestParms(NotificationRequestParms notificationRequestParms)
notificationRequestParms
- Optional parameter. Used to encapsulate notification request parameters in
this command.NotificationRequestParms
public void setNotifiedEntity(NotifiedEntity notifiedEntity)
notifiedEntity
- Optional parameter. Specifies where notifications should be sent. If not set explicitly,
notifications will be sent to originator of this command.public void setRemoteConnectionDescriptor(ConnectionDescriptor remoteConnectionDescriptor) throws ConflictingParameterException
remoteConnectionDescriptor
- Optional parameter. The connection descriptor for the remote side of a
connection, on the other side of the IP network.ConflictingParameterException
- Remote Connection Descriptor and Second Endpoint Identifier are mutually exclusive. This exception is thrown if
Second Endpoint Identifier is already set and an attempt is made to set Remote Connection Descriptor.public void setSecondEndpointIdentifier(EndpointIdentifier secondEndpointIdentifier) throws ConflictingParameterException
secondEndpointIdentifier
- Optional parameter. Used in conjunction with the endpointIdentifier to establish
a connection between
two endpoints located on the same gateway.ConflictingParameterException
- Remote Connection Descriptor and Second Endpoint Identifier are mutually exclusive. This exception is thrown if
Remote Connection Descriptor is already set and an attempt is made to set Second Endpoint Identifier .public java.lang.String toString()
toString
in class java.util.EventObject
|
JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |