Package org.yamcs.security

Class Directory

java.lang.Object

org.yamcs.security.Directory

public class Directory
extends Object

Stores user, group and application information in the Yamcs database.

Constructor Summary

Constructors

Constructor	Description
Directory()

Method Summary

Modifier and Type	Method	Description
void	addGroup(Group group)
ApplicationCredentials	addServiceAccount(ServiceAccount service)	Creates a new service account.
void	addUser(User user)
void	changePassword(User user, char[] password)
void	deleteGroup(Group group)
void	deleteServiceAccount(String name)
Account	getAccount(String name)
Account	getAccountForApplication(String applicationId)
Group	getGroup(String name)
List<Group>	getGroups()
List<Group>	getGroups(User user)
Role	getRole(String name)
List<Role>	getRoles()
ServiceAccount	getServiceAccount(String name)
List<ServiceAccount>	getServiceAccounts()
User	getUser(int id)
User	getUser(String username)
List<User>	getUsers()
void	renameGroup(String from, String to)
void	updateApplicationProperties(ServiceAccount service)
void	updateGroupProperties(Group group)
void	updateUserProperties(User user)
boolean	validateApplicationPassword(String applicationId, char[] password)	Validates the provided password against the stored password hash of an application.
boolean	validateUserPassword(String username, char[] password)	Validates the provided password against the stored password hash of a user.

Methods inherited from class java.lang.Object

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

Constructor Detail

Directory

public Directory()
          throws InitException

Throws:

InitException

Method Detail

addUser

public void addUser(User user)
             throws IOException

Throws:

IOException

updateUserProperties

public void updateUserProperties(User user)
                          throws IOException

Throws:

IOException

addGroup

public void addGroup(Group group)
              throws IOException

Throws:

IOException

renameGroup

public void renameGroup(String from,
                        String to)
                 throws IOException

Throws:

IOException

updateGroupProperties

public void updateGroupProperties(Group group)
                           throws IOException

Throws:

IOException

deleteGroup

public void deleteGroup(Group group)
                 throws IOException

Throws:

IOException

addServiceAccount

public ApplicationCredentials addServiceAccount(ServiceAccount service)
                                         throws IOException

Creates a new service account. The service account is assumed to represent one application only, for which automatically generated credentials are returned. These may be used to identify as that application, for example to generate access tokens.

Throws:

IOException

deleteServiceAccount

public void deleteServiceAccount(String name)

updateApplicationProperties

public void updateApplicationProperties(ServiceAccount service)
                                 throws IOException

Throws:

IOException

validateUserPassword

public boolean validateUserPassword(String username,
                                    char[] password)

Validates the provided password against the stored password hash of a user.

validateApplicationPassword

public boolean validateApplicationPassword(String applicationId,
                                           char[] password)

Validates the provided password against the stored password hash of an application.

Currently this is only functional for service accounts (which map to one and only one application), but some day we may also want to support user applications.

changePassword

public void changePassword(User user,
                           char[] password)
                    throws IOException

Throws:

IOException

getAccount

public Account getAccount(String name)

getUser

public User getUser(int id)

getUser

public User getUser(String username)

getUsers

public List<User> getUsers()

getAccountForApplication

public Account getAccountForApplication(String applicationId)

getGroup

public Group getGroup(String name)

getGroups

public List<Group> getGroups()

getGroups

public List<Group> getGroups(User user)

getServiceAccount

public ServiceAccount getServiceAccount(String name)

getServiceAccounts

public List<ServiceAccount> getServiceAccounts()

getRoles

public List<Role> getRoles()

getRole

public Role getRole(String name)