Coverage Report - net.sourceforge.pebble.security.SecurityRealm
 
Classes in this File Line Coverage Branch Coverage Complexity
SecurityRealm
N/A
N/A
1
 
 1  
 /*
 2  
  * Copyright (c) 2003-2011, Simon Brown
 3  
  * All rights reserved.
 4  
  *
 5  
  * Redistribution and use in source and binary forms, with or without
 6  
  * modification, are permitted provided that the following conditions are met:
 7  
  *
 8  
  *   - Redistributions of source code must retain the above copyright
 9  
  *     notice, this list of conditions and the following disclaimer.
 10  
  *
 11  
  *   - Redistributions in binary form must reproduce the above copyright
 12  
  *     notice, this list of conditions and the following disclaimer in
 13  
  *     the documentation and/or other materials provided with the
 14  
  *     distribution.
 15  
  *
 16  
  *   - Neither the name of Pebble nor the names of its contributors may
 17  
  *     be used to endorse or promote products derived from this software
 18  
  *     without specific prior written permission.
 19  
  *
 20  
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 21  
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 22  
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 23  
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 24  
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 25  
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 26  
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 27  
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 28  
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 29  
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 30  
  * POSSIBILITY OF SUCH DAMAGE.
 31  
  */
 32  
 
 33  
 package net.sourceforge.pebble.security;
 34  
 
 35  
 import java.util.Collection;
 36  
 
 37  
 /**
 38  
  * Represents a security realm with some basic operations.
 39  
  *
 40  
  * @author    Simon Brown
 41  
  */
 42  
 public interface SecurityRealm {
 43  
 
 44  
   /**
 45  
    * Looks up and returns a collection of all users.
 46  
    *
 47  
    * @return  a Collection of PebbleUserDetails objects
 48  
    */
 49  
   public Collection<PebbleUserDetails> getUsers() throws SecurityRealmException;
 50  
 
 51  
   /**
 52  
    * Looks up and returns user details for the given username.
 53  
    *
 54  
    * @param username    the username to find details for
 55  
    * @return  a PebbleUserDetails instance
 56  
    */
 57  
   public PebbleUserDetails getUser(String username) throws SecurityRealmException;
 58  
 
 59  
   /**
 60  
    * Looks up and returns user details for the given username.
 61  
    *
 62  
    * @param openId    the openId to find details for
 63  
    * @return  a PebbleUserDetails instance
 64  
    */
 65  
   public PebbleUserDetails getUserForOpenId(String openId) throws SecurityRealmException;
 66  
 
 67  
   /**
 68  
    * Adds an OpenID to a user
 69  
    *
 70  
    * @param pud The user details of the user
 71  
    * @param openId The openId to add to them
 72  
    * @throws SecurityRealmException If an error occurred
 73  
    */
 74  
   public void addOpenIdToUser(PebbleUserDetails pud, String openId) throws SecurityRealmException;
 75  
 
 76  
   /**
 77  
    * Removes an OpenID from a user
 78  
    *
 79  
    * @param pud The user details of the user
 80  
    * @param openId The openId to remove from them
 81  
    * @throws SecurityRealmException If an error occurred
 82  
    */
 83  
   public void removeOpenIdFromUser(PebbleUserDetails pud, String openId) throws SecurityRealmException;
 84  
 
 85  
   /**
 86  
    * Creates a new user.
 87  
    *
 88  
    * @param pud   a PebbleUserDetails instance
 89  
    */
 90  
   public void createUser(PebbleUserDetails pud) throws SecurityRealmException;
 91  
 
 92  
   /**
 93  
    * Updates user details, except for the password
 94  
    *
 95  
    * @param pud   a PebbleUserDetails instance
 96  
    */
 97  
   public void updateUser(PebbleUserDetails pud) throws SecurityRealmException;
 98  
 
 99  
   /**
 100  
    * Changes a user's password.
 101  
    *
 102  
    * @param username    the username of the user
 103  
    * @param password    the new password
 104  
    * @throws SecurityRealmException
 105  
    */
 106  
   public void changePassword(String username, String password) throws SecurityRealmException;
 107  
 
 108  
   /**
 109  
    * Removes user details for the given username.
 110  
    *
 111  
    * @param username    the username of the user to remove
 112  
    */
 113  
   public void removeUser(String username) throws SecurityRealmException;
 114  
 
 115  
 }