edu.internet2.middleware.shibboleth.idp.authn.provider

Class AbstractLoginHandler

java.lang.Object

edu.internet2.middleware.shibboleth.idp.authn.provider.AbstractLoginHandler

All Implemented Interfaces:

LoginHandler

Direct Known Subclasses:

ExternalAuthnSystemLoginHandler, IPAddressLoginHandler, PreviousSessionLoginHandler, RemoteUserLoginHandler, UsernamePasswordLoginHandler

public abstract class AbstractLoginHandler
extends Object
implements LoginHandler

Base class for authentication handlers.

Field Summary

Fields

Modifier and Type	Field and Description
private long	authenticationDuration Length of time, in milliseconds, after which a user should be re-authenticated.
private List<String>	supportedAuthenticationMethods Authentication methods this handler supports.
private boolean	supportsForceAuthentication Whether this handler supports forced re-authentication.
private boolean	supportsPassive Whether this handler supports passive authentication.

Fields inherited from interface edu.internet2.middleware.shibboleth.idp.authn.LoginHandler

AUTHENTICATION_ERROR_KEY, AUTHENTICATION_EXCEPTION_KEY, AUTHENTICATION_INSTANT_KEY, AUTHENTICATION_METHOD_KEY, PRINCIPAL_KEY, PRINCIPAL_NAME_KEY, SUBJECT_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLoginHandler() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
long	getAuthenticationDuration() Gets the length of time, in milliseconds, after which a user authenticated by this handler should be re-authenticated.
List<String>	getSupportedAuthenticationMethods() Gets the list of authentication methods this handler supports.
void	setAuthenticationDuration(long duration) Sets the length of time, in milliseconds, after which a user should be re-authenticated.
void	setAuthenticationDurection(long duration) Deprecated. use setAuthenticationDuration(long)
void	setSupportsForceAuthentication(boolean supported) Sets whether this handler supports forced re-authentication.
void	setSupportsPassive(boolean supported) Sets whether this handler supports passive authentication.
boolean	supportsForceAuthentication() Returns if this handler supports the ability to force a user to (re-)authenticate.
boolean	supportsPassive() Gets whether this handler supports passive authentication.

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.internet2.middleware.shibboleth.idp.authn.LoginHandler

login

Field Detail

supportedAuthenticationMethods

private List<String> supportedAuthenticationMethods

Authentication methods this handler supports.

authenticationDuration

private long authenticationDuration

Length of time, in milliseconds, after which a user should be re-authenticated.

supportsForceAuthentication

private boolean supportsForceAuthentication

Whether this handler supports forced re-authentication.

supportsPassive

private boolean supportsPassive

Whether this handler supports passive authentication.

Constructor Detail

AbstractLoginHandler

protected AbstractLoginHandler()

Constructor.

Method Detail

getSupportedAuthenticationMethods

public List<String> getSupportedAuthenticationMethods()

Gets the list of authentication methods this handler supports.

Specified by:

getSupportedAuthenticationMethods in interface LoginHandler

Returns:

authentication methods this handler supports

getAuthenticationDuration

public long getAuthenticationDuration()

Gets the length of time, in milliseconds, after which a user authenticated by this handler should be re-authenticated.

Specified by:

getAuthenticationDuration in interface LoginHandler

Returns:

length of time, in milliseconds, after which a user should be re-authenticated

setAuthenticationDuration

public void setAuthenticationDuration(long duration)

Sets the length of time, in milliseconds, after which a user should be re-authenticated.

Parameters:

duration - length of time, in milliseconds, after which a user should be re-authenticated

setAuthenticationDurection

public void setAuthenticationDurection(long duration)

Deprecated. use setAuthenticationDuration(long)

Sets the length of time, in milliseconds, after which a user should be re-authenticated.

Parameters:

duration - length of time, in milliseconds, after which a user should be re-authenticated

supportsForceAuthentication

public boolean supportsForceAuthentication()

Returns if this handler supports the ability to force a user to (re-)authenticate.

Specified by:

supportsForceAuthentication in interface LoginHandler

Returns:

if this handler can force a user to (re-)authenticate.

setSupportsForceAuthentication

public void setSupportsForceAuthentication(boolean supported)

Sets whether this handler supports forced re-authentication.

Parameters:

supported - whether this handler supports forced re-authentication

supportsPassive

public boolean supportsPassive()

Gets whether this handler supports passive authentication.

Specified by:

supportsPassive in interface LoginHandler

Returns:

whether this handler supports passive authentication

setSupportsPassive

public void setSupportsPassive(boolean supported)

Sets whether this handler supports passive authentication.

Parameters:

supported - whether this handler supports passive authentication.