Top Description Methods
javax.security.enterprise.authentication.mechanism.http

public @Interface RememberMe

extends Annotation
Annotations
@Inherited
@InterceptorBinding
@Retention:RUNTIME
@Target:TYPE
Static Imports
java.lang.annotation.ElementType.TYPE, .RetentionPolicy.RUNTIME
The RememberMe annotation provides an application the ability to declaratively designate that an authentication mechanism effectively "remembers" the authentication and auto applies this with every request.

For the remember me function the credentials provided by the caller are exchanged for a (long-lived) token which is send to the user as the value of a cookie, in a similar way to how the HTTP session ID is send. It should be realized that this token effectively becomes the credential to establish the caller's identity within the application and care should be taken to handle and store the token securely. E.g. by using this feature with a secure transport (SSL/HTTPS), storing a strong hash instead of the actual token, and implementing an expiration policy.

The token is vended by a special purpose IdentityStore-like artifact; an implementation of the RememberMeIdentityStore.

This support is provided via an implementation of an interceptor spec interceptor that conducts the necessary logic.

Example: 


    @RequestScoped
    @RememberMe
    public class CustomAuthenticationMechanism implements HttpAuthenticationMechanism {
        // ...
    }

EL expressions in attributes of type String are evaluated for every request requiring authentication. Both immediate and deferred syntax is supported, but effectively the semantics are always deferred.

Note

this facility DOES NOT constitute any kind of "session management" system, but instead represents a special purpose authentication mechanism using a long-lived token, that is vended and validated by the RememberMeIdentityStore.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the cookie should be sent only with HTTP requests (and not be made available to client-side scripting code), false otherwise.
cookieHttpOnly()

Flag to indicate that the remember me cookie should not be exposed to client-side scripting code, and should only be sent with HTTP requests.

public String

Returns:

an expression evaluating to true if the cookie should be sent only with HTTP requests , false otherwise.
cookieHttpOnlyExpression()

EL expression variant of cookieHttpOnly().

public int

Returns:

Max age in seconds
cookieMaxAgeSeconds()

Max age in seconds for the remember me cookie.

public String

Returns:

an expression evaluating to an integer designating the max age in seconds for the remember me cookie.
cookieMaxAgeSecondsExpression()

EL expression variant of cookieMaxAgeSeconds().

public String

Returns:

The name of the cookie
cookieName()

Name of the remember me cookie.

public boolean

Returns:

true if the cookie should be sent using a secure protocol only false for any protocol.
cookieSecureOnly()

Flag to indicate that the remember me cookie should only be sent using a secure protocol (e.g. HTTPS or SSL).

public String

Returns:

an expression evaluating to an integer designating the max age in seconds for the remember me cookie.
cookieSecureOnlyExpression()

EL expression variant of cookieSecureOnly().

public boolean

Returns:

Flag to determine if remember me should be used
isRememberMe()

Flag to determine if remember me should be used.

public String

Returns:

EL expression to determine if remember me should be used
isRememberMeExpression()

EL expression to determine if remember me should be used.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

cookieHttpOnlyback to summary
public boolean cookieHttpOnly()

Flag to indicate that the remember me cookie should not be exposed to client-side scripting code, and should only be sent with HTTP requests.

Returns:boolean

true if the cookie should be sent only with HTTP requests (and not be made available to client-side scripting code), false otherwise.

Annotations
@Nonbinding
See Also
Cookie#setHttpOnly(boolean)
cookieHttpOnlyExpressionback to summary
public String cookieHttpOnlyExpression()

EL expression variant of cookieHttpOnly(). The expression needs to evaluate to a boolean outcome. All named CDI beans are available to the expression as well as default classes as specified by EL 3.0 for the ELProcessor and the implicit objects "self" which refers to the interceptor target and "httpMessageContext" which refers to the current HttpMessageContext. If both this attribute and cookieHttpOnly() are specified, this attribute takes precedence.

Returns:String

an expression evaluating to true if the cookie should be sent only with HTTP requests , false otherwise.

Annotations
@Nonbinding
cookieMaxAgeSecondsback to summary
public int cookieMaxAgeSeconds()

Max age in seconds for the remember me cookie. Defaults to one day.

Returns:int

Max age in seconds

Annotations
@Nonbinding
See Also
Cookie#setMaxAge(int)
cookieMaxAgeSecondsExpressionback to summary
public String cookieMaxAgeSecondsExpression()

EL expression variant of cookieMaxAgeSeconds(). The expression needs to evaluate to an integer outcome. All named CDI beans are available to the expression as well as default classes as specified by EL 3.0 for the ELProcessor and the implicit objects "self" which refers to the interceptor target and "httpMessageContext" which refers to the current HttpMessageContext. If both this attribute and cookieMaxAgeSeconds() are specified, this attribute takes precedence.

Returns:String

an expression evaluating to an integer designating the max age in seconds for the remember me cookie.

Annotations
@Nonbinding
cookieNameback to summary
public String cookieName()

Name of the remember me cookie.

Returns:String

The name of the cookie

Annotations
@Nonbinding
See Also
Cookie#getName()
cookieSecureOnlyback to summary
public boolean cookieSecureOnly()

Flag to indicate that the remember me cookie should only be sent using a secure protocol (e.g. HTTPS or SSL).

Returns:boolean

true if the cookie should be sent using a secure protocol only false for any protocol.

Annotations
@Nonbinding
See Also
Cookie#setSecure(boolean)
cookieSecureOnlyExpressionback to summary
public String cookieSecureOnlyExpression()

EL expression variant of cookieSecureOnly(). The expression needs to evaluate to a boolean outcome. All named CDI beans are available to the expression as well as default classes as specified by EL 3.0 for the ELProcessor and the implicit objects "self" which refers to the interceptor target and "httpMessageContext" which refers to the current HttpMessageContext. If both this attribute and cookieSecureOnly() are specified, this attribute takes precedence.

Returns:String

an expression evaluating to an integer designating the max age in seconds for the remember me cookie.

Annotations
@Nonbinding
isRememberMeback to summary
public boolean isRememberMe()

Flag to determine if remember me should be used.

Returns:boolean

Flag to determine if remember me should be used

Annotations
@Nonbinding
isRememberMeExpressionback to summary
public String isRememberMeExpression()

EL expression to determine if remember me should be used. This is evaluated for every request requiring authentication. The expression needs to evaluate to a boolean outcome. All named CDI beans are available to the expression as well as default classes as specified by EL 3.0 for the ELProcessor and the implicit objects "self" which refers to the interceptor target and "httpMessageContext" which refers to the current HttpMessageContext.

Returns:String

EL expression to determine if remember me should be used

Annotations
@Nonbinding