net.shibboleth.idp.authn.spnego.impl

Class SPNEGOAutoLoginManager

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.idp.authn.spnego.impl.SPNEGOAutoLoginManager

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent

public class SPNEGOAutoLoginManager
extends AbstractInitializableComponent

Component managing the auto-login state via cookie.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTOLOGIN_COOKIE_NAME Name of the SPNEGO auto-login cookie.
static String	AUTOLOGIN_COOKIE_VALUE_TRUE SPNEGO auto-login cookie value representing true.
static String	AUTOLOGIN_PARAMETER_NAME Name of the SPNEGO auto-login signaling parameter.
private CookieManager	cookieManager Manages creation of cookies.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
SPNEGOAutoLoginManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	disable() Disable auto-login.
protected void	doInitialize()
void	enable() Enable auto-login, i.e.
CookieManager	getCookieManager() Get the CookieManager.
boolean	isDisabled() Checks whether auto-login is disabled.
boolean	isEnabled() Checks whether auto-login is enabled.
void	setCookieManager(CookieManager manager) Set the CookieManager to use.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

AUTOLOGIN_PARAMETER_NAME

@Nonnull
@NotEmpty
public static final String AUTOLOGIN_PARAMETER_NAME

Name of the SPNEGO auto-login signaling parameter.

See Also:

Constant Field Values

AUTOLOGIN_COOKIE_NAME

@Nonnull
@NotEmpty
public static final String AUTOLOGIN_COOKIE_NAME

Name of the SPNEGO auto-login cookie.

See Also:

Constant Field Values

AUTOLOGIN_COOKIE_VALUE_TRUE

@Nonnull
@NotEmpty
public static final String AUTOLOGIN_COOKIE_VALUE_TRUE

SPNEGO auto-login cookie value representing true.

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

cookieManager

@NonnullAfterInit
private CookieManager cookieManager

Manages creation of cookies.

Constructor Detail

SPNEGOAutoLoginManager

public SPNEGOAutoLoginManager()

Method Detail

setCookieManager

public void setCookieManager(@Nonnull
                    CookieManager manager)

Set the CookieManager to use.

Parameters:

manager - the CookieManager to use.

getCookieManager

@NonnullAfterInit
public CookieManager getCookieManager()

Get the CookieManager.

Returns:

the CookieManager.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

enable

public void enable()

Enable auto-login, i.e. set cookie to 'true'.

disable

public void disable()

Disable auto-login. i.e. unset cookie.

isEnabled

public boolean isEnabled()

Checks whether auto-login is enabled.

Returns:

true if auto-login is enabled.

isDisabled

public boolean isDisabled()

Checks whether auto-login is disabled.

Returns:

true if auto-login is disabled.