org.cipango.server.security

Class SipSecurityHandler<T>

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.cipango.server.handler.AbstractSipHandler

org.cipango.server.handler.SipHandlerWrapper

org.cipango.server.security.SipSecurityHandler<T>

All Implemented Interfaces:

SipAuthenticator.AuthConfiguration, SipHandler, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.LifeCycle

Direct Known Subclasses:

ConstraintSecurityHandler

@ManagedObject(value="SIP security handler")
public abstract class SipSecurityHandler<T>
extends SipHandlerWrapper
implements SipHandler, SipAuthenticator.AuthConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SipSecurityHandler.IdentityAssertionScheme

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

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

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Field Summary

Fields inherited from class org.cipango.server.handler.SipHandlerWrapper

_handler

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
SipSecurityHandler()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkSipResourcePermissions(SipServletHolder holder, SipRequest request, T constraintInfo, org.eclipse.jetty.server.UserIdentity userIdentity)
protected abstract boolean	checkUserDataPermissions(SipServletHolder holder, SipRequest request, T constraintInfo)
protected void	doStart()
protected void	doStop()
protected org.eclipse.jetty.security.IdentityService	findIdentityService()
protected org.eclipse.jetty.security.LoginService	findLoginService()
SipAuthenticator	getAuthenticator()
SipAuthenticator.Factory	getAuthenticatorFactory()
java.lang.String	getAuthMethod()
SipSecurityHandler.IdentityAssertionScheme	getIdentityAssertionScheme()
org.eclipse.jetty.security.IdentityService	getIdentityService()
java.lang.String	getInitParameter(java.lang.String key) Get a SecurityHandler init parameter
java.util.Set<java.lang.String>	getInitParameterNames() Get a SecurityHandler init parameter names
org.eclipse.jetty.security.LoginService	getLoginService() Get the loginService.
java.lang.String	getRealmName()
void	handle(SipMessage message)
protected abstract boolean	isAuthMandatory(SipRequest baseRequest, T constraintInfo)
boolean	isIdentityAssertionRequired()
protected abstract boolean	isProxyMode(SipRequest baseRequest, T constraintInfo)
protected abstract T	prepareConstraintInfo(SipServletHolder holder, SipRequest request)
void	setAuthenticator(SipAuthenticator authenticator) Set the authenticator.
void	setAuthenticatorFactory(SipAuthenticator.Factory authenticatorFactory)
void	setAuthMethod(java.lang.String authMethod)
void	setIdentityAssertionRequired(boolean identityAssertionRequired)
void	setIdentityAssertionScheme(SipSecurityHandler.IdentityAssertionScheme identityAssertionScheme)
void	setIdentityService(org.eclipse.jetty.security.IdentityService identityService) Set the identityService.
java.lang.String	setInitParameter(java.lang.String key, java.lang.String value) Set an initialization parameter.
void	setLoginService(org.eclipse.jetty.security.LoginService loginService) Set the loginService.
void	setRealmName(java.lang.String realmName)

Methods inherited from class org.cipango.server.handler.SipHandlerWrapper

destroy, getHandler, setHandler, setServer

Methods inherited from class org.cipango.server.handler.AbstractSipHandler

getServer

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

addBean, addBean, addBean, addEventListener, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBeans

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cipango.server.SipHandler

getServer, setServer

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Constructor Detail

SipSecurityHandler

public SipSecurityHandler()

Method Detail

doStart

protected void doStart()
                throws java.lang.Exception

Overrides:

doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

java.lang.Exception

doStop

protected void doStop()
               throws java.lang.Exception

Overrides:

doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

java.lang.Exception

getLoginService

@ManagedAttribute(name="Login service",
                  readonly=true)
public org.eclipse.jetty.security.LoginService getLoginService()

Get the loginService.

Specified by:

getLoginService in interface SipAuthenticator.AuthConfiguration

Returns:

the loginService

setLoginService

public void setLoginService(org.eclipse.jetty.security.LoginService loginService)

Set the loginService.

Parameters:

loginService - the loginService to set

getRealmName

@ManagedAttribute(name="Realm name",
                  readonly=true)
public java.lang.String getRealmName()

Specified by:

getRealmName in interface SipAuthenticator.AuthConfiguration

Returns:

the realmName

setRealmName

public void setRealmName(java.lang.String realmName)

Parameters:

realmName - the realmName to set

Throws:

java.lang.IllegalStateException - if the SecurityHandler is running

getAuthMethod

@ManagedAttribute(name="Authentication method",
                  readonly=true)
public java.lang.String getAuthMethod()

Specified by:

getAuthMethod in interface SipAuthenticator.AuthConfiguration

Returns:

the authMethod

setAuthMethod

public void setAuthMethod(java.lang.String authMethod)

Parameters:

authMethod - the authMethod to set

Throws:

java.lang.IllegalStateException - if the SecurityHandler is running

findLoginService

protected org.eclipse.jetty.security.LoginService findLoginService()

findIdentityService

protected org.eclipse.jetty.security.IdentityService findIdentityService()

prepareConstraintInfo

protected abstract T prepareConstraintInfo(SipServletHolder holder,
                                           SipRequest request)

checkUserDataPermissions

protected abstract boolean checkUserDataPermissions(SipServletHolder holder,
                                                    SipRequest request,
                                                    T constraintInfo)
                                             throws java.io.IOException

Throws:

java.io.IOException

isAuthMandatory

protected abstract boolean isAuthMandatory(SipRequest baseRequest,
                                           T constraintInfo)

isProxyMode

protected abstract boolean isProxyMode(SipRequest baseRequest,
                                       T constraintInfo)

checkSipResourcePermissions

protected abstract boolean checkSipResourcePermissions(SipServletHolder holder,
                                                       SipRequest request,
                                                       T constraintInfo,
                                                       org.eclipse.jetty.server.UserIdentity userIdentity)
                                                throws java.io.IOException

Throws:

java.io.IOException

handle

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

Specified by:

handle in interface SipHandler

Overrides:

handle in class SipHandlerWrapper

Throws:

java.io.IOException

javax.servlet.ServletException

getInitParameter

public java.lang.String getInitParameter(java.lang.String key)

Description copied from interface: SipAuthenticator.AuthConfiguration

Get a SecurityHandler init parameter

Specified by:

getInitParameter in interface SipAuthenticator.AuthConfiguration

Parameters:

key - parameter name

Returns:

Parameter value or null

See Also:

SecurityHandler.getInitParameter(String)

getInitParameterNames

public java.util.Set<java.lang.String> getInitParameterNames()

Description copied from interface: SipAuthenticator.AuthConfiguration

Get a SecurityHandler init parameter names

Specified by:

getInitParameterNames in interface SipAuthenticator.AuthConfiguration

Returns:

Set of parameter names

See Also:

SecurityHandler.getInitParameterNames()

setInitParameter

public java.lang.String setInitParameter(java.lang.String key,
                                         java.lang.String value)

Set an initialization parameter.

Parameters:

key -

value -

Returns:

previous value

Throws:

java.lang.IllegalStateException - if the SecurityHandler is running

getIdentityService

public org.eclipse.jetty.security.IdentityService getIdentityService()

Specified by:

getIdentityService in interface SipAuthenticator.AuthConfiguration

setIdentityService

public void setIdentityService(org.eclipse.jetty.security.IdentityService identityService)

Set the identityService.

Parameters:

identityService - the identityService to set

getAuthenticator

@ManagedAttribute(value="SIP Authenticator",
                  readonly=true)
public SipAuthenticator getAuthenticator()

setAuthenticator

public void setAuthenticator(SipAuthenticator authenticator)

Set the authenticator.

Parameters:

authenticator -

Throws:

java.lang.IllegalStateException - if the SecurityHandler is running

getAuthenticatorFactory

public SipAuthenticator.Factory getAuthenticatorFactory()

Returns:

the authenticatorFactory

setAuthenticatorFactory

public void setAuthenticatorFactory(SipAuthenticator.Factory authenticatorFactory)

Parameters:

authenticatorFactory - the authenticatorFactory to set

Throws:

java.lang.IllegalStateException - if the SecurityHandler is running

getIdentityAssertionScheme

public SipSecurityHandler.IdentityAssertionScheme getIdentityAssertionScheme()

setIdentityAssertionScheme

public void setIdentityAssertionScheme(SipSecurityHandler.IdentityAssertionScheme identityAssertionScheme)

isIdentityAssertionRequired

public boolean isIdentityAssertionRequired()

setIdentityAssertionRequired

public void setIdentityAssertionRequired(boolean identityAssertionRequired)