Package org.craftercms.profile.services.impl

Class AuthenticationServiceRestClient

java.lang.Object

org.craftercms.commons.rest.AbstractRestClientBase

org.craftercms.profile.services.impl.AbstractProfileRestClientBase

org.craftercms.profile.services.impl.AuthenticationServiceRestClient

All Implemented Interfaces:

AuthenticationService

public class AuthenticationServiceRestClient
extends AbstractProfileRestClientBase
implements AuthenticationService

REST client implementation of AuthenticationService.

Author:

avasquez

Field Summary

Fields inherited from class org.craftercms.profile.services.impl.AbstractProfileRestClientBase

accessTokenIdResolver

Fields inherited from class org.craftercms.commons.rest.AbstractRestClientBase

baseUrl, extension, restTemplate

Constructor Summary

Constructors

Constructor	Description
AuthenticationServiceRestClient()

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.
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.
PersistentLogin	refreshPersistentLoginToken(String loginId)	Refreshes the token of the specified persistent login.

Methods inherited from class org.craftercms.profile.services.impl.AbstractProfileRestClientBase

createBaseParams, doGetForObject, doGetForObject, doGetForObject, doGetForObject, doPostForLocation, doPostForObject, doPostForUpload, getAbsoluteUrlWithAccessTokenIdParam, handleException, handleRestServiceException, setAccessTokenIdResolver

Methods inherited from class org.craftercms.commons.rest.AbstractRestClientBase

getAbsoluteUrl, setBaseUrl, setExtension, setRestTemplate

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationServiceRestClient

public AuthenticationServiceRestClient()

Method Details

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

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