security/runtime/org.argeo.security.core/src/main/java/org/argeo/security/ArgeoSecurityDao.java

   1 /*
   2  * Copyright (C) 2010 Mathieu Baudier <mbaudier@argeo.org>
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *         http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.argeo.security;
  18
  19 import java.util.Set;
  20
  21 /**
  22  * Access to the users and roles referential (dependent from the underlying
  23  * storage, e.g. LDAP).
  24  */
  25 public interface ArgeoSecurityDao {
  26         // public ArgeoUser getCurrentUser();
  27
  28         /** List all users */
  29         public Set<ArgeoUser> listUsers();
  30
  31         /** List roles that can be modified */
  32         public Set<String> listEditableRoles();
  33
  34         /**
  35          * Creates a new user in the underlying storage. <b>DO NOT CALL DIRECTLY</b>
  36          * use {@link ArgeoSecurityService#newUser(ArgeoUser)} instead.
  37          */
  38         public void createUser(ArgeoUser user);
  39
  40         public void updateUser(ArgeoUser user);
  41
  42         public void deleteUser(String username);
  43
  44         /**
  45          * Creates a new role in the underlying storage. <b>DO NOT CALL DIRECTLY</b>
  46          * use {@link ArgeoSecurityService#newRole(String)} instead.
  47          */
  48         public void createRole(String role, String superuserName);
  49
  50         public void deleteRole(String role);
  51
  52         /** List all users having this role. */
  53         public Set<ArgeoUser> listUsersInRole(String role);
  54
  55         public Boolean userExists(String username);
  56
  57         public ArgeoUser getUser(String username);
  58
  59         public ArgeoUser getUserWithPassword(String username);
  60
  61         public String getDefaultRole();
  62
  63         /** Validates a raw password against an encoded one. */
  64         public Boolean isPasswordValid(String encoded, String raw);
  65
  66         /** Encodes a raw password. */
  67         public String encodePassword(String raw);
  68 }