com.haulmont.cuba.web.auth

Class IdpAuthProvider

java.lang.Object

com.haulmont.cuba.web.auth.IdpAuthProvider

All Implemented Interfaces:

CubaAuthProvider, javax.servlet.Filter

public class IdpAuthProvider
extends java.lang.Object
implements CubaAuthProvider

Authentication provider that supports CUBA IDP web service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdpAuthProvider.IdpActivationException
static class	IdpAuthProvider.IdpServletRequestWrapper
static interface	IdpAuthProvider.IdpSessionPrincipal
static class	IdpAuthProvider.IdpSessionPrincipalImpl

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IDP_SESSION_ATTRIBUTE
static java.lang.String	IDP_SESSION_LOCK_ATTRIBUTE
static java.lang.String	IDP_TICKET_REQUEST_PARAM

Fields inherited from interface com.haulmont.cuba.web.auth.CubaAuthProvider

NAME

Constructor Summary

Constructors

Constructor and Description
IdpAuthProvider()

Method Summary

Modifier and Type	Method and Description
void	authenticate(java.lang.String login, java.lang.String password, java.util.Locale locale) Login procedure with user and password.
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
void	init(javax.servlet.FilterConfig filterConfig)
java.lang.String	logout() Logout from external authentication
void	pingUserSession(UserSession session) Send ping to identity provider if supported by auth provider.
void	userSessionLoggedIn(UserSession session) Handler for user session logged in event.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IDP_SESSION_ATTRIBUTE

public static final java.lang.String IDP_SESSION_ATTRIBUTE

See Also:

Constant Field Values

IDP_SESSION_LOCK_ATTRIBUTE

public static final java.lang.String IDP_SESSION_LOCK_ATTRIBUTE

See Also:

Constant Field Values

IDP_TICKET_REQUEST_PARAM

public static final java.lang.String IDP_TICKET_REQUEST_PARAM

See Also:

Constant Field Values

Constructor Detail

IdpAuthProvider

public IdpAuthProvider()

Method Detail

authenticate

public void authenticate(java.lang.String login,
                         java.lang.String password,
                         java.util.Locale locale)
                  throws LoginException

Description copied from interface: CubaAuthProvider

Login procedure with user and password.

Specified by:

authenticate in interface CubaAuthProvider

Parameters:

login - User login

password - User password

locale - Locale for error messages

Throws:

LoginException - Login exception

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

java.io.IOException

javax.servlet.ServletException

userSessionLoggedIn

public void userSessionLoggedIn(UserSession session)

Description copied from interface: CubaAuthProvider

Handler for user session logged in event. Called by application UI tier when CUBA user session is created. Triggered after standard session initialization, right before UI initialization.

Specified by:

userSessionLoggedIn in interface CubaAuthProvider

Parameters:

session - user session

pingUserSession

public void pingUserSession(UserSession session)

Description copied from interface: CubaAuthProvider

Send ping to identity provider if supported by auth provider.

Specified by:

pingUserSession in interface CubaAuthProvider

Parameters:

session - user session

logout

public java.lang.String logout()

Description copied from interface: CubaAuthProvider

Logout from external authentication

Specified by:

logout in interface CubaAuthProvider

Returns:

target url of external identity provider or null

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter