source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.redback.common.ldap.role;
   2 /*
   3  * Licensed to the Apache Software Foundation (ASF) under one
   4  * or more contributor license agreements.  See the NOTICE file
   5  * distributed with this work for additional information
   6  * regarding copyright ownership.  The ASF licenses this file
   7  * to you under the Apache License, Version 2.0 (the
   8  * "License"); you may not use this file except in compliance
   9  * with the License.  You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing,
  14  * software distributed under the License is distributed on an
  15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  16  * KIND, either express or implied.  See the License for the
  17  * specific language governing permissions and limitations
  18  * under the License.
  19  */
  20
  21 import org.apache.archiva.redback.common.ldap.MappingException;
  22
  23 import javax.naming.directory.DirContext;
  24 import java.util.List;
  25 import java.util.Map;
  26
  27 /**
  28  * will map ldap group to redback role
  29  *
  30  * @author Olivier Lamy
  31  * @since 2.1
  32  */
  33 public interface LdapRoleMapper
  34 {
  35     /**
  36      * @param role redback role
  37      * @return corresponding LDAP group
  38      */
  39     String getLdapGroup( String role )
  40         throws MappingException;
  41
  42     // for continuum ?
  43     //String getLdapGroup( String role, String resource );
  44
  45
  46     /**
  47      * read all groups from ldap
  48      *
  49      * @return all LDAP groups
  50      */
  51     List<String> getAllGroups( DirContext context )
  52         throws MappingException;
  53
  54     /**
  55      * read all ldap groups then map to corresponding role (if no mapping found group is ignored)
  56      *
  57      * @return all roles
  58      * @throws Exception
  59      */
  60     List<String> getAllRoles( DirContext context )
  61         throws MappingException;
  62
  63
  64     /**
  65      * @return the base dn which contains all ldap groups
  66      */
  67     String getGroupsDn();
  68
  69     /**
  70      * @return the class used for group usually groupOfUniqueNames
  71      */
  72     String getLdapGroupClass();
  73
  74     /**
  75      * @param group ldap group
  76      * @return uids of group members
  77      * @throws MappingException
  78      */
  79     List<String> getGroupsMember( String group, DirContext context )
  80         throws MappingException;
  81
  82     List<String> getGroups( String username, DirContext context )
  83         throws MappingException;
  84
  85     List<String> getRoles( String username, DirContext context )
  86         throws MappingException;
  87
  88     /**
  89      * add mapping redback role <-> ldap group
  90      *
  91      * @param role      redback role
  92      * @param ldapGroup ldap group
  93      */
  94     void addLdapMapping( String role, String ldapGroup )
  95         throws MappingException;
  96
  97     /**
  98      * remove a mapping
  99      *
 100      * @param role redback role
 101      */
 102     void removeLdapMapping( String role )
 103         throws MappingException;
 104
 105     /**
 106      * @return Map of corresponding LDAP group (key) and Redback role (value)
 107      */
 108     Map<String, String> getLdapGroupMappings()
 109         throws MappingException;
 110
 111     void setLdapGroupMappings( Map<String, String> mappings )
 112         throws MappingException;
 113
 114     /**
 115      * will save a ldap group corresponding to the mapping.
 116      * <b>will do nothing in group already exists.</b>
 117      *
 118      * @param roleName
 119      * @return <code>true</code> if role was added, <code>false</code> if role already exists
 120      * @throws MappingException
 121      */
 122     boolean saveRole( String roleName, DirContext context )
 123         throws MappingException;
 124
 125     /**
 126      * associate role to user in ldap
 127      *
 128      * @param roleName
 129      * @param username
 130      * @return <code>true</code> if role was added to user, <code>false</code> if role already exists for the user
 131      * @throws MappingException
 132      */
 133     boolean saveUserRole( String roleName, String username, DirContext context )
 134         throws MappingException;
 135
 136     boolean removeUserRole( String roleName, String username, DirContext context )
 137         throws MappingException;
 138
 139     void removeAllRoles( DirContext context )
 140         throws MappingException;
 141
 142     void removeRole( String roleName, DirContext context )
 143         throws MappingException;
 144
 145 }