HttpServletHelper (Shibboleth Identity Provider 2.3.0 API)

java.lang.Object
- edu.internet2.middleware.shibboleth.idp.util.HttpServletHelper

```
public class HttpServletHelper
extends Object
```
A helper class that provides access to internal state from Servlets and hence also JSPs.

フィールドの概要

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`ATTRIBUTE_FILTER_ENGINE_SID_CTX_PARAM` `ServletContext` parameter name bearing the ID of the `AttributeFilteringEngine` service: "AttributeFilterEngineId" .
`static String`	`ATTRIBUTE_RESOLVER_SID_CTX_PARAM` `ServletContext` parameter name bearing the ID of the `AttributeResolver` service: "AttributeResolverId" .
`static String`	`COOKIE_DOMAIN_PARAM` Name of the context initialization parameter that stores the domain to use for all cookies.
`static String`	`DEFAULT_ATTRIBUTE_FILTER_ENGINE_SID` Default ID by which the `AttributeFilteringEngine` is know within the Servlet context: "shibboleth.AttributeFilterEngine" .
`static String`	`DEFAULT_ATTRIBUTE_RESOLVER_SID` Default ID by which the `AttributeResolver` is know within the Servlet context: "shibboleth.AttributeResolver" .
`static String`	`DEFAULT_LOGIN_CTX_PARITION` Default name for the `StorageService` partition which holds `LoginContext`s: "loginContexts" .
`static String`	`DEFAULT_PROFILE_HANDLER_MNGR_SID` Default ID by which the `IdPProfileHandlerManager` is know within the Servlet context: "shibboleth.HandlerManager" .
`static String`	`DEFAULT_RP_CONFIG_MNGR_SID` Default ID by which the `RelyingPartyConfigurationManager` is know within the Servlet context: "shibboleth.RelyingPartyConfigurationManager" .
`static String`	`DEFAULT_SAML1_AA_SID` Default ID by which the `SAML1AttributeAuthority` is know within the Servlet context: "shibboleth.SAML1AttributeAuthority" .
`static String`	`DEFAULT_SAML2_AA_SID` Default ID by which the `SAML2AttributeAuthority` is know within the Servlet context: "shibboleth.SAML2AttributeAuthority" .
`static String`	`DEFAULT_SESSION_MNGR_SID` Default ID by which the `SessionManager` is know within the Servlet context: "shibboleth.SessionManager" .
`static String`	`DEFAULT_STORAGE_SERVICE_SID` Default ID by which the `StorageService` is know within the Servlet context: "shibboleth.StorageService" .
`static String`	`IDP_SESSION_COOKIE` Name of the cookie containing the IdP session ID: "_idp_session" .
`static String`	`LOGIN_CTX_KEY_NAME` Name of the key to the current authentication login context: "_idp_authn_lc_key" .
`static String`	`LOGIN_CTX_PARTITION_CTX_PARAM` `ServletContext` parameter name bearing the name of the `StorageService` partition into which `LoginContext`s are stored: "loginContextPartitionName" .
`static String`	`PROFILE_HANDLER_MNGR_SID_CTX_PARAM` `ServletContext` parameter name bearing the ID of the `IdPProfileHandlerManager` service: "ProfileHandlerMngrId" .
`static String`	`RP_CONFIG_MNGR_SID_CTX_PARAM` `ServletContext` parameter name bearing the ID of the `RelyingPartyConfigurationManager` service: * * * "RelyingPartyConfigurationManagerId" .
`static String`	`SAML1_AA_SID_CTX_PARAM` `ServletContext` parameter name bearing the ID of the `SAML1AttributeAuthority` service: "SAML1AttributeAuthorityId" .
`static String`	`SAML2_AA_SID_CTX_PARAM` `ServletContext` parameter name bearing the ID of the `SAML2AttributeAuthority` service: "SAML2AttributeAuthorityId" .
`static String`	`SESSION_MNGR_SID_CTX_PARAM` `ServletContext` parameter name bearing the ID of the `SessionManager` service: "SessionManagerId" .
`static String`	`STORAGE_SERVICE_SID_CTX_PARAM` `ServletContext` parameter name bearing the ID of the `SAML1AttributeAuthority` service: "StorageServiceId" .

コンストラクタの概要

コンストラクタ
コンストラクタと説明

HttpServletHelper()

コンストラクタ
コンストラクタと説明
`HttpServletHelper()`

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`static void`	`bindLoginContext(LoginContext loginContext, javax.servlet.http.HttpServletRequest httpRequest)` 推奨されていません。
`static void`	`bindLoginContext(LoginContext loginContext, StorageService storageService, javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)` Binds a `LoginContext` to the issuer of the current request.
`static AttributeFilteringEngine<?>`	`getAttributeFilterEnginer(javax.servlet.ServletContext context)` Gets the `AttributeFilteringEngine` service bound to the Servlet context.
`static AttributeFilteringEngine<?>`	`getAttributeFilterEnginer(javax.servlet.ServletContext context, String serviceId)` Gets the `AttributeFilteringEngine` bound to the Servlet context.
`static AttributeResolver<?>`	`getAttributeResolver(javax.servlet.ServletContext context)` Gets the `AttributeResolver` service bound to the Servlet context.
`static AttributeResolver<?>`	`getAttributeResolver(javax.servlet.ServletContext context, String serviceId)` Gets the `AttributeResolver` bound to the Servlet context.
`static String`	`getContextParam(javax.servlet.ServletContext context, String name, String defaultValue)` Gets a value for a given context parameter.
`static URLBuilder`	`getContextRelativeUrl(javax.servlet.http.HttpServletRequest httpRequest, String path)` Builds a URL to a path that is meant to be relative to the Servlet context.
`static javax.servlet.http.Cookie`	`getCookie(javax.servlet.http.HttpServletRequest httpRequest, String cookieName)` Gets the first `Cookie` whose name matches the given name.
`static String`	`getCookieDomain(javax.servlet.ServletContext context)` Gets the domain to use for all cookies.
`static LoginContext`	`getLoginContext(javax.servlet.http.HttpServletRequest httpRequest)` 推奨されていません。 use `getLoginContext(StorageService, ServletContext, HttpServletRequest)` instead
`static LoginContext`	`getLoginContext(StorageService storageService, javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest httpRequest)` Gets the `LoginContext` for the user issuing the HTTP request.
`static IdPProfileHandlerManager`	`getProfileHandlerManager(javax.servlet.ServletContext context)` Gets the `IdPProfileHandlerManager` service bound to the Servlet context.
`static IdPProfileHandlerManager`	`getProfileHandlerManager(javax.servlet.ServletContext context, String serviceId)` Gets the `IdPProfileHandlerManager` bound to the Servlet context.
`static RelyingPartyConfigurationManager`	`getRelyingPartyConfigurationManager(javax.servlet.ServletContext context)` Gets the `RelyingPartyConfigurationManager` service bound to the Servlet context.
`static RelyingPartyConfigurationManager`	`getRelyingPartyConfigurationManager(javax.servlet.ServletContext context, String serviceId)` Gets the `RelyingPartyConfigurationManager` bound to the Servlet context.
`static RelyingPartyConfigurationManager`	`getRelyingPartyConfirmationManager(javax.servlet.ServletContext context)` 推奨されていません。 use `getRelyingPartyConfigurationManager(ServletContext)`
`static RelyingPartyConfigurationManager`	`getRelyingPartyConfirmationManager(javax.servlet.ServletContext context, String serviceId)` 推奨されていません。 use `getRelyingPartyConfigurationManager(ServletContext, String)`
`static EntityDescriptor`	`getRelyingPartyMetadata(String relyingPartyEntityId, RelyingPartyConfigurationManager rpConfigMngr)` Gets the metatdata for a given relying party.
`static SAML1AttributeAuthority`	`getSAML1AttributeAuthority(javax.servlet.ServletContext context)` Gets the `SAML1AttributeAuthority` service bound to the Servlet context.
`static SAML1AttributeAuthority`	`getSAML1AttributeAuthority(javax.servlet.ServletContext context, String serviceId)` Gets the `SAML1AttributeAuthority` bound to the Servlet context.
`static SAML2AttributeAuthority`	`getSAML2AttributeAuthority(javax.servlet.ServletContext context)` Gets the `SAML2AttributeAuthority` service bound to the Servlet context.
`static SAML2AttributeAuthority`	`getSAML2AttributeAuthority(javax.servlet.ServletContext context, String serviceId)` Gets the `SAML2AttributeAuthority` bound to the Servlet context.
`static URLBuilder`	`getServletContextUrl(javax.servlet.http.HttpServletRequest httpRequest)` Builds a URL, up to and including the servlet context path.
`static SessionManager<Session>`	`getSessionManager(javax.servlet.ServletContext context)` Gets the `SessionManager` service bound to the Servlet context.
`static SessionManager<Session>`	`getSessionManager(javax.servlet.ServletContext context, String serviceId)` Gets the `SessionManager` bound to the Servlet context.
`static StorageService<?,?>`	`getStorageService(javax.servlet.ServletContext context)` Gets the `StorageService` service bound to the Servlet context.
`static StorageService<?,?>`	`getStorageService(javax.servlet.ServletContext context, String serviceId)` Gets the `StorageService` bound to the Servlet context.
`static Session`	`getUserSession(javax.servlet.http.HttpServletRequest httpRequest)` Gets the user session from the request.
`static LoginContext`	`unbindLoginContext(StorageService storageService, javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)` Unbinds a `LoginContext` from the current request.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - COOKIE_DOMAIN_PARAM
```
public static final String COOKIE_DOMAIN_PARAM
```
    Name of the context initialization parameter that stores the domain to use for all cookies.
    
    関連項目:
    定数フィールド値
  - IDP_SESSION_COOKIE
```
public static final String IDP_SESSION_COOKIE
```
    Name of the cookie containing the IdP session ID: "_idp_session" .
    
    関連項目:
    定数フィールド値
  - LOGIN_CTX_KEY_NAME
```
public static final String LOGIN_CTX_KEY_NAME
```
    Name of the key to the current authentication login context: "_idp_authn_lc_key" .
    
    関連項目:
    定数フィールド値
  - ATTRIBUTE_FILTER_ENGINE_SID_CTX_PARAM
```
public static final String ATTRIBUTE_FILTER_ENGINE_SID_CTX_PARAM
```
    ServletContext parameter name bearing the ID of the AttributeFilteringEngine service: "AttributeFilterEngineId" .
    
    関連項目:
    定数フィールド値
  - ATTRIBUTE_RESOLVER_SID_CTX_PARAM
```
public static final String ATTRIBUTE_RESOLVER_SID_CTX_PARAM
```
    ServletContext parameter name bearing the ID of the AttributeResolver service: "AttributeResolverId" .
    
    関連項目:
    定数フィールド値
  - LOGIN_CTX_PARTITION_CTX_PARAM
```
public static final String LOGIN_CTX_PARTITION_CTX_PARAM
```
    ServletContext parameter name bearing the name of the StorageService partition into which LoginContexts are stored: "loginContextPartitionName" .
    
    関連項目:
    定数フィールド値
  - PROFILE_HANDLER_MNGR_SID_CTX_PARAM
```
public static final String PROFILE_HANDLER_MNGR_SID_CTX_PARAM
```
    ServletContext parameter name bearing the ID of the IdPProfileHandlerManager service: "ProfileHandlerMngrId" .
    
    関連項目:
    定数フィールド値
  - RP_CONFIG_MNGR_SID_CTX_PARAM
```
public static final String RP_CONFIG_MNGR_SID_CTX_PARAM
```
    ServletContext parameter name bearing the ID of the RelyingPartyConfigurationManager service: * * * "RelyingPartyConfigurationManagerId" .
    
    関連項目:
    定数フィールド値
  - SAML1_AA_SID_CTX_PARAM
```
public static final String SAML1_AA_SID_CTX_PARAM
```
    ServletContext parameter name bearing the ID of the SAML1AttributeAuthority service: "SAML1AttributeAuthorityId" .
    
    関連項目:
    定数フィールド値
  - SAML2_AA_SID_CTX_PARAM
```
public static final String SAML2_AA_SID_CTX_PARAM
```
    ServletContext parameter name bearing the ID of the SAML2AttributeAuthority service: "SAML2AttributeAuthorityId" .
    
    関連項目:
    定数フィールド値
  - SESSION_MNGR_SID_CTX_PARAM
```
public static final String SESSION_MNGR_SID_CTX_PARAM
```
    ServletContext parameter name bearing the ID of the SessionManager service: "SessionManagerId" .
    
    関連項目:
    定数フィールド値
  - STORAGE_SERVICE_SID_CTX_PARAM
```
public static final String STORAGE_SERVICE_SID_CTX_PARAM
```
    ServletContext parameter name bearing the ID of the SAML1AttributeAuthority service: "StorageServiceId" .
    
    関連項目:
    定数フィールド値
  - DEFAULT_ATTRIBUTE_FILTER_ENGINE_SID
```
public static final String DEFAULT_ATTRIBUTE_FILTER_ENGINE_SID
```
    Default ID by which the AttributeFilteringEngine is know within the Servlet context: "shibboleth.AttributeFilterEngine" .
    
    関連項目:
    定数フィールド値
  - DEFAULT_ATTRIBUTE_RESOLVER_SID
```
public static final String DEFAULT_ATTRIBUTE_RESOLVER_SID
```
    Default ID by which the AttributeResolver is know within the Servlet context: "shibboleth.AttributeResolver" .
    
    関連項目:
    定数フィールド値
  - DEFAULT_LOGIN_CTX_PARITION
```
public static final String DEFAULT_LOGIN_CTX_PARITION
```
    Default name for the StorageService partition which holds LoginContexts: "loginContexts" .
    
    関連項目:
    定数フィールド値
  - DEFAULT_PROFILE_HANDLER_MNGR_SID
```
public static final String DEFAULT_PROFILE_HANDLER_MNGR_SID
```
    Default ID by which the IdPProfileHandlerManager is know within the Servlet context: "shibboleth.HandlerManager" .
    
    関連項目:
    定数フィールド値
  - DEFAULT_RP_CONFIG_MNGR_SID
```
public static final String DEFAULT_RP_CONFIG_MNGR_SID
```
    Default ID by which the RelyingPartyConfigurationManager is know within the Servlet context: "shibboleth.RelyingPartyConfigurationManager" .
    
    関連項目:
    定数フィールド値
  - DEFAULT_SAML1_AA_SID
```
public static final String DEFAULT_SAML1_AA_SID
```
    Default ID by which the SAML1AttributeAuthority is know within the Servlet context: "shibboleth.SAML1AttributeAuthority" .
    
    関連項目:
    定数フィールド値
  - DEFAULT_SAML2_AA_SID
```
public static final String DEFAULT_SAML2_AA_SID
```
    Default ID by which the SAML2AttributeAuthority is know within the Servlet context: "shibboleth.SAML2AttributeAuthority" .
    
    関連項目:
    定数フィールド値
  - DEFAULT_SESSION_MNGR_SID
```
public static final String DEFAULT_SESSION_MNGR_SID
```
    Default ID by which the SessionManager is know within the Servlet context: "shibboleth.SessionManager" .
    
    関連項目:
    定数フィールド値
  - DEFAULT_STORAGE_SERVICE_SID
```
public static final String DEFAULT_STORAGE_SERVICE_SID
```
    Default ID by which the StorageService is know within the Servlet context: "shibboleth.StorageService" .
    
    関連項目:
    定数フィールド値
- コンストラクタの詳細
  - HttpServletHelper
```
public HttpServletHelper()
```
- メソッドの詳細
  - bindLoginContext
```
public static void bindLoginContext(LoginContext loginContext,
                    javax.servlet.http.HttpServletRequest httpRequest)
```
    推奨されていません。
    
    Binds a LoginContext to the current request.
    
    パラメータ:
    loginContext - login context to be bound
    httpRequest - current HTTP request
  - bindLoginContext
```
public static void bindLoginContext(LoginContext loginContext,
                    StorageService storageService,
                    javax.servlet.ServletContext context,
                    javax.servlet.http.HttpServletRequest httpRequest,
                    javax.servlet.http.HttpServletResponse httpResponse)
```
    Binds a LoginContext to the issuer of the current request. The binding is done by creating a random UUID, placing that in a cookie in the request, and storing the context in to the storage service under that key.
    
    パラメータ:
    loginContext - the login context to be bound
    storageService - the storage service which will hold the context
    context - the Servlet context
    httpRequest - the current HTTP request
    httpResponse - the current HTTP response
  - getCookieDomain
```
public static String getCookieDomain(javax.servlet.ServletContext context)
```
    Gets the domain to use for all cookies.
    
    パラメータ:
    context - web application context
    
    戻り値:
    domain to use for all cookies
  - getAttributeFilterEnginer
```
public static AttributeFilteringEngine<?> getAttributeFilterEnginer(javax.servlet.ServletContext context)
```
    Gets the AttributeFilteringEngine service bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getAttributeFilterEnginer
```
public static AttributeFilteringEngine<?> getAttributeFilterEnginer(javax.servlet.ServletContext context,
                                                    String serviceId)
```
    Gets the AttributeFilteringEngine bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    serviceId - the ID under which the service bound
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getAttributeResolver
```
public static AttributeResolver<?> getAttributeResolver(javax.servlet.ServletContext context)
```
    Gets the AttributeResolver service bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getAttributeResolver
```
public static AttributeResolver<?> getAttributeResolver(javax.servlet.ServletContext context,
                                        String serviceId)
```
    Gets the AttributeResolver bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    serviceId - the ID under which the service bound
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getContextParam
```
public static String getContextParam(javax.servlet.ServletContext context,
                     String name,
                     String defaultValue)
```
    Gets a value for a given context parameter. If no value is present the default value is used.
    
    パラメータ:
    context - the Servlet context
    name - name of the context parameter
    defaultValue - default value of the parameter
    
    戻り値:
    the value of the context parameter or the default value if the parameter is not set or does not contain a value
  - getCookie
```
public static javax.servlet.http.Cookie getCookie(javax.servlet.http.HttpServletRequest httpRequest,
                                  String cookieName)
```
    Gets the first Cookie whose name matches the given name.
    
    パラメータ:
    cookieName - the cookie name
    httpRequest - HTTP request from which the cookie should be extracted
    
    戻り値:
    the cookie or null if no cookie with that name was given
  - getLoginContext
```
public static LoginContext getLoginContext(javax.servlet.http.HttpServletRequest httpRequest)
```
    推奨されていません。 use getLoginContext(StorageService, ServletContext, HttpServletRequest) instead
    
    Gets the login context from the current request. The login context is only in this location while the request is being transferred from the authentication engine back to the profile handler. This method only works during the first hand-off from the authentication engine to the login handler. Afterwords you must use getLoginContext(StorageService, ServletContext, HttpServletRequest).
    
    パラメータ:
    httpRequest - current HTTP request
    
    戻り値:
    the login context or null if no login context is bound to the request
  - getLoginContext
```
public static LoginContext getLoginContext(StorageService storageService,
                           javax.servlet.ServletContext context,
                           javax.servlet.http.HttpServletRequest httpRequest)
```
    Gets the LoginContext for the user issuing the HTTP request. Note, login contexts are only available during the authentication process.
    
    パラメータ:
    context - the Servlet context
    storageService - storage service to use when retrieving the login context
    httpRequest - current HTTP request
    
    戻り値:
    the login context or null if none is available
  - getProfileHandlerManager
```
public static IdPProfileHandlerManager getProfileHandlerManager(javax.servlet.ServletContext context)
```
    Gets the IdPProfileHandlerManager service bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getProfileHandlerManager
```
public static IdPProfileHandlerManager getProfileHandlerManager(javax.servlet.ServletContext context,
                                                String serviceId)
```
    Gets the IdPProfileHandlerManager bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    serviceId - the ID under which the service bound
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getRelyingPartyConfigurationManager
```
public static RelyingPartyConfigurationManager getRelyingPartyConfigurationManager(javax.servlet.ServletContext context)
```
    Gets the RelyingPartyConfigurationManager service bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getRelyingPartyConfigurationManager
```
public static RelyingPartyConfigurationManager getRelyingPartyConfigurationManager(javax.servlet.ServletContext context,
                                                                   String serviceId)
```
    Gets the RelyingPartyConfigurationManager bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    serviceId - the ID under which the service bound
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getRelyingPartyConfirmationManager
```
public static RelyingPartyConfigurationManager getRelyingPartyConfirmationManager(javax.servlet.ServletContext context)
```
    推奨されていません。 use getRelyingPartyConfigurationManager(ServletContext)
    
    Gets the RelyingPartyConfigurationManager service bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getRelyingPartyConfirmationManager
```
public static RelyingPartyConfigurationManager getRelyingPartyConfirmationManager(javax.servlet.ServletContext context,
                                                                  String serviceId)
```
    推奨されていません。 use getRelyingPartyConfigurationManager(ServletContext, String)
    
    Gets the RelyingPartyConfigurationManager bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    serviceId - the ID under which the service bound
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getRelyingPartyMetadata
```
public static EntityDescriptor getRelyingPartyMetadata(String relyingPartyEntityId,
                                       RelyingPartyConfigurationManager rpConfigMngr)
```
    Gets the metatdata for a given relying party.
    
    パラメータ:
    relyingPartyEntityId - the ID of the relying party
    rpConfigMngr - relying party configuration manager
    
    戻り値:
    the metadata for the relying party or null if no SAML metadata exists for the given relying party
  - getSAML1AttributeAuthority
```
public static SAML1AttributeAuthority getSAML1AttributeAuthority(javax.servlet.ServletContext context)
```
    Gets the SAML1AttributeAuthority service bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getSAML1AttributeAuthority
```
public static SAML1AttributeAuthority getSAML1AttributeAuthority(javax.servlet.ServletContext context,
                                                 String serviceId)
```
    Gets the SAML1AttributeAuthority bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    serviceId - the ID under which the service bound
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getSAML2AttributeAuthority
```
public static SAML2AttributeAuthority getSAML2AttributeAuthority(javax.servlet.ServletContext context)
```
    Gets the SAML2AttributeAuthority service bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getSAML2AttributeAuthority
```
public static SAML2AttributeAuthority getSAML2AttributeAuthority(javax.servlet.ServletContext context,
                                                 String serviceId)
```
    Gets the SAML2AttributeAuthority bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    serviceId - the ID under which the service bound
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getSessionManager
```
public static SessionManager<Session> getSessionManager(javax.servlet.ServletContext context)
```
    Gets the SessionManager service bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getSessionManager
```
public static SessionManager<Session> getSessionManager(javax.servlet.ServletContext context,
                                        String serviceId)
```
    Gets the SessionManager bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    serviceId - the ID under which the service bound
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getStorageService
```
public static StorageService<?,?> getStorageService(javax.servlet.ServletContext context)
```
    Gets the StorageService service bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getStorageService
```
public static StorageService<?,?> getStorageService(javax.servlet.ServletContext context,
                                    String serviceId)
```
    Gets the StorageService bound to the Servlet context.
    
    パラメータ:
    context - the Servlet context
    serviceId - the ID under which the service bound
    
    戻り値:
    the service or null if there is no such service bound to the context
  - getUserSession
```
public static Session getUserSession(javax.servlet.http.HttpServletRequest httpRequest)
```
    Gets the user session from the request. Retrieving the session in this manner does NOT update the last activity time of the session.
    
    パラメータ:
    httpRequest - current request
    
    戻り値:
    the users session, if one exists
  - unbindLoginContext
```
public static LoginContext unbindLoginContext(StorageService storageService,
                              javax.servlet.ServletContext context,
                              javax.servlet.http.HttpServletRequest httpRequest,
                              javax.servlet.http.HttpServletResponse httpResponse)
```
    Unbinds a LoginContext from the current request. The unbinding results in the destruction of the associated context key cookie and removes the context from the storage service.
    
    パラメータ:
    storageService - storage service holding the context
    context - the Servlet context
    httpRequest - current HTTP request
    httpResponse - current HTTP response
    
    戻り値:
    the login context that was unbound or null if there was no bound context
  - getServletContextUrl
```
public static URLBuilder getServletContextUrl(javax.servlet.http.HttpServletRequest httpRequest)
```
    Builds a URL, up to and including the servlet context path. URL does not include a trailing "/".
    
    パラメータ:
    httpRequest - httpRequest made to the servlet in question
    
    戻り値:
    URL builder containing the scheme, server name, server port, and context path
  - getContextRelativeUrl
```
public static URLBuilder getContextRelativeUrl(javax.servlet.http.HttpServletRequest httpRequest,
                               String path)
```
    Builds a URL to a path that is meant to be relative to the Servlet context.
    
    パラメータ:
    httpRequest - current HTTP request
    path - path relative to the context, may start with a "/"
    
    戻り値:
    URL builder containing the scheme, server name, server port, and full path

クラス HttpServletHelper

フィールドの概要

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

COOKIE_DOMAIN_PARAM

IDP_SESSION_COOKIE

LOGIN_CTX_KEY_NAME

ATTRIBUTE_FILTER_ENGINE_SID_CTX_PARAM

ATTRIBUTE_RESOLVER_SID_CTX_PARAM

LOGIN_CTX_PARTITION_CTX_PARAM

PROFILE_HANDLER_MNGR_SID_CTX_PARAM

RP_CONFIG_MNGR_SID_CTX_PARAM

SAML1_AA_SID_CTX_PARAM

SAML2_AA_SID_CTX_PARAM

SESSION_MNGR_SID_CTX_PARAM

STORAGE_SERVICE_SID_CTX_PARAM

DEFAULT_ATTRIBUTE_FILTER_ENGINE_SID

DEFAULT_ATTRIBUTE_RESOLVER_SID

DEFAULT_LOGIN_CTX_PARITION

DEFAULT_PROFILE_HANDLER_MNGR_SID

DEFAULT_RP_CONFIG_MNGR_SID

DEFAULT_SAML1_AA_SID

DEFAULT_SAML2_AA_SID

DEFAULT_SESSION_MNGR_SID

DEFAULT_STORAGE_SERVICE_SID

コンストラクタの詳細

HttpServletHelper

メソッドの詳細

bindLoginContext

bindLoginContext

getCookieDomain

getAttributeFilterEnginer

getAttributeFilterEnginer

getAttributeResolver

getAttributeResolver

getContextParam

getCookie

getLoginContext

getLoginContext

getProfileHandlerManager

getProfileHandlerManager

getRelyingPartyConfigurationManager

getRelyingPartyConfigurationManager

getRelyingPartyConfirmationManager

getRelyingPartyConfirmationManager

getRelyingPartyMetadata

getSAML1AttributeAuthority

getSAML1AttributeAuthority

getSAML2AttributeAuthority

getSAML2AttributeAuthority

getSessionManager

getSessionManager

getStorageService

getStorageService

getUserSession

unbindLoginContext

getServletContextUrl

getContextRelativeUrl