/* 
    P/P   *  Method: net.sourceforge.pebble.security.SecurityRealm__static_init
          */
     1  package net.sourceforge.pebble.security;
     2  
     3  import java.util.Collection;
     4  
     5  /**
     6   * Represents a security realm with some basic operations.
     7   *
     8   * @author    Simon Brown
     9   */
    10  public interface SecurityRealm {
    11  
    12    /**
    13     * Looks up and returns a collection of all users.
    14     *
    15     * @return  a Collection of PebbleUserDetails objects
    16     */
    17    public Collection<PebbleUserDetails> getUsers() throws SecurityRealmException;
    18  
    19    /**
    20     * Looks up and returns user details for the given username.
    21     *
    22     * @param username    the username to find details for
    23     * @return  a PebbleUserDetails instance
    24     */
    25    public PebbleUserDetails getUser(String username) throws SecurityRealmException;
    26  
    27    /**
    28     * Creates a new user.
    29     *
    30     * @param pud   a PebbleUserDetails instance
    31     */
    32    public void createUser(PebbleUserDetails pud) throws SecurityRealmException;
    33  
    34    /**
    35     * Updates user details, except for the password
    36     *
    37     * @param pud   a PebbleUserDetails instance
    38     */
    39    public void updateUser(PebbleUserDetails pud) throws SecurityRealmException;
    40  
    41    /**
    42     * Changes a user's password.
    43     *
    44     * @param username    the username of the user
    45     * @param password    the new password
    46     * @throws SecurityRealmException
    47     */
    48    public void changePassword(String username, String password) throws SecurityRealmException;
    49  
    50    /**
    51     * Removes user details for the given username.
    52     *
    53     * @param username    the username of the user to remove
    54     */
    55    public void removeUser(String username) throws SecurityRealmException;
    56  
    57  }