com.sitewhere.microservice.api.user.IUserManagement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sitewhere-microservice-api Show documentation
SiteWhere Microservice APIs
There is a newer version: 3.0.13
Show newest version
/*
 * Copyright (c) SiteWhere, LLC. All rights reserved. http://www.sitewhere.com
 *
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package com.sitewhere.microservice.api.user;

import java.util.List;

import com.sitewhere.spi.SiteWhereException;
import com.sitewhere.spi.microservice.lifecycle.ILifecycleComponent;
import com.sitewhere.spi.search.ISearchResults;
import com.sitewhere.spi.user.IGrantedAuthority;
import com.sitewhere.spi.user.IGrantedAuthoritySearchCriteria;
import com.sitewhere.spi.user.IUser;
import com.sitewhere.spi.user.IUserSearchCriteria;
import com.sitewhere.spi.user.request.IGrantedAuthorityCreateRequest;
import com.sitewhere.spi.user.request.IUserCreateRequest;

/**
 * Interface for user management operations.
 */
public interface IUserManagement extends ILifecycleComponent {

    /**
     * Create a new user based on the given input.
     * 
     * @param request
     * @param encodePassword
     * @return
     * @throws SiteWhereException
     */
    IUser createUser(IUserCreateRequest request, Boolean encodePassword) throws SiteWhereException;

    /**
     * Imports a user (including encrypted password) from an external system.
     * 
     * @param user
     * @param overwrite
     * @return
     * @throws SiteWhereException
     */
    IUser importUser(IUser user, boolean overwrite) throws SiteWhereException;

    /**
     * Authenticate the given username and password.
     * 
     * @param username
     * @param password
     * @param updateLastLogin
     * @return
     * @throws SiteWhereException
     */
    IUser authenticate(String username, String password, boolean updateLastLogin) throws SiteWhereException;

    /**
     * Update details for a user.
     * 
     * @param username
     * @param request
     * @param encodePassword
     * @return
     * @throws SiteWhereException
     */
    IUser updateUser(String username, IUserCreateRequest request, boolean encodePassword) throws SiteWhereException;

    /**
     * Get a user given unique username.
     * 
     * @param username
     * @return
     * @throws SiteWhereException
     */
    IUser getUserByUsername(String username) throws SiteWhereException;

    /**
     * Get the granted authorities for a specific user. Does not include any
     * authorities inherited from groups.
     * 
     * @param username
     * @return
     * @throws SiteWhereException
     */
    List getGrantedAuthorities(String username) throws SiteWhereException;

    /**
     * Add user authorities. Duplicates are ignored.
     * 
     * @param username
     * @param authorities
     * @return
     * @throws SiteWhereException
     */
    List addGrantedAuthorities(String username, List authorities) throws SiteWhereException;

    /**
     * Remove user authorities. Ignore if not previously granted.
     * 
     * @param username
     * @param authorities
     * @return
     * @throws SiteWhereException
     */
    List removeGrantedAuthorities(String username, List authorities)
	    throws SiteWhereException;

    /**
     * Find users that match the given search criteria.
     * 
     * @param criteria
     * @return
     * @throws SiteWhereException
     */
    ISearchResults listUsers(IUserSearchCriteria criteria) throws SiteWhereException;

    /**
     * Delete the user with the given username.
     * 
     * @param username
     * @return
     * @throws SiteWhereException
     */
    IUser deleteUser(String username) throws SiteWhereException;

    /**
     * Create a new granted authority.
     * 
     * @param request
     * @throws SiteWhereException
     */
    IGrantedAuthority createGrantedAuthority(IGrantedAuthorityCreateRequest request) throws SiteWhereException;

    /**
     * Get a granted authority by name.
     * 
     * @param name
     * @return
     * @throws SiteWhereException
     */
    IGrantedAuthority getGrantedAuthorityByName(String name) throws SiteWhereException;

    /**
     * Update a granted authority.
     * 
     * @param name
     * @param request
     * @return
     * @throws SiteWhereException
     */
    IGrantedAuthority updateGrantedAuthority(String name, IGrantedAuthorityCreateRequest request)
	    throws SiteWhereException;

    /**
     * List granted authorities that match the given criteria.
     * 
     * @param criteria
     * @return
     * @throws SiteWhereException
     */
    ISearchResults listGrantedAuthorities(IGrantedAuthoritySearchCriteria criteria)
	    throws SiteWhereException;

    /**
     * Delete a granted authority.
     * 
     * @param authority
     * @throws SiteWhereException
     */
    void deleteGrantedAuthority(String authority) throws SiteWhereException;
}