senselogic.sitevision.api.security

Interface AuthenticationUtil

@Requireable(value="AuthenticationUtil")
public interface AuthenticationUtil

Authentication utility interface.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getAuthenticationUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 2.6.1_03, Sitevision 2.7_01

Author:

Mikael Wikblom

Method Summary

Modifier and Type	Method and Description
void	login(HttpServletRequest aServletRequest, Map<String,String> sharedState) Authenticates a user based on a shared state map.
void	login(HttpServletRequest aServletRequest, String name, String password) Authenticates a user based on username and password.
void	login(PortletRequest aPortletRequest, Map<String,String> sharedState) Authenticates a user based on a shared state map.
void	login(PortletRequest aPortletRequest, String name, String password) Authenticates a user based on username and password.
void	logout(HttpServletRequest aServletRequest, boolean invalidateHttpSession) Logout current user based on a HttpServletRequest.
void	logout(PortletRequest aPortletRequest, boolean invalidateHttpSession) Logout current user based on a PortletRequest.
void	reLogin(HttpServletRequest aServletRequest) Re-authenticates a user based on a Subject already in the session.
void	reLogin(PortletRequest aPortletRequest) Re-authenticates a user based on a Subject already in the session.

Method Detail

logout

void logout(HttpServletRequest aServletRequest,
            boolean invalidateHttpSession)

Logout current user based on a HttpServletRequest.

Parameters:

aServletRequest - the current servlet request

invalidateHttpSession - whether or not the session should be invalidated. This is normally not the case

logout

void logout(PortletRequest aPortletRequest,
            boolean invalidateHttpSession)

Logout current user based on a PortletRequest.

Parameters:

aPortletRequest - the current portlet request

invalidateHttpSession - whether or not the session should be invalidated. This is normally not the case

login

void login(HttpServletRequest aServletRequest,
           Map<String,String> sharedState)
    throws LoginException

Authenticates a user based on a shared state map.

Parameters:

aServletRequest - the current servlet request

sharedState - a map containing "javax.security.auth.login.name" and "javax.security.auth.login.password"

Throws:

LoginException - if login fails

Since:

Sitevision 2.6.2_06

login

void login(HttpServletRequest aServletRequest,
           String name,
           String password)
    throws LoginException

Authenticates a user based on username and password.

Parameters:

aServletRequest - the current servlet request

name - a username

password - a password

Throws:

LoginException - if login fails

Since:

Sitevision 2.6.2_06

reLogin

void reLogin(HttpServletRequest aServletRequest)
      throws LoginException

Re-authenticates a user based on a Subject already in the session.

Parameters:

aServletRequest - the current servlet request

Throws:

LoginException - if login fails

Since:

Sitevision 2.6.2_06

login

void login(PortletRequest aPortletRequest,
           Map<String,String> sharedState)
    throws LoginException

Authenticates a user based on a shared state map.

Parameters:

aPortletRequest - the current portlet request

sharedState - a map containing "javax.security.auth.login.name" and "javax.security.auth.login.password"

Throws:

LoginException - if login fails

Since:

Sitevision 2.6.2_06

login

void login(PortletRequest aPortletRequest,
           String name,
           String password)
    throws LoginException

Authenticates a user based on username and password.

Parameters:

aPortletRequest - the current portlet request

name - a username

password - a password

Throws:

LoginException - if login fails

Since:

Sitevision 2.6.2_06

reLogin

void reLogin(PortletRequest aPortletRequest)
      throws LoginException

Re-authenticates a user based on a Subject already in the session.

Parameters:

aPortletRequest - the current portlet request

Throws:

LoginException - if login fails

Since:

Sitevision 2.6.2_06