org.cipango.client

Class AbstractChallengedMessageHandler

java.lang.Object

org.cipango.client.AbstractChallengedMessageHandler

All Implemented Interfaces:

ChallengedMessageHandler, MessageHandler

Direct Known Subclasses:

RequestHandler, SessionHandler

public abstract class AbstractChallengedMessageHandler
extends Object
implements ChallengedMessageHandler

This class sets the minimum implementation for a ChallengedMessageHandler. It simply handles messages as they come and notifies all the threads waiting for this. It stores neither handled requests nor responses.

If credentials are provided, then authentication is automatically handled with the help of a AuthenticationHelper. Responses with a challenge which can be successfully resolved by the helper are handled silently and are not notified. Once a helper was used, it is attached to the response's session, so users of this object should retrieve it and call its AuthenticationHelper.addAuthentication(SipServletRequest) on any new request belonging to the same session request before sending it.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HANDLED_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
AbstractChallengedMessageHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	addToCredentials(Credentials credentials)
protected void	doWait(Object o)
protected void	doWait(Object o, long timeout)
protected AuthenticationHelper	getAuthenticationHelper(javax.servlet.sip.SipServletMessage message)
List<Credentials>	getCredentials()
protected AuthenticationHelper	getOrCreateAuthenticationHelper(javax.servlet.sip.SipServletMessage message)
long	getTimeout()
boolean	handleAuthentication(javax.servlet.sip.SipServletResponse response) Handles responses containing a challenge.
void	setCredentials(List<Credentials> credentials)
void	setTimeout(long timeout)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cipango.client.MessageHandler

handleRequest, handleResponse

Field Detail

HANDLED_ATTRIBUTE

public static final String HANDLED_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

AbstractChallengedMessageHandler

public AbstractChallengedMessageHandler()

Method Detail

getCredentials

public List<Credentials> getCredentials()

setCredentials

public void setCredentials(List<Credentials> credentials)

addToCredentials

public void addToCredentials(Credentials credentials)

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

handleAuthentication

public boolean handleAuthentication(javax.servlet.sip.SipServletResponse response)
                             throws IOException,
                                    javax.servlet.ServletException

Description copied from interface: ChallengedMessageHandler

Handles responses containing a challenge.

Specified by:

handleAuthentication in interface ChallengedMessageHandler

Returns:

true if the message should be forwarded up to this MessageHandler user, false otherwise.

Throws:

IOException

javax.servlet.ServletException

getAuthenticationHelper

protected AuthenticationHelper getAuthenticationHelper(javax.servlet.sip.SipServletMessage message)

getOrCreateAuthenticationHelper

protected AuthenticationHelper getOrCreateAuthenticationHelper(javax.servlet.sip.SipServletMessage message)

doWait

protected void doWait(Object o)

doWait

protected void doWait(Object o,
          long timeout)