com.capitalone.dashboard.service.AuthenticationService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

Hygieia Rest API Layer

There is a newer version: 3.4.53

package com.capitalone.dashboard.service;

import org.bson.types.ObjectId;

import com.capitalone.dashboard.model.Authentication;

public interface AuthenticationService {
	
	  /**
     * Fetches all registered users, sorted.
     *
     * @return all users
     */
    Iterable all();


    /**
     * Fetches an AuthenticationObject.
     *
     * @param id authentication unique identifier
     * @return Authentication instance
     */
    Authentication get(ObjectId id);

    /**
     * Creates a new Users and saves it to the store.
     *
     * @param username new Authentication to createCollectorItem
     * @return newly created Authentication object
     */
    String create(String username, String password);

    /**
     * Updates an existing quthentication instance.
     *
     * @param username Authentication to update
     * @return updated Authentication instance
     */
    String update(String username, String password);

    /**
     * Deletes an existing Authentication instance.
     *
     * @param id unique identifier of authentication to delete
     */
    void delete(ObjectId id);
    
    /**
     * Deletes an existing authentication instance
     */
	void delete(String username);
	
	/**
	 * 
	 * @param username
     * @param password
	 * @return
	 */
	boolean authenticate(String username, String password);
}