org.cipango.client

Class Registration

java.lang.Object

org.cipango.client.Registration

public class Registration
extends Object

Manages the registration of a user agent.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Registration.Listener

Constructor Summary

Constructors

Constructor and Description
Registration(javax.servlet.sip.SipURI uri)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(Registration.Listener listener)
javax.servlet.sip.SipServletRequest	createRegister(javax.servlet.sip.Address contact, int expires)
List<Credentials>	getCredentials()
javax.servlet.sip.SipFactory	getFactory()
List<Registration.Listener>	getListeners()
javax.servlet.sip.Address	getOutboundProxy()
long	getTimeout()
javax.servlet.sip.SipURI	getURI()
protected void	processResponse(javax.servlet.sip.SipServletResponse response)
boolean	register(javax.servlet.sip.Address contact, int expires) Synchronously registers contact with the given expiration value.
protected void	registrationDone(javax.servlet.sip.Address contact, int expires, List<javax.servlet.sip.Address> contacts)
protected void	registrationFailed(int status)
void	removeListener(Registration.Listener listener)
void	setCredentials(List<Credentials> credentials)
void	setFactory(javax.servlet.sip.SipFactory factory)
void	setOutboundProxy(javax.servlet.sip.Address outboundProxy)
void	setTimeout(long timeout)
boolean	unregister(javax.servlet.sip.Address contact) Synchronously unregisters contact.

Methods inherited from class java.lang.Object

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

Constructor Detail

Registration

public Registration(javax.servlet.sip.SipURI uri)

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)

getURI

public javax.servlet.sip.SipURI getURI()

getListeners

public List<Registration.Listener> getListeners()

addListener

public void addListener(Registration.Listener listener)

removeListener

public void removeListener(Registration.Listener listener)

createRegister

public javax.servlet.sip.SipServletRequest createRegister(javax.servlet.sip.Address contact,
                                                 int expires)

register

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

Synchronously registers 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 Registration.

Parameters:

contact -

expires -

Returns:

true if registration was successful, false otherwise.

Throws:

IOException

javax.servlet.ServletException

unregister

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

Synchronously unregisters contact.

Parameters:

contact - the contact to unregister. If null, then * is set in the REGISTER request's Contact header, so that all contacts are unregistered.

Returns:

true if unregistration was successful, false otherwise.

Throws:

IOException

javax.servlet.ServletException

registrationDone

protected void registrationDone(javax.servlet.sip.Address contact,
                    int expires,
                    List<javax.servlet.sip.Address> contacts)

registrationFailed

protected void registrationFailed(int status)

processResponse

protected void processResponse(javax.servlet.sip.SipServletResponse response)
                        throws javax.servlet.ServletException,
                               IOException

Throws:

javax.servlet.ServletException

IOException

getOutboundProxy

public javax.servlet.sip.Address getOutboundProxy()

setOutboundProxy

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