PasswordService (sigma-component 2.10 API)

java.lang.Object
- com.articulate.sigma.PasswordService

```
public final class PasswordService
extends Object
```
A class that encrypts a string and checks it against another stored encrypted string, in order to validate a user login.

Field Summary

Fields
Modifier and Type Field and Description

protected static String ADMIN_ROLE

protected static String USER_ROLE

Fields
Modifier and Type	Field and Description
`protected static String`	`ADMIN_ROLE`
`protected static String`	`USER_ROLE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addUser(User user)`
`String`	`encrypt(String plaintext)` Encrypts a string with a deterministic algorithm.
`static PasswordService`	`getInstance()`
`User`	`getUser(String username)`
`protected User`	`getUserFromNamePassword64(String namepass64)`
`File`	`getUsersFileDirectory()`
`protected boolean`	`isUserAuthenticated(String usernamePassword64)` Accepts as input a base 64 String consisting of a user name and password.
`static void`	`main(String[] args)`
`void`	`setUsersFileDirectory(File dir)`
`protected ArrayList<String>`	`toNamePasswordPairFrom64(String usernamePassword64)` Accepts as input a base 64 String consisting of a user name and password.
`void`	`updateUser(User user)`
`boolean`	`userExists(String username)`
`protected void`	`writeUserFile()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ADMIN_ROLE
```
protected static final String ADMIN_ROLE
```
    See Also:
    
    Constant Field Values
  - USER_ROLE
```
protected static final String USER_ROLE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - encrypt
```
public String encrypt(String plaintext)
```
    Encrypts a string with a deterministic algorithm.
  - getInstance
```
public static PasswordService getInstance()
```
  - setUsersFileDirectory
```
public void setUsersFileDirectory(File dir)
```
  - getUsersFileDirectory
```
public File getUsersFileDirectory()
```
  - isUserAuthenticated
```
protected boolean isUserAuthenticated(String usernamePassword64)
```
    Accepts as input a base 64 String consisting of a user name and password. Returns true if the user can be authenticated, else returns false.
    
    Parameters:
    
    String - A concatenated user name and password in base 64 representation
    
    Returns:
    
    True if the user can be authenticated, else false
  - toNamePasswordPairFrom64
```
protected ArrayList<String> toNamePasswordPairFrom64(String usernamePassword64)
```
    Accepts as input a base 64 String consisting of a user name and password. Breaks and decodes the input String, if possible, and returns a List containing a user name String and an encrypted password String.
    
    Parameters:
    
    usernamePassword64 - A base 64 encoded String consisting of a user name and an encrypted password
    
    Returns:
    
    A two-element List consisting of a user name and an encrypted password. Both the user name and the encrypted password could be empty Strings if decoding of the input String fails.
  - getUser
```
public User getUser(String username)
```
  - getUserFromNamePassword64
```
protected User getUserFromNamePassword64(String namepass64)
```
  - writeUserFile
```
protected void writeUserFile()
```
  - userExists
```
public boolean userExists(String username)
```
  - updateUser
```
public void updateUser(User user)
```
  - addUser
```
public void addUser(User user)
```
  - main
```
public static void main(String[] args)
```

Class PasswordService

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ADMIN_ROLE

USER_ROLE

Method Detail

encrypt

getInstance

setUsersFileDirectory

getUsersFileDirectory

isUserAuthenticated

toNamePasswordPairFrom64

getUser

getUserFromNamePassword64

writeUserFile

userExists

updateUser

addUser

main