org.craftercms.profile.api.services.AuthenticationService Maven / Gradle / Ivy
package org.craftercms.profile.api.services;
import org.craftercms.profile.api.PersistentLogin;
import org.craftercms.profile.api.Ticket;
import org.craftercms.profile.api.exceptions.ProfileException;
/**
* Service for handling authentication for users.
*
* @author avasquez
*/
public interface AuthenticationService {
/**
* Authenticates the user, and returns a ticket identifying the authentication.
*
* @param tenantName the tenant's name
* @param username the username
* @param password the password
*
* @return the ticket
*/
Ticket authenticate(String tenantName, String username, String password) throws ProfileException;
/**
* 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
*
* @param profileId the ID of the profile
*
* @return the ticket
*/
Ticket createTicket(String profileId) throws ProfileException;
/**
* Returns the ticket object for the given ticket ID.
*
* @param ticketId the ID of the ticket
*
* @return the ticket object, or null if no ticket found or ticket has expired
*/
Ticket getTicket(String ticketId) throws ProfileException;
/**
* Invalidates the ticket.
*
* @param ticketId the ID of the ticket to invalidate
*/
void invalidateTicket(String ticketId) throws ProfileException;
/**
* Creates a persistent login, use for remember me functionality.
*
* @param profileId the ID of the profile
*
* @return the persistent login
*/
PersistentLogin createPersistentLogin(String profileId) throws ProfileException;
/**
* Returns the persistent login object for the given ID.
*
* @param loginId the ID of the login
*
* @return the persistent login, or null if not found
*/
PersistentLogin getPersistentLogin(String loginId) throws ProfileException;
/**
* Refreshes the token of the specified persistent login.
*
* @param loginId the ID of the persistent login
*
* @return the persistent login with the refreshed token
*/
PersistentLogin refreshPersistentLoginToken(String loginId) throws ProfileException;
/**
* Deletes the persistent login.
*
* @param loginId the ID of the login to invalidate
*/
void deletePersistentLogin(String loginId) throws ProfileException;
}