SecurityHandler (blade-embed-jetty 0.1.3 API)

java.lang.Object
- org.eclipse.jetty.util.component.AbstractLifeCycle
- - org.eclipse.jetty.util.component.ContainerLifeCycle
  - - org.eclipse.jetty.server.handler.AbstractHandler
    - - org.eclipse.jetty.server.handler.AbstractHandlerContainer
      - org.eclipse.jetty.server.handler.HandlerWrapper
        
        org.eclipse.jetty.security.SecurityHandler

所有已实现的接口:

Authenticator.AuthConfiguration, org.eclipse.jetty.server.Handler, org.eclipse.jetty.server.HandlerContainer, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.LifeCycle

直接已知子类:

ConstraintSecurityHandler
```
public abstract class SecurityHandler
extends org.eclipse.jetty.server.handler.HandlerWrapper
implements Authenticator.AuthConfiguration
```
Abstract SecurityHandler.
Select and apply an Authenticator to a request.
The Authenticator may either be directly set on the handler or will be create during AbstractLifeCycle.start() with a call to either the default or set AuthenticatorFactory.
SecurityHandler has a set of initparameters that are used by the Authentication.Configuration. At startup, any context init parameters that start with "org.eclipse.jetty.security." that do not have values in the SecurityHandler init parameters, are copied.

嵌套类概要

嵌套类
限定符和类型类和说明

class SecurityHandler.NotChecked
- 从类继承的嵌套类/接口 org.eclipse.jetty.server.handler.AbstractHandler
  org.eclipse.jetty.server.handler.AbstractHandler.ErrorDispatchHandler
- 从类继承的嵌套类/接口 org.eclipse.jetty.util.component.AbstractLifeCycle
  org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener
- 从接口继承的嵌套类/接口 org.eclipse.jetty.util.component.LifeCycle
  org.eclipse.jetty.util.component.LifeCycle.Listener
- 从接口继承的嵌套类/接口 org.eclipse.jetty.util.component.Container
  org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

嵌套类
限定符和类型	类和说明
`class`	`SecurityHandler.NotChecked`

字段概要

字段
限定符和类型字段和说明

static Principal __NO_USER

static Principal __NOBODY
Nobody user.
- 从类继承的字段 org.eclipse.jetty.server.handler.HandlerWrapper
  _handler
- 从类继承的字段 org.eclipse.jetty.util.component.AbstractLifeCycle
  FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

字段
限定符和类型	字段和说明
`static Principal`	`__NO_USER`
`static Principal`	`__NOBODY` Nobody user.

构造器概要

构造器
限定符构造器和说明

protected SecurityHandler()

构造器
限定符	构造器和说明
`protected`	`SecurityHandler()`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected boolean`	`checkSecurity(org.eclipse.jetty.server.Request request)`
`protected abstract boolean`	`checkUserDataPermissions(String pathInContext, org.eclipse.jetty.server.Request request, org.eclipse.jetty.server.Response response, RoleInfo constraintInfo)`
`protected abstract boolean`	`checkWebResourcePermissions(String pathInContext, org.eclipse.jetty.server.Request request, org.eclipse.jetty.server.Response response, Object constraintInfo, org.eclipse.jetty.server.UserIdentity userIdentity)`
`protected void`	`doStart()`
`protected void`	`doStop()`
`protected IdentityService`	`findIdentityService()`
`protected LoginService`	`findLoginService()`
`Authenticator`	`getAuthenticator()`
`Authenticator.Factory`	`getAuthenticatorFactory()`
`String`	`getAuthMethod()`
`static SecurityHandler`	`getCurrentSecurityHandler()`
`IdentityService`	`getIdentityService()` Get the identityService.
`String`	`getInitParameter(String key)` Get a SecurityHandler init parameter
`Set<String>`	`getInitParameterNames()` Get a SecurityHandler init parameter names
`LoginService`	`getLoginService()` Get the loginService.
`String`	`getRealmName()`
`void`	`handle(String pathInContext, org.eclipse.jetty.server.Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`protected abstract boolean`	`isAuthMandatory(org.eclipse.jetty.server.Request baseRequest, org.eclipse.jetty.server.Response base_response, Object constraintInfo)`
`boolean`	`isCheckWelcomeFiles()`
`boolean`	`isSessionRenewedOnAuthentication()`
`void`	`logout(org.eclipse.jetty.server.Authentication.User user)`
`protected abstract RoleInfo`	`prepareConstraintInfo(String pathInContext, org.eclipse.jetty.server.Request request)`
`void`	`setAuthenticator(Authenticator authenticator)` Set the authenticator.
`void`	`setAuthenticatorFactory(Authenticator.Factory authenticatorFactory)`
`void`	`setAuthMethod(String authMethod)`
`void`	`setCheckWelcomeFiles(boolean authenticateWelcomeFiles)`
`void`	`setIdentityService(IdentityService identityService)` Set the identityService.
`String`	`setInitParameter(String key, String value)` Set an initialization parameter.
`void`	`setLoginService(LoginService loginService)` Set the loginService.
`void`	`setRealmName(String realmName)`
`void`	`setSessionRenewedOnAuthentication(boolean renew)` Set renew the session on Authentication.

从类继承的方法 org.eclipse.jetty.server.handler.HandlerWrapper
destroy, expandChildren, getHandler, getHandlers, insertHandler, setHandler

从类继承的方法 org.eclipse.jetty.server.handler.AbstractHandlerContainer
expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

从类继承的方法 org.eclipse.jetty.server.handler.AbstractHandler
doError, dumpThis, getServer

从类继承的方法 org.eclipse.jetty.util.component.ContainerLifeCycle
addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

从类继承的方法 org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.eclipse.jetty.util.component.LifeCycle
addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

- 字段详细资料
  - __NO_USER
```
public static final Principal __NO_USER
```
  - __NOBODY
```
public static final Principal __NOBODY
```
    Nobody user. The Nobody UserPrincipal is used to indicate a partial state of authentication. A request with a Nobody UserPrincipal will be allowed past all authentication constraints - but will not be considered an authenticated request. It can be used by Authenticators such as FormAuthenticator to allow access to logon and error pages within an authenticated URI tree.
- 构造器详细资料
  - SecurityHandler
```
protected SecurityHandler()
```
- 方法详细资料
  - getIdentityService
```
public IdentityService getIdentityService()
```
    Get the identityService.
    
    指定者:
    
    getIdentityService 在接口中 Authenticator.AuthConfiguration
    
    返回:
    
    the identityService
  - setIdentityService
```
public void setIdentityService(IdentityService identityService)
```
    Set the identityService.
    
    参数:
    
    identityService - the identityService to set
  - getLoginService
```
public LoginService getLoginService()
```
    Get the loginService.
    
    指定者:
    
    getLoginService 在接口中 Authenticator.AuthConfiguration
    
    返回:
    
    the loginService
  - setLoginService
```
public void setLoginService(LoginService loginService)
```
    Set the loginService.
    
    参数:
    
    loginService - the loginService to set
  - getAuthenticator
```
public Authenticator getAuthenticator()
```
  - setAuthenticator
```
public void setAuthenticator(Authenticator authenticator)
```
    Set the authenticator.
    
    参数:
    
    authenticator - the authenticator
    
    抛出:
    
    IllegalStateException - if the SecurityHandler is running
  - getAuthenticatorFactory
```
public Authenticator.Factory getAuthenticatorFactory()
```
    返回:
    
    the authenticatorFactory
  - setAuthenticatorFactory
```
public void setAuthenticatorFactory(Authenticator.Factory authenticatorFactory)
```
    参数:
    
    authenticatorFactory - the authenticatorFactory to set
    
    抛出:
    
    IllegalStateException - if the SecurityHandler is running
  - getRealmName
```
public String getRealmName()
```
    指定者:
    
    getRealmName 在接口中 Authenticator.AuthConfiguration
    
    返回:
    
    the realmName
  - setRealmName
```
public void setRealmName(String realmName)
```
    参数:
    
    realmName - the realmName to set
    
    抛出:
    
    IllegalStateException - if the SecurityHandler is running
  - getAuthMethod
```
public String getAuthMethod()
```
    指定者:
    
    getAuthMethod 在接口中 Authenticator.AuthConfiguration
    
    返回:
    
    the authMethod
  - setAuthMethod
```
public void setAuthMethod(String authMethod)
```
    参数:
    
    authMethod - the authMethod to set
    
    抛出:
    
    IllegalStateException - if the SecurityHandler is running
  - isCheckWelcomeFiles
```
public boolean isCheckWelcomeFiles()
```
    返回:
    
    True if forwards to welcome files are authenticated
  - setCheckWelcomeFiles
```
public void setCheckWelcomeFiles(boolean authenticateWelcomeFiles)
```
    参数:
    
    authenticateWelcomeFiles - True if forwards to welcome files are authenticated
    
    抛出:
    
    IllegalStateException - if the SecurityHandler is running
  - getInitParameter
```
public String getInitParameter(String key)
```
    从接口复制的说明: Authenticator.AuthConfiguration
    
    Get a SecurityHandler init parameter
    
    指定者:
    
    getInitParameter 在接口中 Authenticator.AuthConfiguration
    
    参数:
    
    key - parameter name
    
    返回:
    
    Parameter value or null
    
    另请参阅:
    
    getInitParameter(String)
  - getInitParameterNames
```
public Set<String> getInitParameterNames()
```
    从接口复制的说明: Authenticator.AuthConfiguration
    
    Get a SecurityHandler init parameter names
    
    指定者:
    
    getInitParameterNames 在接口中 Authenticator.AuthConfiguration
    
    返回:
    
    Set of parameter names
    
    另请参阅:
    
    getInitParameterNames()
  - setInitParameter
```
public String setInitParameter(String key,
                               String value)
```
    Set an initialization parameter.
    
    参数:
    
    key - the init key
    
    value - the init value
    
    返回:
    
    previous value
    
    抛出:
    
    IllegalStateException - if the SecurityHandler is running
  - findLoginService
```
protected LoginService findLoginService()
                                 throws Exception
```
    抛出:
    
    Exception
  - findIdentityService
```
protected IdentityService findIdentityService()
```
  - doStart
```
protected void doStart()
                throws Exception
```
    覆盖:
    
    doStart 在类中 org.eclipse.jetty.server.handler.AbstractHandler
    
    抛出:
    
    Exception
  - doStop
```
protected void doStop()
               throws Exception
```
    覆盖:
    
    doStop 在类中 org.eclipse.jetty.server.handler.AbstractHandler
    
    抛出:
    
    Exception
  - checkSecurity
```
protected boolean checkSecurity(org.eclipse.jetty.server.Request request)
```
  - isSessionRenewedOnAuthentication
```
public boolean isSessionRenewedOnAuthentication()
```
    指定者:
    
    isSessionRenewedOnAuthentication 在接口中 Authenticator.AuthConfiguration
    
    另请参阅:
    
    Authenticator.AuthConfiguration.isSessionRenewedOnAuthentication()
  - setSessionRenewedOnAuthentication
```
public void setSessionRenewedOnAuthentication(boolean renew)
```
    Set renew the session on Authentication.
    If set to true, then on authentication, the session associated with a reqeuest is invalidated and replaced with a new session.
    
    参数:
    
    renew - true to renew the authentication on session
    
    另请参阅:
    
    Authenticator.AuthConfiguration.isSessionRenewedOnAuthentication()
  - handle
```
public void handle(String pathInContext,
                   org.eclipse.jetty.server.Request baseRequest,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws IOException,
                   javax.servlet.ServletException
```
    指定者:
    
    handle 在接口中 org.eclipse.jetty.server.Handler
    
    覆盖:
    
    handle 在类中 org.eclipse.jetty.server.handler.HandlerWrapper
    
    抛出:
    
    IOException
    
    javax.servlet.ServletException
  - getCurrentSecurityHandler
```
public static SecurityHandler getCurrentSecurityHandler()
```
  - logout
```
public void logout(org.eclipse.jetty.server.Authentication.User user)
```
  - prepareConstraintInfo
```
protected abstract RoleInfo prepareConstraintInfo(String pathInContext,
                                                  org.eclipse.jetty.server.Request request)
```
  - checkUserDataPermissions
```
protected abstract boolean checkUserDataPermissions(String pathInContext,
                                                    org.eclipse.jetty.server.Request request,
                                                    org.eclipse.jetty.server.Response response,
                                                    RoleInfo constraintInfo)
                                             throws IOException
```
    抛出:
    
    IOException
  - isAuthMandatory
```
protected abstract boolean isAuthMandatory(org.eclipse.jetty.server.Request baseRequest,
                                           org.eclipse.jetty.server.Response base_response,
                                           Object constraintInfo)
```
  - checkWebResourcePermissions
```
protected abstract boolean checkWebResourcePermissions(String pathInContext,
                                                       org.eclipse.jetty.server.Request request,
                                                       org.eclipse.jetty.server.Response response,
                                                       Object constraintInfo,
                                                       org.eclipse.jetty.server.UserIdentity userIdentity)
                                                throws IOException
```
    抛出:
    
    IOException

类 SecurityHandler

嵌套类概要

从类继承的嵌套类/接口 org.eclipse.jetty.server.handler.AbstractHandler

从类继承的嵌套类/接口 org.eclipse.jetty.util.component.AbstractLifeCycle

从接口继承的嵌套类/接口 org.eclipse.jetty.util.component.LifeCycle

从接口继承的嵌套类/接口 org.eclipse.jetty.util.component.Container

字段概要

从类继承的字段 org.eclipse.jetty.server.handler.HandlerWrapper

从类继承的字段 org.eclipse.jetty.util.component.AbstractLifeCycle

构造器概要

方法概要

从类继承的方法 org.eclipse.jetty.server.handler.HandlerWrapper

从类继承的方法 org.eclipse.jetty.server.handler.AbstractHandlerContainer

从类继承的方法 org.eclipse.jetty.server.handler.AbstractHandler

从类继承的方法 org.eclipse.jetty.util.component.ContainerLifeCycle

从类继承的方法 org.eclipse.jetty.util.component.AbstractLifeCycle

从类继承的方法 java.lang.Object

从接口继承的方法 org.eclipse.jetty.util.component.LifeCycle

字段详细资料

__NO_USER

__NOBODY

构造器详细资料

SecurityHandler

方法详细资料

getIdentityService

setIdentityService

getLoginService

setLoginService

getAuthenticator

setAuthenticator

getAuthenticatorFactory

setAuthenticatorFactory

getRealmName

setRealmName

getAuthMethod

setAuthMethod

isCheckWelcomeFiles

setCheckWelcomeFiles

getInitParameter

getInitParameterNames

setInitParameter

findLoginService

findIdentityService

doStart

doStop

checkSecurity

isSessionRenewedOnAuthentication

setSessionRenewedOnAuthentication

handle

getCurrentSecurityHandler

logout

prepareConstraintInfo

checkUserDataPermissions

isAuthMandatory

checkWebResourcePermissions