com.redhat.rhn.frontend.security

Interface AuthenticationService

All Known Implementing Classes:

BaseAuthenticationService, PxtAuthenticationService

public interface AuthenticationService

An AuthenticationService is a service that encapsulates authentication logic in coarse- grained operations. Note that this service does not handle logins.

Method Summary

Modifier and Type	Method and Description
void	invalidate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Invalidates login credentials associated with the given request.
void	redirectTo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String path) Redirects the request to a different page Used in restricted period after grace period has expired to prevent basic satellite functionality
void	redirectToLogin(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Redirects the request to whatever resource handles logins.
boolean	skipCsfr(javax.servlet.http.HttpServletRequest request) CSFR check might be skipped for particular POST requests f.e.
boolean	validate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Validate whatever credentials are associated with the request.

Method Detail

validate

boolean validate(javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response)
          throws javax.servlet.ServletException

Validate whatever credentials are associated with the request. For hosted, this will be the sso cookie, and for satellite, this will be the pxt cookie. If validation fails, implementors should throw an AuthenticationException. Note that if an implementation does not support/implement this operation, an AuthenticationException should be thrown, and not an UnsupportedOperationException.

Parameters:

request - The current request

response - The current response

Returns:

True is validation succeeds, false otherwise.

Throws:

javax.servlet.ServletException - If an unrecoverable error occurs

skipCsfr

boolean skipCsfr(javax.servlet.http.HttpServletRequest request)

CSFR check might be skipped for particular POST requests f.e. all login pages

Parameters:

request - The current request

Returns:

True if CSFR check shall be skipped for current request

redirectToLogin

void redirectToLogin(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException

Redirects the request to whatever resource handles logins. This method is typically invoked after a call to validate(HttpServletRequest, HttpServletResponse) fails. Note that the redirect may be client-side or server-side, and it may be to an external or an internal resource.

Parameters:

request - the request

response - the response

Throws:

javax.servlet.ServletException - If an unrecoverable error occurs

redirectTo

void redirectTo(javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response,
                java.lang.String path)
         throws javax.servlet.ServletException

Redirects the request to a different page Used in restricted period after grace period has expired to prevent basic satellite functionality

Parameters:

request - the request

response - the response

path - where to redirect

Throws:

javax.servlet.ServletException - If an unrecoverable error occurs

invalidate

void invalidate(javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response)
         throws javax.servlet.ServletException

Invalidates login credentials associated with the given request.

Parameters:

request - The current request

response - The current response

Throws:

javax.servlet.ServletException - If an unrecoverable error occurs