org.cipango.client

Class Dialog

java.lang.Object

org.cipango.client.Dialog

Direct Known Subclasses:

Call, Publisher

public class Dialog
extends Object

A SIP Dialog abstraction.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.sip.SipSession	_session
static String	INITIAL_REQUEST_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
Dialog()

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(javax.servlet.sip.SipServletRequest request) Opens a dialog with an incoming request.
javax.servlet.sip.SipServletRequest	createInitialRequest(String method, javax.servlet.sip.Address local, javax.servlet.sip.Address remote)
javax.servlet.sip.SipServletRequest	createInitialRequest(String method, javax.servlet.sip.URI local, javax.servlet.sip.URI remote) Creates the request that should initiate the dialog.
javax.servlet.sip.SipServletRequest	createRequest(String method)
List<Credentials>	getCredentials()
javax.servlet.sip.SipFactory	getFactory()
javax.servlet.sip.Address	getOutboundProxy()
javax.servlet.sip.SipSession	getSession()
SessionHandler	getSessionHandler()
long	getTimeout()
void	setCredentials(List<Credentials> credentials)
void	setFactory(javax.servlet.sip.SipFactory factory)
void	setOutboundProxy(javax.servlet.sip.Address outboundProxy)
void	setTimeout(long timeout)
void	start(javax.servlet.sip.SipServletRequest request) Starts this dialog.
void	terminate(javax.servlet.sip.SipServletRequest request) Synchronously ends this dialog.
void	updateDialog(javax.servlet.sip.SipServletResponse response) Update the dialog with the response.
javax.servlet.sip.SipServletResponse	waitForFinalResponse()
javax.servlet.sip.SipServletRequest	waitForRequest()
javax.servlet.sip.SipServletResponse	waitForResponse()

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_REQUEST_ATTRIBUTE

public static final String INITIAL_REQUEST_ATTRIBUTE

See Also:

Constant Field Values

_session

protected javax.servlet.sip.SipSession _session

Constructor Detail

Dialog

public Dialog()

Method Detail

getFactory

public javax.servlet.sip.SipFactory getFactory()

setFactory

public void setFactory(javax.servlet.sip.SipFactory factory)

getCredentials

public List<Credentials> getCredentials()

setCredentials

public void setCredentials(List<Credentials> credentials)

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

getSession

public javax.servlet.sip.SipSession getSession()

accept

public void accept(javax.servlet.sip.SipServletRequest request)
            throws javax.servlet.ServletException

Opens a dialog with an incoming request.

The dialog is configured with the given request. The method returns immediately and the caller should then prepare and send its response. so as to finish the dialog establishment.

Parameters:

request - The request that was received and which opens this dialog.

Throws:

javax.servlet.ServletException

start

public void start(javax.servlet.sip.SipServletRequest request)
           throws IOException,
                  javax.servlet.ServletException

Starts this dialog.

The dialog is configured and the given request is sent. The method returns immediately after the request is sent. The caller then should Call waitForResponse or waitForFinalResponse on this dialog and react accordingly so as to finish the dialog establishment.

Parameters:

request - The request that will be sent to open this dialog. Ideally, this request was created with createInitialRequest, or with a specialized method in child classes and eventually tweaked as desired afterwards.

Throws:

IOException

javax.servlet.ServletException

terminate

public void terminate(javax.servlet.sip.SipServletRequest request)
               throws IOException

Synchronously ends this dialog.

Parameters:

request -

Throws:

IOException

createInitialRequest

public javax.servlet.sip.SipServletRequest createInitialRequest(String method,
                                                       javax.servlet.sip.URI local,
                                                       javax.servlet.sip.URI remote)

Creates the request that should initiate the dialog.

The initial request being dependent on the kind of dialog, this method is to be implemented by the dialog specialization classes. The caller is authorized to complete it before providing it to start.

Parameters:

local - the URI of the local user agent, the one which is creating this dialog.

remote - the URI of the remote agent in the dialog.

Returns:

The brand new request, associated to this dialog.

createInitialRequest

public javax.servlet.sip.SipServletRequest createInitialRequest(String method,
                                                       javax.servlet.sip.Address local,
                                                       javax.servlet.sip.Address remote)

createRequest

public javax.servlet.sip.SipServletRequest createRequest(String method)

waitForRequest

public javax.servlet.sip.SipServletRequest waitForRequest()

waitForResponse

public javax.servlet.sip.SipServletResponse waitForResponse()

waitForFinalResponse

public javax.servlet.sip.SipServletResponse waitForFinalResponse()

getSessionHandler

public SessionHandler getSessionHandler()

getOutboundProxy

public javax.servlet.sip.Address getOutboundProxy()

setOutboundProxy

public void setOutboundProxy(javax.servlet.sip.Address outboundProxy)

updateDialog

public void updateDialog(javax.servlet.sip.SipServletResponse response)

Update the dialog with the response. Could be needed if there has been multiple dialogs.