org.cipango.client

Class UserAgent

java.lang.Object

org.cipango.client.UserAgent

public class UserAgent
extends Object

Constructor Summary

Constructors

Constructor and Description
UserAgent(javax.servlet.sip.Address aor)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCredentials(Credentials credentials)
Call	createCall(javax.servlet.sip.SipServletRequest request)
Call	createCall(javax.servlet.sip.URI remote)
javax.servlet.sip.SipServletRequest	createRequest(String method, javax.servlet.sip.Address to)
javax.servlet.sip.SipServletRequest	createRequest(String method, String to)
javax.servlet.sip.SipServletRequest	createRequest(String method, UserAgent agent)
Dialog	customize(Dialog dialog)
javax.servlet.sip.SipServletRequest	customize(javax.servlet.sip.SipServletRequest request)
javax.servlet.sip.Address	getAor()
javax.servlet.sip.Address	getContact()
List<Credentials>	getCredentials()
String	getDomain()
javax.servlet.sip.SipFactory	getFactory()
javax.servlet.sip.Address	getOutboundProxy()
Registration.Listener	getRegistrationListener()
List<javax.servlet.sip.SipServletResponse>	getResponses(javax.servlet.sip.SipServletRequest request)
long	getTimeout()
void	handleInitialRequest(javax.servlet.sip.SipServletRequest request)
boolean	register(int expires) Synchronously registers this UserAgent's contact with the given expiration value.
RequestHandler	send(javax.servlet.sip.SipServletRequest request) Sends request.
javax.servlet.sip.SipServletResponse	sendSynchronous(javax.servlet.sip.SipServletRequest request) Sends request and waits for the final response.
javax.servlet.sip.SipServletResponse	sendSynchronous(String method, javax.servlet.sip.Address to) Creates a request with the given method and destination URI and waits for the final response.
void	setContact(javax.servlet.sip.Address contact)
void	setDefaultHandler(MessageHandler handler)
void	setFactory(javax.servlet.sip.SipFactory factory)
void	setOutboundProxy(javax.servlet.sip.Address outboundProxy)
void	setRegistrationListener(Registration.Listener listener)
void	setTimeout(long timeout)
boolean	unregister() Synchronously unregisters this UserAgent's contact.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAgent

public UserAgent(javax.servlet.sip.Address aor)

Method Detail

getFactory

public javax.servlet.sip.SipFactory getFactory()

setFactory

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

getRegistrationListener

public Registration.Listener getRegistrationListener()

Returns:

the registrationListener

setRegistrationListener

public void setRegistrationListener(Registration.Listener listener)

Parameters:

registrationListener - the registrationListener to set

setContact

public void setContact(javax.servlet.sip.Address contact)

getContact

public javax.servlet.sip.Address getContact()

getOutboundProxy

public javax.servlet.sip.Address getOutboundProxy()

setOutboundProxy

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

handleInitialRequest

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

Throws:

IOException

javax.servlet.ServletException

setDefaultHandler

public void setDefaultHandler(MessageHandler handler)

register

public boolean register(int expires)
                 throws IOException,
                        javax.servlet.ServletException

Synchronously registers this UserAgent's contact with the given expiration value. This method returns either when success, failure or request timeout is encountered, and the listener, if any, is notified as well. Authentication is handled automatically if credentials were provided to this UserAgent. On success, the registration is maintained in the background by sending regularly re-REGISTER requests. Subsequent events (end of registration, failure to register) will only be reported through the listener.

Parameters:

expires - the expiration time demanded by this UserAgent.

Returns:

true if registration was successful, false otherwise.

Throws:

IOException

javax.servlet.ServletException

See Also:

Registration#register(javax.servlet.sip.URI, int)

unregister

public boolean unregister()
                   throws IOException,
                          javax.servlet.ServletException

Synchronously unregisters this UserAgent's contact. After this method returns, the contact that was previously registered is unregistered, and no background activity is sustained to register it again.

Returns:

true if unregistration was successful, false otherwise or if unregistration was a no-op.

Throws:

IOException

javax.servlet.ServletException

createCall

public Call createCall(javax.servlet.sip.URI remote)
                throws IOException,
                       javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

createCall

public Call createCall(javax.servlet.sip.SipServletRequest request)
                throws IOException,
                       javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

customize

public Dialog customize(Dialog dialog)

customize

public javax.servlet.sip.SipServletRequest customize(javax.servlet.sip.SipServletRequest request)

createRequest

public javax.servlet.sip.SipServletRequest createRequest(String method,
                                                String to)
                                                  throws javax.servlet.sip.ServletParseException

Throws:

javax.servlet.sip.ServletParseException

createRequest

public javax.servlet.sip.SipServletRequest createRequest(String method,
                                                javax.servlet.sip.Address to)

createRequest

public javax.servlet.sip.SipServletRequest createRequest(String method,
                                                UserAgent agent)

sendSynchronous

public javax.servlet.sip.SipServletResponse sendSynchronous(String method,
                                                   javax.servlet.sip.Address to)
                                                     throws IOException,
                                                            javax.servlet.ServletException

Creates a request with the given method and destination URI and waits for the final response.

Parameters:

request -

Returns:

the final response or null if no response has been received before timeout.

Throws:

IOException

javax.servlet.ServletException

See Also:

#setTimeout()}

sendSynchronous

public javax.servlet.sip.SipServletResponse sendSynchronous(javax.servlet.sip.SipServletRequest request)
                                                     throws IOException,
                                                            javax.servlet.ServletException

Sends request and waits for the final response.

Parameters:

request -

Returns:

the final response or null if no response has been received before timeout.

Throws:

IOException

javax.servlet.ServletException

See Also:

#setTimeout()}

send

public RequestHandler send(javax.servlet.sip.SipServletRequest request)
                    throws IOException,
                           javax.servlet.ServletException

Sends request.

Parameters:

request -

Returns:

the request handler.

Throws:

IOException

javax.servlet.ServletException

getResponses

public List<javax.servlet.sip.SipServletResponse> getResponses(javax.servlet.sip.SipServletRequest request)

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

getCredentials

public List<Credentials> getCredentials()

addCredentials

public void addCredentials(Credentials credentials)

getAor

public javax.servlet.sip.Address getAor()

getDomain

public String getDomain()