com.sitewhere.spi.user

Interface IUserManagement

All Superinterfaces:

ILifecycleComponent

public interface IUserManagement
extends ILifecycleComponent

Interface for user management operations.

Method Summary

Modifier and Type	Method and Description
java.util.List<IGrantedAuthority>	addGrantedAuthorities(java.lang.String username, java.util.List<java.lang.String> authorities) Add user authorities.
IUser	authenticate(java.lang.String username, java.lang.String password) Authenticate the given username and password.
IGrantedAuthority	createGrantedAuthority(IGrantedAuthorityCreateRequest request) Create a new granted authority.
IUser	createUser(IUserCreateRequest request, boolean encodePassword) Create a new user based on the given input.
void	deleteGrantedAuthority(java.lang.String authority) Delete a granted authority.
IUser	deleteUser(java.lang.String username, boolean force) Delete the user with the given username.
java.util.List<IGrantedAuthority>	getGrantedAuthorities(java.lang.String username) Get the granted authorities for a specific user.
IGrantedAuthority	getGrantedAuthorityByName(java.lang.String name) Get a granted authority by name.
IUser	getUserByUsername(java.lang.String username) Get a user given unique username.
IUser	importUser(IUser user, boolean overwrite) Imports a user (including encrypted password) from an external system.
java.util.List<IGrantedAuthority>	listGrantedAuthorities(IGrantedAuthoritySearchCriteria criteria) List granted authorities that match the given criteria.
java.util.List<IUser>	listUsers(IUserSearchCriteria criteria) Get the list of all users that meet the given criteria.
java.util.List<IGrantedAuthority>	removeGrantedAuthorities(java.lang.String username, java.util.List<java.lang.String> authorities) Remove user authorities.
IGrantedAuthority	updateGrantedAuthority(java.lang.String name, IGrantedAuthorityCreateRequest request) Update a granted authority.
IUser	updateUser(java.lang.String username, IUserCreateRequest request, boolean encodePassword) Update details for a user.

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent

canPause, findComponentsOfType, getComponentId, getComponentName, getComponentType, getCreatedDate, getLifecycleComponents, getLifecycleError, getLifecycleStatus, getLogger, initialize, initializeNestedComponent, lifecycleInitialize, lifecyclePause, lifecycleStart, lifecycleStop, lifecycleStop, logState, pause, start, startNestedComponent, stop, stop

Method Detail

createUser

IUser createUser(IUserCreateRequest request,
                 boolean encodePassword)
          throws SiteWhereException

Create a new user based on the given input.

Parameters:

request -

encodePassword -

Returns:

Throws:

SiteWhereException

importUser

IUser importUser(IUser user,
                 boolean overwrite)
          throws SiteWhereException

Imports a user (including encrypted password) from an external system.

Parameters:

user -

overwrite -

Returns:

Throws:

SiteWhereException

authenticate

IUser authenticate(java.lang.String username,
                   java.lang.String password)
            throws SiteWhereException

Authenticate the given username and password.

Parameters:

username -

password -

Returns:

Throws:

SiteWhereException

updateUser

IUser updateUser(java.lang.String username,
                 IUserCreateRequest request,
                 boolean encodePassword)
          throws SiteWhereException

Update details for a user.

Parameters:

username -

request -

encodePassword -

Returns:

Throws:

SiteWhereException

getUserByUsername

IUser getUserByUsername(java.lang.String username)
                 throws SiteWhereException

Get a user given unique username.

Parameters:

username -

Returns:

Throws:

SiteWhereException

getGrantedAuthorities

java.util.List<IGrantedAuthority> getGrantedAuthorities(java.lang.String username)
                                                 throws SiteWhereException

Get the granted authorities for a specific user. Does not include any authorities inherited from groups.

Parameters:

username -

Returns:

Throws:

SiteWhereException

addGrantedAuthorities

java.util.List<IGrantedAuthority> addGrantedAuthorities(java.lang.String username,
                                                        java.util.List<java.lang.String> authorities)
                                                 throws SiteWhereException

Add user authorities. Duplicates are ignored.

Parameters:

username -

authorities -

Returns:

Throws:

SiteWhereException

removeGrantedAuthorities

java.util.List<IGrantedAuthority> removeGrantedAuthorities(java.lang.String username,
                                                           java.util.List<java.lang.String> authorities)
                                                    throws SiteWhereException

Remove user authorities. Ignore if not previously granted.

Parameters:

username -

authorities -

Returns:

Throws:

SiteWhereException

listUsers

java.util.List<IUser> listUsers(IUserSearchCriteria criteria)
                         throws SiteWhereException

Get the list of all users that meet the given criteria.

Parameters:

criteria -

Returns:

Throws:

SiteWhereException

deleteUser

IUser deleteUser(java.lang.String username,
                 boolean force)
          throws SiteWhereException

Delete the user with the given username.

Parameters:

username -

force -

Returns:

Throws:

SiteWhereException

createGrantedAuthority

IGrantedAuthority createGrantedAuthority(IGrantedAuthorityCreateRequest request)
                                  throws SiteWhereException

Create a new granted authority.

Parameters:

request -

Throws:

SiteWhereException

getGrantedAuthorityByName

IGrantedAuthority getGrantedAuthorityByName(java.lang.String name)
                                     throws SiteWhereException

Get a granted authority by name.

Parameters:

name -

Returns:

Throws:

SiteWhereException

updateGrantedAuthority

IGrantedAuthority updateGrantedAuthority(java.lang.String name,
                                         IGrantedAuthorityCreateRequest request)
                                  throws SiteWhereException

Update a granted authority.

Parameters:

name -

request -

Returns:

Throws:

SiteWhereException

listGrantedAuthorities

java.util.List<IGrantedAuthority> listGrantedAuthorities(IGrantedAuthoritySearchCriteria criteria)
                                                  throws SiteWhereException

List granted authorities that match the given criteria.

Parameters:

criteria -

Returns:

Throws:

SiteWhereException

deleteGrantedAuthority

void deleteGrantedAuthority(java.lang.String authority)
                     throws SiteWhereException

Delete a granted authority.

Parameters:

authority -

Throws:

SiteWhereException