public interface HttpMessageContext
HttpMessageContext
contains all of the per-request state information and encapsulates the client request,
server response, container handler for authentication callbacks, and the subject representing the caller.Modifier and Type | Method and Description |
---|---|
void |
cleanClientSubject()
Convenience method to clean the subject associated with this context.
|
AuthenticationStatus |
doNothing()
Instructs the container to "do nothing".
|
AuthenticationStatus |
forward(String path)
Forwards to another resource (Jakarta Servlet, Jakarta Server Pages file, or HTML file) on the server.
|
AuthenticationParameters |
getAuthParameters()
Returns the parameters that were provided with the SecurityContext#authenticate(AuthParameters) call.
|
Principal |
getCallerPrincipal()
Gets the Principal set by a call to notifyContainerAboutLogin().
|
Subject |
getClientSubject()
Returns the subject for which authentication is to take place.
|
Set<String> |
getGroups()
Gets the groups set by a call to notifyContainerAboutLogin().
|
CallbackHandler |
getHandler()
Returns the low level Jakarta Authentication handler that the runtime provided when creating this
HttpMessageContext , and which this context uses to communicate the authentication details to the runtime. |
javax.security.auth.message.MessageInfo |
getMessageInfo()
Returns the the low level Jakarta Authentication message info instance for the current request.
|
javax.servlet.http.HttpServletRequest |
getRequest()
Returns the request object associated with the current request.
|
javax.servlet.http.HttpServletResponse |
getResponse()
Returns the response object associated with the current request.
|
boolean |
isAuthenticationRequest()
Checks if the current call to an authentication mechanism is the result from the
application calling
SecurityContext.authenticate(HttpServletRequest, HttpServletResponse, AuthenticationParameters) |
boolean |
isProtected()
Checks if the currently requested resource is protected or not.
|
boolean |
isRegisterSession()
Check if the runtime has been asked to register an authentication session duing the current request.
|
AuthenticationStatus |
notifyContainerAboutLogin(CredentialValidationResult result)
Convenience method intended to pass the
CredentialValidationResult result of an
identity store directly on to the container. |
AuthenticationStatus |
notifyContainerAboutLogin(Principal principal,
Set<String> groups)
Asks the container to register the given caller principal and groups in order to make
them available to the application for use with
SecurityContext.isCallerInRole(String) etc. |
AuthenticationStatus |
notifyContainerAboutLogin(String callername,
Set<String> groups)
Asks the container to register the given caller name and groups in order to make
them available to the application for use with
SecurityContext.isCallerInRole(String) etc. |
AuthenticationStatus |
redirect(String location)
Sets the response status to SC_FOUND 302 (Found)
|
AuthenticationStatus |
responseNotFound()
Sets the response status to 404 (not found).
|
AuthenticationStatus |
responseUnauthorized()
Sets the response status to 401 (unauthorized).
|
void |
setRegisterSession(String callerName,
Set<String> groups)
Asks the runtime to register an authentication session.
|
void |
setRequest(javax.servlet.http.HttpServletRequest request)
Sets the request object.
|
void |
setResponse(javax.servlet.http.HttpServletResponse response)
Set the response object.
|
HttpMessageContext |
withRequest(javax.servlet.http.HttpServletRequest request)
Sets the request object.
|
boolean isProtected()
web.xml
.boolean isAuthenticationRequest()
SecurityContext.authenticate(HttpServletRequest, HttpServletResponse, AuthenticationParameters)
If SecurityContext#authenticate was not called, the authentication mechanism may have been invoked by the container at the start of a request.
boolean isRegisterSession()
void setRegisterSession(String callerName, Set<String> groups)
HttpAuthenticationMechanism
has to manually re-authenticate with the runtime at the start of each request.callerName
- the caller name for which authentication should be be rememberedgroups
- the groups for which authentication should be remembered.void cleanClientSubject()
Cleaning this subject is done as defined by the Servlet Container Profile of Jakarta Authentication
for the ServerAuthModule#cleanSubject method and the
HttpAuthenticationMechanism.cleanSubject(HttpServletRequest, HttpServletResponse, HttpMessageContext)
method defined by this specification.
AuthenticationParameters getAuthParameters()
CallbackHandler getHandler()
HttpMessageContext
, and which this context uses to communicate the authentication details to the runtime.
Note: This is a low level object that most higher level code would not need to use directly.
javax.security.auth.message.MessageInfo getMessageInfo()
Note: This is a low level object that most higher level code would not need to use directly.
Subject getClientSubject()
Note: This is a low level object that most higher level code would not need to use directly.
javax.servlet.http.HttpServletRequest getRequest()
void setRequest(javax.servlet.http.HttpServletRequest request)
request
- the request object to be setHttpMessageContext withRequest(javax.servlet.http.HttpServletRequest request)
request
- the request object to be set.javax.servlet.http.HttpServletResponse getResponse()
void setResponse(javax.servlet.http.HttpServletResponse response)
response
- the response object to be set.AuthenticationStatus redirect(String location)
As a convenience this method returns SEND_CONTINUE, so this method can be used in
one fluent return statement from an HttpAuthenticationMechanism
location
- the location to redirect toAuthenticationStatus.SEND_CONTINUE
HttpServletResponse.sendRedirect(String)
AuthenticationStatus forward(String path)
As a convenience this method returns SEND_CONTINUE, so this method can be used in
one fluent return statement from an HttpAuthenticationMechanism
path
- a String specifying the pathname to the resource.AuthenticationStatus.SEND_CONTINUE
RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
AuthenticationStatus responseUnauthorized()
As a convenience this method returns SEND_FAILURE, so this method can be used in
one fluent return statement from an HttpAuthenticationMechanism
AuthenticationStatus.SEND_FAILURE
AuthenticationStatus responseNotFound()
As a convenience this method returns SEND_FAILURE, so this method can be used in
one fluent return statement from an HttpAuthenticationMechanism
AuthenticationStatus.SEND_FAILURE
AuthenticationStatus notifyContainerAboutLogin(String callername, Set<String> groups)
SecurityContext.isCallerInRole(String)
etc.
Note that after this call returned, the authenticated identity will not be immediately active. This will only take place (should no errors occur) after the authentication mechanism in which this call takes place returns control back to the container (runtime).
As a convenience this method returns SUCCESS, so this method can be used in
one fluent return statement from an HttpAuthenticationMechanism
callername
- the caller name that will become the caller principalgroups
- the groups associated with the caller principalAuthenticationStatus.SUCCESS
AuthenticationStatus notifyContainerAboutLogin(Principal principal, Set<String> groups)
SecurityContext.isCallerInRole(String)
etc.
Note that this call may result in the container establishing two caller principals to represent the caller's identity -- the Principal provided here as the principal parameter, and a second principal used as the container's representation of the caller identity. A second principal is added only if the container uses a different Principal type to represent the caller. If the types are the same, only one Principal is added.
If a second principal is added, the value returned by Principal.getName()
will be the same for both principals.
When two principals are added, the container's caller principal is returned from
SecurityContext.getCallerPrincipal()
, and the principal supplied here
as a parameter can be retrieved using SecurityContext.getPrincipalsByType(Class)
.
When only one is added, it is returned by SecurityContext.getCallerPrincipal()
.
Note that after this call returned, the authenticated identity will not be immediately active. This will only take place (should no errors occur) after the authentication mechanism in which this call takes place returns control back to the container (runtime).
As a convenience this method returns SUCCESS, so this method can be used in
one fluent return statement from an HttpAuthenticationMechanism
principal
- the Principal that will become the caller principalgroups
- the groups associated with the caller principalAuthenticationStatus.SUCCESS
AuthenticationStatus notifyContainerAboutLogin(CredentialValidationResult result)
CredentialValidationResult
result of an
identity store directly on to the container.
If the outcome from the given CredentialValidationResult.getStatus()
equals
CredentialValidationResult.Status.VALID
, the CallerPrincipal
and groups are obtained from the
CredentialValidationResult
and passed into
notifyContainerAboutLogin(Principal, Set)
.
If the outcome from the given CredentialValidationResult.getStatus()
is not
equal to CredentialValidationResult.Status.VALID
a failure result is returned.
result
- a CredentialValidationResult which is inspected for its status and from which the principal and groups
are taken.AuthenticationStatus.SUCCESS
if CredentialValidationResult.getStatus()
equals CredentialValidationResult.Status.VALID
otherwise AuthenticationStatus.SEND_FAILURE
AuthenticationStatus doNothing()
When intending to do nothing, a Jakarta Security authentication mechanism has to indicate this explicitly via its return value.
As a convenience this method returns NOT_DONE, so this method can be used in
one fluent return statement from an HttpAuthenticationMechanism
AuthenticationStatus.NOT_DONE
Principal getCallerPrincipal()
Comments to: es-dev@eclipse.org.
Copyright © 2019 Eclipse Foundation. All rights reserved.
Use is subject to license terms.