LoginContext (Shibboleth Identity Provider 2.3.0 API)

java.lang.Object
- edu.internet2.middleware.shibboleth.idp.authn.LoginContext

すべての実装されたインタフェース:

Serializable

直系の既知のサブクラス:

Saml2LoginContext, ShibbolethSSOLoginContext
```
public class LoginContext
extends Object
implements Serializable
```
Login context created by a profile handler and interpreted by the authentication package. Two properties are tracked by default:
- forceAuth - Should user authentication be forced (default value: false).
- passiveAuth - Should user authentication not control the UI (default value: false).
A Map<String, Object> is provided to store other properties. Alternatively, a profile handler may create a subclass of LoginContext with extra fields. LoginContexts should be created by a profile handler when authentication is needed. Once control has returned to the profile handler, it should remove the LoginContext from the HttpSession. The AuthenticationEngine should set the setAuthenticationAttempted(), setPrincipalAuthenticated(boolean), setAuthenticationFailure(AuthenticationException), appropriately.
関連項目:
直列化された形式

フィールドの概要

フィールド
修飾子とタイプフィールドと説明

static String LOGIN_CONTEXT_KEY
the key in a HttpSession where login contexts are stored.

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`LOGIN_CONTEXT_KEY` the key in a HttpSession where login contexts are stored.

コンストラクタの概要

コンストラクタ
コンストラクタと説明
`LoginContext()` Creates a new instance of LoginContext.
`LoginContext(boolean force, boolean passive)` Creates a new instance of LoginContext.

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`String`	`getAttemptedAuthnMethod()` Gets the authentication method that was used when attempting to authenticate the user.
`boolean`	`getAuthenticationAttempted()` Returns if authentication has been attempted for this user.
`long`	`getAuthenticationDuration()` Gets the duration of authentication.
`String`	`getAuthenticationEngineURL()` Gets the authentication engine's URL.
`AuthenticationException`	`getAuthenticationFailure()` Gets the error that occurred during authentication.
`org.joda.time.DateTime`	`getAuthenticationInstant()` Gets the authentication instant.
`String`	`getAuthenticationMethod()` Gets the method used to authenticate the user.
`AuthenticationMethodInformation`	`getAuthenticationMethodInformation()` Gets information about the authentication event.
`String`	`getDefaultAuthenticationMethod()` Gets the authentication method to use if none is requested.
`String`	`getPrincipalName()` Returns the ID of the authenticated user.
`String`	`getProfileHandlerURL()` Gets the ProfileHandler URL.
`Object`	`getProperty(String key)` Get an optional property object.
`String`	`getRelyingPartyId()` Gets the entity ID of the relying party.
`List<String>`	`getRequestedAuthenticationMethods()` Return the acceptable authentication handler URIs, in preference order, for authenticating this user.
`String`	`getSessionID()` Gets the `Session` ID.
`boolean`	`isForceAuthRequired()` Returns if authentication must be forced.
`boolean`	`isPassiveAuthRequired()` Returns if authentication must be passive.
`boolean`	`isPrincipalAuthenticated()` Returns if authentication succeeded.
`void`	`setAttemptedAuthnMethod(String method)` Sets the authentication method that was used when attempting to authenticate the user.
`void`	`setAuthenticationAttempted()` Set if authentication has been attempted.
`void`	`setAuthenticationDuration(long duration)` 推奨されていません。 this information is contained in the `AuthenticationMethodInformation`
`void`	`setAuthenticationEngineURL(String url)` Sets the authentication engine's URL.
`void`	`setAuthenticationFailure(AuthenticationException error)` Sets the error that occurred during authentication.
`void`	`setAuthenticationInstant(org.joda.time.DateTime instant)` 推奨されていません。 this information is contained in the `AuthenticationMethodInformation`
`void`	`setAuthenticationMethod(String method)` 推奨されていません。 this information is contained in the `AuthenticationMethodInformation`
`void`	`setAuthenticationMethodInformation(AuthenticationMethodInformation info)` Sets the information about the authentication event.
`void`	`setDefaultAuthenticationMethod(String method)` Sets the authentication method to use if none is requested.
`void`	`setForceAuthRequired(boolean force)` Sets if authentication must be forced.
`void`	`setPassiveAuthRequired(boolean passive)` Sets if authentication must be passive.
`void`	`setPrincipalAuthenticated(boolean authnOK)` Sets if authentication succeeded.
`void`	`setPrincipalName(String id)` 推奨されていません。 this information is contained in the `AuthenticationMethodInformation`
`void`	`setProfileHandlerURL(String url)` Sets the ProfileHandler URL.
`void`	`setProperty(String key, Serializable obj)` Sets an optional property object.
`void`	`setRelyingParty(String id)` Gets the entity ID of the relying party.
`void`	`setSessionID(String id)` Sets the `Session` ID.

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

- フィールドの詳細
  - LOGIN_CONTEXT_KEY
```
public static final String LOGIN_CONTEXT_KEY
```
    the key in a HttpSession where login contexts are stored.
    
    関連項目:
    定数フィールド値
- コンストラクタの詳細
  - LoginContext
```
public LoginContext()
```
    Creates a new instance of LoginContext.
  - LoginContext
```
public LoginContext(boolean force,
            boolean passive)
```
    Creates a new instance of LoginContext.
    
    パラメータ:
    force - if the authentication manager must re-authenticate the user.
    passive - if the authentication manager must not interact with the users UI.
- メソッドの詳細
  - getAttemptedAuthnMethod
```
public String getAttemptedAuthnMethod()
```
    Gets the authentication method that was used when attempting to authenticate the user. Note, this may be different than the authentication method reported within getAuthenticationMethodInformation().
    
    戻り値:
    authentication method that was used when attempting to authenticate the user
  - getAuthenticationAttempted
```
public boolean getAuthenticationAttempted()
```
    Returns if authentication has been attempted for this user.
    
    戻り値:
    if authentication has been attempted for this user
  - getAuthenticationDuration
```
public long getAuthenticationDuration()
```
    Gets the duration of authentication.
    
    戻り値:
    The duration of authentication, or zero if none was set.
  - getAuthenticationEngineURL
```
public String getAuthenticationEngineURL()
```
    Gets the authentication engine's URL.
    
    戻り値:
    the URL of the authentication engine
  - getAuthenticationFailure
```
public AuthenticationException getAuthenticationFailure()
```
    Gets the error that occurred during authentication.
    
    戻り値:
    error that occurred during authentication
  - getAuthenticationInstant
```
public org.joda.time.DateTime getAuthenticationInstant()
```
    Gets the authentication instant.
    
    戻り値:
    The instant of authentication, or null if none was set.
  - getAuthenticationMethod
```
public String getAuthenticationMethod()
```
    Gets the method used to authenticate the user.
    
    戻り値:
    The method used to authenticate the user.
  - getAuthenticationMethodInformation
```
public AuthenticationMethodInformation getAuthenticationMethodInformation()
```
    Gets information about the authentication event.
    
    戻り値:
    information about the authentication event.
  - getDefaultAuthenticationMethod
```
public String getDefaultAuthenticationMethod()
```
    Gets the authentication method to use if none is requested.
    
    戻り値:
    authentication method to use if none is requested, may be null which indicates any method may be used
  - getPrincipalName
```
public String getPrincipalName()
```
    Returns the ID of the authenticated user.
    
    戻り値:
    the ID of the user, or null if authentication failed.
  - getProfileHandlerURL
```
public String getProfileHandlerURL()
```
    Gets the ProfileHandler URL.
    
    戻り値:
    the URL of the profile handler that is invoking the Authentication Manager.
  - getProperty
```
public Object getProperty(String key)
```
    Get an optional property object.
    
    パラメータ:
    key - The key in the properties Map.
    
    戻り値:
    The object, or null is no object exists for the key.
  - getRelyingPartyId
```
public String getRelyingPartyId()
```
    Gets the entity ID of the relying party.
    
    戻り値:
    entity ID of the relying party
  - getRequestedAuthenticationMethods
```
public List<String> getRequestedAuthenticationMethods()
```
    Return the acceptable authentication handler URIs, in preference order, for authenticating this user. If no authentication methods are preferred the resultant list will be empty.
    
    戻り値:
    an list of authentication method identifiers
  - getSessionID
```
public String getSessionID()
```
    Gets the Session ID.
    
    戻り値:
    the Session id
  - isForceAuthRequired
```
public boolean isForceAuthRequired()
```
    Returns if authentication must be forced.
    
    戻り値:
    true if the authentication manager must re-authenticate the user.
  - isPassiveAuthRequired
```
public boolean isPassiveAuthRequired()
```
    Returns if authentication must be passive.
    
    戻り値:
    true if the authentication manager must not interact with the users UI.
  - isPrincipalAuthenticated
```
public boolean isPrincipalAuthenticated()
```
    Returns if authentication succeeded.
    
    戻り値:
    true is the user was successfully authenticated.
  - setAttemptedAuthnMethod
```
public void setAttemptedAuthnMethod(String method)
```
    Sets the authentication method that was used when attempting to authenticate the user.
    
    パラメータ:
    method - authentication method that was used when attempting to authenticate the user
  - setAuthenticationAttempted
```
public void setAuthenticationAttempted()
```
    Set if authentication has been attempted. This method should be called by an LoginHandler while processing a request.
  - setAuthenticationDuration
```
public void setAuthenticationDuration(long duration)
```
    推奨されていません。 this information is contained in the AuthenticationMethodInformation
    
    Sets the duration of authentication.
    
    パラメータ:
    duration - The duration of authentication.
  - setAuthenticationEngineURL
```
public void setAuthenticationEngineURL(String url)
```
    Sets the authentication engine's URL.
    
    パラメータ:
    url - the URL of the authentication engine
  - setAuthenticationFailure
```
public void setAuthenticationFailure(AuthenticationException error)
```
    Sets the error that occurred during authentication.
    
    パラメータ:
    error - error that occurred during authentication
  - setAuthenticationInstant
```
public void setAuthenticationInstant(org.joda.time.DateTime instant)
```
    推奨されていません。 this information is contained in the AuthenticationMethodInformation
    
    Sets the authentication instant.
    
    パラメータ:
    instant - The instant of authentication.
  - setAuthenticationMethod
```
public void setAuthenticationMethod(String method)
```
    推奨されていません。 this information is contained in the AuthenticationMethodInformation
    
    Sets the method used to authenticate the user.
    
    パラメータ:
    method - The method used to authenticate the user.
  - setAuthenticationMethodInformation
```
public void setAuthenticationMethodInformation(AuthenticationMethodInformation info)
```
    Sets the information about the authentication event.
    
    パラメータ:
    info - information about the authentication event
  - setDefaultAuthenticationMethod
```
public void setDefaultAuthenticationMethod(String method)
```
    Sets the authentication method to use if none is requested.
    
    パラメータ:
    method - authentication method to use if none is requested, may be null which indicates any method may be used
  - setForceAuthRequired
```
public void setForceAuthRequired(boolean force)
```
    Sets if authentication must be forced.
    
    パラメータ:
    force - if the authentication manager must re-authenticate the user.
  - setPassiveAuthRequired
```
public void setPassiveAuthRequired(boolean passive)
```
    Sets if authentication must be passive.
    
    パラメータ:
    passive - if the authentication manager must not interact with the users UI.
  - setPrincipalAuthenticated
```
public void setPrincipalAuthenticated(boolean authnOK)
```
    Sets if authentication succeeded.
    
    パラメータ:
    authnOK - if authentication succeeded;
  - setPrincipalName
```
public void setPrincipalName(String id)
```
    推奨されていません。 this information is contained in the AuthenticationMethodInformation
    
    Sets the ID of the authenticated user.
    
    パラメータ:
    id - The userid.
  - setProfileHandlerURL
```
public void setProfileHandlerURL(String url)
```
    Sets the ProfileHandler URL.
    
    パラメータ:
    url - The URL of the profile handler that invoked the AuthenticationManager/
  - setProperty
```
public void setProperty(String key,
               Serializable obj)
```
    Sets an optional property object. If an object is already associated with key, it will be overwritten.
    
    パラメータ:
    key - The key to set.
    obj - The object to associate with key.
  - setRelyingParty
```
public void setRelyingParty(String id)
```
    Gets the entity ID of the relying party.
    
    パラメータ:
    id - entity ID of the relying party
  - setSessionID
```
public void setSessionID(String id)
```
    Sets the Session ID.
    
    パラメータ:
    id - the Session ID

クラス LoginContext

フィールドの概要

コンストラクタの概要

メソッドの概要

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

フィールドの詳細

LOGIN_CONTEXT_KEY

コンストラクタの詳細

LoginContext

LoginContext

メソッドの詳細

getAttemptedAuthnMethod

getAuthenticationAttempted

getAuthenticationDuration

getAuthenticationEngineURL

getAuthenticationFailure

getAuthenticationInstant

getAuthenticationMethod

getAuthenticationMethodInformation

getDefaultAuthenticationMethod

getPrincipalName

getProfileHandlerURL

getProperty

getRelyingPartyId

getRequestedAuthenticationMethods

getSessionID

isForceAuthRequired

isPassiveAuthRequired

isPrincipalAuthenticated

setAttemptedAuthnMethod

setAuthenticationAttempted

setAuthenticationDuration

setAuthenticationEngineURL

setAuthenticationFailure

setAuthenticationInstant

setAuthenticationMethod

setAuthenticationMethodInformation

setDefaultAuthenticationMethod

setForceAuthRequired

setPassiveAuthRequired

setPrincipalAuthenticated

setPrincipalName

setProfileHandlerURL

setProperty

setRelyingParty

setSessionID