com.axelor.auth

Class AuthService

java.lang.Object

com.axelor.auth.AuthService

@Singleton
public class AuthService
extends Object

The AuthService class provides various utility services including password encryption, password match and saving user password in encrypted form.

The AuthService should not be manually instantiated but either injected or user getInstance() method to get the instance of the service.

Field Summary

Fields

Modifier and Type	Field and Description
static AuthService	instance

Constructor Summary

Constructors

Constructor and Description
AuthService(String hashAlgorihm, int hashIterations)

Method Summary

Modifier and Type	Method and Description
Object	encrypt(Object user, Map context) This is an adapter method to be used with data import.
String	encrypt(String password) Encrypt the given password text if it's not encrypted yet.
User	encrypt(User user) Encrypt the password of the given user.
static AuthService	getInstance() Get the instance of the AuthService.
boolean	match(String plain, String saved) Match the given plain and saved passwords.
void	validate(ActionRequest request, ActionResponse response) A helper method used to encrypt user password when the user record is saved with user interface.

Methods inherited from class java.lang.Object

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

Field Detail

instance

public static AuthService instance

Constructor Detail

AuthService

@Inject
public AuthService(@Named(value="auth.hash.algorithm")
                           String hashAlgorihm,
                           @Named(value="auth.hash.iterations")
                           int hashIterations)

Method Detail

getInstance

public static AuthService getInstance()

Get the instance of the AuthService.

Returns:

the AuthService instance

Throws:

IllegalStateException - if AuthService is not initialized

encrypt

public String encrypt(String password)

Encrypt the given password text if it's not encrypted yet.

The method tests the password for a special format to check if it is already encrypted, and In that case the password is returned as it is to avoid multiple encryption.

Parameters:

password - the password to encrypt

Returns:

encrypted password

encrypt

public User encrypt(User user)

Encrypt the password of the given user.

Parameters:

user - the user whose password needs to be encrypted

Returns:

the same user instance

encrypt

public Object encrypt(Object user,
                      Map context)

This is an adapter method to be used with data import.

This method can be used as call="com.axelor.auth.AuthService:encrypt" while importing user data to ensure user passwords are encrypted.

Parameters:

user - the object instance passed by data import engine

context - the data import context

Returns:

the same instance passed

match

public boolean match(String plain,
                     String saved)

Match the given plain and saved passwords.

Parameters:

plain - the plain password text

saved - the saved password text (hashed)

Returns:

true if they match

validate

public void validate(ActionRequest request,
                     ActionResponse response)

A helper method used to encrypt user password when the user record is saved with user interface.

Parameters:

request - the request with user object as context

response - the response, which is updated according to the validation