Package org.craftercms.profile.services.impl

Class AuthenticationServiceImpl

java.lang.Object

org.craftercms.profile.services.impl.AuthenticationServiceImpl

All Implemented Interfaces:

AuthenticationService

public class AuthenticationServiceImpl
extends Object
implements AuthenticationService

Default implementation of AuthenticationService.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_KEY_CREATE_PERSISTENT_LOGIN_ERROR
static final String	ERROR_KEY_CREATE_TICKET_ERROR
static final String	ERROR_KEY_DELETE_PERSISTENT_LOGIN_ERROR
static final String	ERROR_KEY_DELETE_TICKET_ERROR
static final String	ERROR_KEY_GET_PERSISTENT_LOGIN_ERROR
static final String	ERROR_KEY_GET_TICKET_ERROR
static final String	ERROR_KEY_UPDATE_PERSISTENT_LOGIN_ERROR
static final String	ERROR_KEY_UPDATE_TICKET_ERROR
static final String	ERROR_KEY_WAIT_IS_ABORTED
protected int	failedLoginAttemptsBeforeDelay
protected int	failedLoginAttemptsBeforeLock
protected int	lockTime
static final String	LOG_KEY_AUTHENTICATION_SUCCESSFUL
static final String	LOG_KEY_PERSISTENT_LOGIN_CREATED
static final String	LOG_KEY_PERSISTENT_LOGIN_DELETED
static final String	LOG_KEY_PERSISTENT_LOGIN_TOKEN_REFRESHED
static final String	LOG_KEY_TICKET_CREATED
static final String	LOG_KEY_TICKET_INVALIDATED
static final String	LOG_KEY_TICKET_REQUESTED
protected org.craftercms.commons.security.permissions.PermissionEvaluator<AccessToken,String>	permissionEvaluator
protected PersistentLoginRepository	persistentLoginRepository
protected ProfileService	profileService
protected TicketRepository	ticketRepository

Constructor Summary

Constructors

Constructor	Description
AuthenticationServiceImpl(org.craftercms.commons.security.permissions.PermissionEvaluator<AccessToken,String> permissionEvaluator, TicketRepository ticketRepository, PersistentLoginRepository persistentLoginRepository)

Method Summary

Modifier and Type	Method	Description
Ticket	authenticate(String tenantName, String username, String password)	Authenticates the user, and returns a ticket identifying the authentication.
protected void	checkIfManageTicketsIsAllowed(String tenantName)
protected void	countAsFail(Profile profile)
PersistentLogin	createPersistentLogin(String profileId)	Creates a persistent login, use for remember me functionality.
Ticket	createTicket(String profileId)	Create a new ticket for the specified profile.
void	deletePersistentLogin(String loginId)	Deletes the persistent login.
PersistentLogin	getPersistentLogin(String loginId)	Returns the persistent login object for the given ID.
Ticket	getTicket(String ticketId)	Returns the ticket object for the given ticket ID.
void	invalidateTicket(String ticketId)	Invalidates the ticket.
protected boolean	isProfileInTimeOut(Profile profile)
PersistentLogin	refreshPersistentLoginToken(String loginId)	Refreshes the token of the specified persistent login.
void	setFailedLoginAttemptsBeforeDelay(int failedLoginAttemptsBeforeDelay)
void	setFailedLoginAttemptsBeforeLock(int failedLoginAttemptsBeforeLock)
void	setLockTime(int lockTime)
void	setProfileService(ProfileService profileService)

Methods inherited from class java.lang.Object

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

Field Details

LOG_KEY_AUTHENTICATION_SUCCESSFUL

public static final String LOG_KEY_AUTHENTICATION_SUCCESSFUL

See Also:

• Constant Field Values

LOG_KEY_TICKET_CREATED

public static final String LOG_KEY_TICKET_CREATED

See Also:

• Constant Field Values

LOG_KEY_TICKET_REQUESTED

public static final String LOG_KEY_TICKET_REQUESTED

See Also:

• Constant Field Values

LOG_KEY_TICKET_INVALIDATED

public static final String LOG_KEY_TICKET_INVALIDATED

See Also:

• Constant Field Values

LOG_KEY_PERSISTENT_LOGIN_CREATED

public static final String LOG_KEY_PERSISTENT_LOGIN_CREATED

See Also:

• Constant Field Values

LOG_KEY_PERSISTENT_LOGIN_TOKEN_REFRESHED

public static final String LOG_KEY_PERSISTENT_LOGIN_TOKEN_REFRESHED

See Also:

• Constant Field Values

LOG_KEY_PERSISTENT_LOGIN_DELETED

public static final String LOG_KEY_PERSISTENT_LOGIN_DELETED

See Also:

• Constant Field Values

ERROR_KEY_CREATE_TICKET_ERROR

public static final String ERROR_KEY_CREATE_TICKET_ERROR

See Also:

• Constant Field Values

ERROR_KEY_GET_TICKET_ERROR

public static final String ERROR_KEY_GET_TICKET_ERROR

See Also:

• Constant Field Values

ERROR_KEY_UPDATE_TICKET_ERROR

public static final String ERROR_KEY_UPDATE_TICKET_ERROR

See Also:

• Constant Field Values

ERROR_KEY_DELETE_TICKET_ERROR

public static final String ERROR_KEY_DELETE_TICKET_ERROR

See Also:

• Constant Field Values

ERROR_KEY_CREATE_PERSISTENT_LOGIN_ERROR

public static final String ERROR_KEY_CREATE_PERSISTENT_LOGIN_ERROR

See Also:

• Constant Field Values

ERROR_KEY_GET_PERSISTENT_LOGIN_ERROR

public static final String ERROR_KEY_GET_PERSISTENT_LOGIN_ERROR

See Also:

• Constant Field Values

ERROR_KEY_UPDATE_PERSISTENT_LOGIN_ERROR

public static final String ERROR_KEY_UPDATE_PERSISTENT_LOGIN_ERROR

See Also:

• Constant Field Values

ERROR_KEY_DELETE_PERSISTENT_LOGIN_ERROR

public static final String ERROR_KEY_DELETE_PERSISTENT_LOGIN_ERROR

See Also:

• Constant Field Values

ERROR_KEY_WAIT_IS_ABORTED

public static final String ERROR_KEY_WAIT_IS_ABORTED

See Also:

• Constant Field Values

permissionEvaluator

protected org.craftercms.commons.security.permissions.PermissionEvaluator<AccessToken,String> permissionEvaluator

ticketRepository

protected TicketRepository ticketRepository

persistentLoginRepository

protected PersistentLoginRepository persistentLoginRepository

profileService

protected ProfileService profileService

lockTime

protected int lockTime

failedLoginAttemptsBeforeLock

protected int failedLoginAttemptsBeforeLock

failedLoginAttemptsBeforeDelay

protected int failedLoginAttemptsBeforeDelay

Constructor Details

AuthenticationServiceImpl

public AuthenticationServiceImpl(org.craftercms.commons.security.permissions.PermissionEvaluator<AccessToken,String> permissionEvaluator,
 TicketRepository ticketRepository,
 PersistentLoginRepository persistentLoginRepository)

Method Details

setProfileService

@Autowired
public void setProfileService(@Lazy
 ProfileService profileService)

authenticate

public Ticket authenticate(String tenantName,
 String username,
 String password)
                    throws ProfileException

Description copied from interface: AuthenticationService

Authenticates the user, and returns a ticket identifying the authentication.

Specified by:

authenticate in interface AuthenticationService

Parameters:

tenantName - the tenant's name

username - the username

password - the password

Returns:

the ticket

Throws:

ProfileException

countAsFail

protected void countAsFail(Profile profile)
                    throws ProfileException

Throws:

ProfileException

isProfileInTimeOut

protected boolean isProfileInTimeOut(Profile profile)

createTicket

public Ticket createTicket(String profileId)
                    throws ProfileException

Description copied from interface: AuthenticationService

Create a new ticket for the specified profile.

Note: this method should only be used when authentication is done through other means (like when authenticating through Facebook or Twitter) different than profile, or when authenticating through a persistent login

Specified by:

createTicket in interface AuthenticationService

Parameters:

profileId - the ID of the profile

Returns:

the ticket

Throws:

ProfileException

getTicket

public Ticket getTicket(String ticketId)
                 throws ProfileException

Description copied from interface: AuthenticationService

Returns the ticket object for the given ticket ID.

Specified by:

getTicket in interface AuthenticationService

Parameters:

ticketId - the ID of the ticket

Returns:

the ticket object, or null if no ticket found or ticket has expired

Throws:

ProfileException

invalidateTicket

public void invalidateTicket(String ticketId)
                      throws ProfileException

Description copied from interface: AuthenticationService

Invalidates the ticket.

Specified by:

invalidateTicket in interface AuthenticationService

Parameters:

ticketId - the ID of the ticket to invalidate

Throws:

ProfileException

createPersistentLogin

public PersistentLogin createPersistentLogin(String profileId)
                                      throws ProfileException

Description copied from interface: AuthenticationService

Creates a persistent login, use for remember me functionality.

Specified by:

createPersistentLogin in interface AuthenticationService

Parameters:

profileId - the ID of the profile

Returns:

the persistent login

Throws:

ProfileException

getPersistentLogin

public PersistentLogin getPersistentLogin(String loginId)
                                   throws ProfileException

Description copied from interface: AuthenticationService

Returns the persistent login object for the given ID.

Specified by:

getPersistentLogin in interface AuthenticationService

Parameters:

loginId - the ID of the login

Returns:

the persistent login, or null if not found

Throws:

ProfileException

refreshPersistentLoginToken

public PersistentLogin refreshPersistentLoginToken(String loginId)
                                            throws ProfileException

Description copied from interface: AuthenticationService

Refreshes the token of the specified persistent login.

Specified by:

refreshPersistentLoginToken in interface AuthenticationService

Parameters:

loginId - the ID of the persistent login

Returns:

the persistent login with the refreshed token

Throws:

ProfileException

deletePersistentLogin

public void deletePersistentLogin(String loginId)
                           throws ProfileException

Description copied from interface: AuthenticationService

Deletes the persistent login.

Specified by:

deletePersistentLogin in interface AuthenticationService

Parameters:

loginId - the ID of the login to invalidate

Throws:

ProfileException

checkIfManageTicketsIsAllowed

protected void checkIfManageTicketsIsAllowed(String tenantName)

setLockTime

public void setLockTime(int lockTime)

setFailedLoginAttemptsBeforeLock

public void setFailedLoginAttemptsBeforeLock(int failedLoginAttemptsBeforeLock)

setFailedLoginAttemptsBeforeDelay

public void setFailedLoginAttemptsBeforeDelay(int failedLoginAttemptsBeforeDelay)