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

public @Interface LoginToContinue

extends Annotation
Annotations
@Inherited
@InterceptorBinding
@Retention:RUNTIME
@Target:TYPE
Static Imports
java.lang.annotation.ElementType.TYPE, .RetentionPolicy.RUNTIME
The LoginToContinue annotation provides an application the ability to declaratively add login to continue functionality to an authentication mechanism.

When the LoginToContinue annotation is used on a custom authentication mechanism, 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.

When the LoginToContinue annotation is used as attribute in either the FormAuthenticationMechanismDefinition or CustomFormAuthenticationMechanismDefinition, expressions using immediate syntax are evaluated only once when the HttpAuthenticationMechanism bean is created. Since these beans are application scoped, this means only once per application. Expressions using deferred syntax are evaluated as described above when the LoginToContinue annotation is used on a custom authentication mechanism.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

page a caller is directed to after an authentication (login) error
errorPage()

The resource (page) a caller should get to see in case an error, such as providing invalid credentials, occurs on the page set by LoginToContinue#loginPage().

public String

Returns:

page a caller is directed to to authenticate (login)
loginPage()

The resource (page) a caller should get to see in case the originally requested resource requires authentication, and the caller is currently not authenticated.

public boolean

Returns:

true if a forward is to be used, false for a redirect
useForwardToLogin()

Use a forward to reach the page set by the LoginToContinue#loginPage() if true, otherwise use a redirect.

public String

Returns:

an expression evaluating to true if a forward is to be used, false for a redirect
useForwardToLoginExpression()

EL expression variant of useForwardToLogin().

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

errorPageback to summary
public String errorPage()

The resource (page) a caller should get to see in case an error, such as providing invalid credentials, occurs on the page set by LoginToContinue#loginPage().

Returns:String

page a caller is directed to after an authentication (login) error

Annotations
@Nonbinding
loginPageback to summary
public String loginPage()

The resource (page) a caller should get to see in case the originally requested resource requires authentication, and the caller is currently not authenticated.

Returns:String

page a caller is directed to to authenticate (login)

Annotations
@Nonbinding
useForwardToLoginback to summary
public boolean useForwardToLogin()

Use a forward to reach the page set by the LoginToContinue#loginPage() if true, otherwise use a redirect.

Returns:boolean

true if a forward is to be used, false for a redirect

Annotations
@Nonbinding
useForwardToLoginExpressionback to summary
public String useForwardToLoginExpression()

EL expression variant of useForwardToLogin(). The expression needs to evaluate to a boolean outcome. All named CDI beans are available to the expression. If both this attribute and useForwardToLogin() are specified, this attribute take precedence.

Returns:String

an expression evaluating to true if a forward is to be used, false for a redirect

Annotations
@Nonbinding