org.mitre.jsip
Class SipCallMember

java.lang.Object
  |
  +--org.mitre.jsip.SipCallMember

public class SipCallMember

extends java.lang.Object

Field Summary

static int	Cancelling
static int	Connected
static int	Disconnected
static int	Disconnecting
static int	InviteRequested
static int	MessageRequested
static int	Redirected
static int	ReInviteRequested
static int	RemoteInviteRequest
static int	RemoteReInviteRequest

Constructor Summary

SipCallMember(SipCall parent, SipUri uri)
Creates a new member for this call with the given URI.

Method Summary

void	acceptBye(java.lang.String body, MimeContentType bodytype)
void	acceptInfo(java.lang.String body, MimeContentType bodytype)
void	acceptInvite(java.lang.String body, MimeContentType bodytype) Accepts the invitation to join the session sent by the call member.
void	declineInvite(java.lang.String body, MimeContentType bodytype) Declines the invitation to join the session sent by the call member.
SipUri	getContactUri() Returns the current Contact URI for this call member.
java.lang.String	getLocalSessionDescription() Returns the most recently sent local session description.
MimeContentType	getLocalSessionDescriptionType() Returns the MIME Content Type of the most recently sent local session description.
java.lang.String	getLocalStatusDescription() Returns a text description of our current status.
java.lang.String	getMostRecentMessageBody() Returns the most recent message body we received that was not a session description.
MimeContentType	getMostRecentMessageBodyType() Returns the MIME type of the most recent message body we received that was not a session description.
SipUriList	getRedirectList() Returns the list of URIs where we were redirected.
java.lang.String	getSessionDescription() Returns the most recent session description provided by the member for sending media to them.
MimeContentType	getSessionDescriptionType() Returns the MIME Content Type of the session description provided by the call member.
int	getStatus() Returns the current status of the call member.
SipUri	getUri() Returns the URI for this call member.
void	requestCancel() Send a CANCEL msg for the given request
void	requestDisconnect(java.lang.String body, MimeContentType bodytype) Sends a SIP BYE request to disconnect the session.
void	requestInfo(java.lang.String body, MimeContentType bodytype) Requests an INFO message
void	requestInvite(java.lang.String body, MimeContentType bodytype) Sends a SIP INVITE request, asking the member to join in the session described in the given body.
void	requestMessage(java.lang.String messageBody) Sends a MESSAGE request
void	requestNotify(java.lang.String body, MimeContentType bodytype) Request a NOTIFY message be sent
void	requestOptions(java.lang.String body, MimeContentType bodytype) Sends a SIP OPTIONS request, asking the member what they support.
void	requestSubscribe(java.lang.String body, MimeContentType bodytype) Request a SUBSCRIBE message be sent
void	requestTransfer(SipUri transferto, java.lang.String body, MimeContentType bodytype) Disconnects the session with a request to transfer to another party.
void	setContactUri(SipUri newcontact) Sets the Contact URI for this call member.
void	setUri(SipUri newuri) Updates the URI for this call member.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Disconnected

public static final int Disconnected

InviteRequested

public static final int InviteRequested

ReInviteRequested

public static final int ReInviteRequested

RemoteInviteRequest

public static final int RemoteInviteRequest

RemoteReInviteRequest

public static final int RemoteReInviteRequest

Redirected

public static final int Redirected

Connected

public static final int Connected

Disconnecting

public static final int Disconnecting

MessageRequested

public static final int MessageRequested

Cancelling

public static final int Cancelling

Constructor Detail

SipCallMember

public SipCallMember(SipCall parent,
                     SipUri uri)

Creates a new member for this call with the given URI. Initially, this sets the Contact URI for the call member to be the same.

Parameters:

parent -

uri -

Method Detail

getStatus

public int getStatus()

Returns the current status of the call member.

Returns:

Status

getSessionDescription

public java.lang.String getSessionDescription()

Returns the most recent session description provided by the member for sending media to them.

Returns:

String

getSessionDescriptionType

public MimeContentType getSessionDescriptionType()

Returns the MIME Content Type of the session description provided by the call member. If none was provided, this function returns NULL.

Returns:

MimeContentType

getLocalSessionDescription

public java.lang.String getLocalSessionDescription()

Returns the most recently sent local session description. Provided for reference.

Returns:

String

getLocalSessionDescriptionType

public MimeContentType getLocalSessionDescriptionType()

Returns the MIME Content Type of the most recently sent local session description.

Returns:

MimeContentType

getLocalStatusDescription

public java.lang.String getLocalStatusDescription()

Returns a text description of our current status. Basically, this is the text from the response line of the last message we received, or a text description of what we're currently doing or waiting for. Useful for showing the user what is going on.

Returns:

String

getMostRecentMessageBody

public java.lang.String getMostRecentMessageBody()

Returns the most recent message body we received that was not a session description.

Returns:

String

getMostRecentMessageBodyType

public MimeContentType getMostRecentMessageBodyType()

Returns the MIME type of the most recent message body we received that was not a session description.

Returns:

MimeContentType

requestInvite

public void requestInvite(java.lang.String body,
                          MimeContentType bodytype)

Sends a SIP INVITE request, asking the member to join in the session described in the given body. The body and MIME type provided will become the new local session description for this call member.

requestCancel

public void requestCancel()

Send a CANCEL msg for the given request

requestDisconnect

public void requestDisconnect(java.lang.String body,
                              MimeContentType bodytype)

Sends a SIP BYE request to disconnect the session.

requestTransfer

public void requestTransfer(SipUri transferto,
                            java.lang.String body,
                            MimeContentType bodytype)

Disconnects the session with a request to transfer to another party.

requestMessage

public void requestMessage(java.lang.String messageBody)

Sends a MESSAGE request

requestOptions

public void requestOptions(java.lang.String body,
                           MimeContentType bodytype)

Sends a SIP OPTIONS request, asking the member what they support. The body and MIME type provided serve no known purpose at this time. The response to the OPTIONS request will become the new remote session description, so this should not be called on an active call. It is provided here for consistency.

requestInfo

public void requestInfo(java.lang.String body,
                        MimeContentType bodytype)

Requests an INFO message

Parameters:

body - The body of the INFO message

bodytype - The content type of the body

requestSubscribe

public void requestSubscribe(java.lang.String body,
                             MimeContentType bodytype)

Request a SUBSCRIBE message be sent

requestNotify

public void requestNotify(java.lang.String body,
                          MimeContentType bodytype)

Request a NOTIFY message be sent

acceptInvite

public void acceptInvite(java.lang.String body,
                         MimeContentType bodytype)

Accepts the invitation to join the session sent by the call member. The body and MIME type provided will become the new local session description for this call member.

acceptBye

public void acceptBye(java.lang.String body,
                      MimeContentType bodytype)

acceptInfo

public void acceptInfo(java.lang.String body,
                       MimeContentType bodytype)

declineInvite

public void declineInvite(java.lang.String body,
                          MimeContentType bodytype)

Declines the invitation to join the session sent by the call member. The body and MIME type provided are for possibly giving a reason as to why the call was declined.

getUri

public SipUri getUri()

Returns the URI for this call member.

Returns:

SipUri &

getContactUri

public SipUri getContactUri()

Returns the current Contact URI for this call member.

Returns:

SipUri &

setContactUri

public void setContactUri(SipUri newcontact)

Sets the Contact URI for this call member.

Parameters:

newcontact -

setUri

public void setUri(SipUri newuri)

Updates the URI for this call member.

Parameters:

newuri -

getRedirectList

public SipUriList getRedirectList()

Returns the list of URIs where we were redirected.

Returns:

SipUriList &