org.cipango.server.servlet

Class SipServletHolder

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.servlet.BaseHolder<T>

org.eclipse.jetty.servlet.Holder<javax.servlet.sip.SipServlet>

org.cipango.server.servlet.SipServletHolder

All Implemented Interfaces:

java.lang.Comparable<SipServletHolder>, org.eclipse.jetty.server.UserIdentity.Scope, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.LifeCycle

@ManagedObject(value="SIP servlet holder")
public class SipServletHolder
extends org.eclipse.jetty.servlet.Holder<javax.servlet.sip.SipServlet>
implements org.eclipse.jetty.server.UserIdentity.Scope, java.lang.Comparable<SipServletHolder>

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.servlet.Holder

org.eclipse.jetty.servlet.Holder.HolderConfig, org.eclipse.jetty.servlet.Holder.HolderRegistration

Nested classes/interfaces inherited from class org.eclipse.jetty.servlet.BaseHolder

org.eclipse.jetty.servlet.BaseHolder.Source

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.servlet.Holder

_asyncSupported, _displayName, _initParams, _name

Fields inherited from class org.eclipse.jetty.servlet.BaseHolder

_class, _className, _extInstance, _source

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
SipServletHolder()
SipServletHolder(org.eclipse.jetty.servlet.BaseHolder.Source source)

Method Summary

Modifier and Type	Method and Description
int	compareTo(SipServletHolder sh)
void	doStart()
void	doStop()
java.lang.String	getContextPath()
int	getInitOrder()
java.util.Map<java.lang.String,java.lang.String>	getRoleMap()
java.util.Map<java.lang.String,java.lang.String>	getRoleRefMap()
java.lang.String	getRunAsRole()
javax.servlet.Servlet	getServlet()
javax.servlet.Servlet	getServletInstance() Get the servlet instance (no initialization done).
javax.servlet.UnavailableException	getUnavailableException()
java.lang.String	getUserRoleLink(java.lang.String name) get a user role link.
void	handle(SipMessage message)
protected javax.servlet.sip.SipServlet	newInstance()
void	setInitOrder(int initOrder)
void	setRunAsRole(java.lang.String role)
void	setServlet(javax.servlet.sip.SipServlet servlet)
void	setServletHandler(SipServletHandler servletHandler)
void	setUserRoleLink(java.lang.String name, java.lang.String link) Link a user role.
java.lang.String	toString()

Methods inherited from class org.eclipse.jetty.servlet.Holder

destroyInstance, dump, dump, getDisplayName, getInitParameter, getInitParameterNames, getInitParameters, getName, isAsyncSupported, setAsyncSupported, setClassName, setDisplayName, setHeldClass, setInitParameter, setInitParameters, setName

Methods inherited from class org.eclipse.jetty.servlet.BaseHolder

getClassName, getHeldClass, getServletHandler, getSource, illegalStateIfContextStarted, initialize, isInstance, setServletHandler

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.server.UserIdentity.Scope

getName

Constructor Detail

SipServletHolder

public SipServletHolder()

SipServletHolder

public SipServletHolder(org.eclipse.jetty.servlet.BaseHolder.Source source)

Method Detail

doStart

public void doStart()
             throws java.lang.Exception

Overrides:

doStart in class org.eclipse.jetty.servlet.BaseHolder<javax.servlet.sip.SipServlet>

Throws:

java.lang.Exception

doStop

public void doStop()
            throws java.lang.Exception

Overrides:

doStop in class org.eclipse.jetty.servlet.BaseHolder<javax.servlet.sip.SipServlet>

Throws:

java.lang.Exception

getUnavailableException

public javax.servlet.UnavailableException getUnavailableException()

Returns:

The unavailable exception or null if not unavailable

setServlet

public void setServlet(javax.servlet.sip.SipServlet servlet)

handle

public void handle(SipMessage message)
            throws javax.servlet.ServletException,
                   java.io.IOException

Throws:

javax.servlet.ServletException

java.io.IOException

getServlet

public javax.servlet.Servlet getServlet()
                                 throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

getServletInstance

public javax.servlet.Servlet getServletInstance()

Get the servlet instance (no initialization done).

Returns:

The servlet or null

newInstance

protected javax.servlet.sip.SipServlet newInstance()
                                            throws java.lang.InstantiationException,
                                                   java.lang.IllegalAccessException,
                                                   javax.servlet.ServletException

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

javax.servlet.ServletException

setServletHandler

public void setServletHandler(SipServletHandler servletHandler)

getInitOrder

@ManagedAttribute(value="Init order",
                  readonly=true)
public int getInitOrder()

setInitOrder

public void setInitOrder(int initOrder)

compareTo

public int compareTo(SipServletHolder sh)

Specified by:

compareTo in interface java.lang.Comparable<SipServletHolder>

toString

public java.lang.String toString()

Overrides:

toString in class org.eclipse.jetty.servlet.Holder<javax.servlet.sip.SipServlet>

setUserRoleLink

public void setUserRoleLink(java.lang.String name,
                            java.lang.String link)

Link a user role. Translate the role name used by a servlet, to the link name used by the container.

Parameters:

name - The role name as used by the servlet

link - The role name as used by the container.

getUserRoleLink

public java.lang.String getUserRoleLink(java.lang.String name)

get a user role link.

Parameters:

name - The name of the role

Returns:

The name as translated by the link. If no link exists, the name is returned.

getRoleMap

public java.util.Map<java.lang.String,java.lang.String> getRoleMap()

getContextPath

public java.lang.String getContextPath()

Specified by:

getContextPath in interface org.eclipse.jetty.server.UserIdentity.Scope

getRoleRefMap

public java.util.Map<java.lang.String,java.lang.String> getRoleRefMap()

Specified by:

getRoleRefMap in interface org.eclipse.jetty.server.UserIdentity.Scope

See Also:

UserIdentity.Scope.getRoleRefMap()

getRunAsRole

@ManagedAttribute(value="role to run servlet as",
                  readonly=true)
public java.lang.String getRunAsRole()

setRunAsRole

public void setRunAsRole(java.lang.String role)