git.aero2k.de Git - tmp/jakarta-migration.git/blob

   1 /**
   2  *  This document is a part of the source code and related artifacts
   3  *  for CollectionSpace, an open source collections management system
   4  *  for museums and related institutions:
   5
   6  *  http://www.collectionspace.org
   7  *  http://wiki.collectionspace.org
   8
   9  *  Copyright 2009 University of California at Berkeley
  10
  11  *  Licensed under the Educational Community License (ECL), Version 2.0.
  12  *  You may not use this file except in compliance with this License.
  13
  14  *  You may obtain a copy of the ECL 2.0 License at
  15
  16  *  https://source.collectionspace.org/collection-space/LICENSE.txt
  17
  18  *  Unless required by applicable law or agreed to in writing, software
  19  *  distributed under the License is distributed on an "AS IS" BASIS,
  20  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21  *  See the License for the specific language governing permissions and
  22  *  limitations under the License.
  23  */
  24 package org.collectionspace.services.authorization.storage;
  25
  26 import java.util.ArrayList;
  27 import java.util.List;
  28 import java.util.UUID;
  29
  30 import org.collectionspace.services.authorization.Role;
  31 import org.collectionspace.services.authorization.RolesList;
  32
  33 import org.collectionspace.services.client.RoleClient;
  34 import org.collectionspace.services.common.document.BadRequestException;
  35 import org.collectionspace.services.common.document.DocumentFilter;
  36 import org.collectionspace.services.common.document.DocumentWrapper;
  37 import org.collectionspace.services.common.document.JaxbUtils;
  38 import org.collectionspace.services.common.security.SecurityUtils;
  39 import org.collectionspace.services.common.storage.jpa.JpaDocumentHandler;
  40
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 /**
  45  * Document handler for Role
  46  * @author
  47  */
  48 public class RoleDocumentHandler
  49                 extends JpaDocumentHandler<Role, RolesList, Role, List> {
  50     private final Logger logger = LoggerFactory.getLogger(RoleDocumentHandler.class);
  51     private Role role;
  52     private RolesList rolesList;
  53
  54     @Override
  55     public void handleCreate(DocumentWrapper<Role> wrapDoc) throws Exception {
  56         String id = UUID.randomUUID().toString();
  57         Role role = wrapDoc.getWrappedObject();
  58
  59         // Synthesize the display name if it was not passed in.
  60         String displayName = role.getDisplayName();
  61         boolean displayNameEmpty = true;
  62         if (displayName != null) {
  63                 displayNameEmpty = displayName.trim().isEmpty();
  64         }
  65         if (displayNameEmpty == true) {
  66                 role.setDisplayName(role.getRoleName());
  67         }
  68
  69         setTenant(role);
  70         role.setRoleName(fixRoleName(role.getRoleName(),
  71                         role.getTenantId()));
  72         role.setCsid(id);
  73         // We do not allow creation of locked roles through the services.
  74         role.setMetadataProtection(null);
  75         role.setPermsProtection(null);
  76     }
  77
  78     @Override
  79     public void handleUpdate(DocumentWrapper<Role> wrapDoc) throws Exception {
  80         Role roleFound = wrapDoc.getWrappedObject();
  81         Role roleReceived = getCommonPart();
  82         // If marked as metadata immutable, do not do update
  83         if(!RoleClient.IMMUTABLE.equals(roleFound.getMetadataProtection())) {
  84                 roleReceived.setRoleName(fixRoleName(roleReceived.getRoleName(),
  85                                 roleFound.getTenantId()));
  86                 merge(roleReceived, roleFound);
  87         }
  88     }
  89
  90     /**
  91      * merge manually merges the from from to the to role
  92      * -this method is created due to inefficiency of JPA EM merge
  93      * @param from
  94      * @param to
  95      * @return merged role
  96      */
  97     private Role merge(Role from, Role to) throws Exception {
  98         //role name cannot be changed
  99         if (!(from.getRoleName().equalsIgnoreCase(to.getRoleName()))) {
 100             String msg = "Role name cannot be changed " + to.getRoleName();
 101             logger.error(msg);
 102             throw new BadRequestException(msg);
 103         }
 104         if (from.getDisplayName() != null) {
 105                 to.setDisplayName(from.getDisplayName());
 106         }
 107         if (from.getRoleGroup() != null) {
 108             to.setRoleGroup(from.getRoleGroup());
 109         }
 110         if (from.getDescription() != null) {
 111             to.setDescription(from.getDescription());
 112         }
 113         // Note that we do not allow update of locks
 114         if (logger.isDebugEnabled()) {
 115             logger.debug("merged role=" + JaxbUtils.toString(to, Role.class));
 116         }
 117         return to;
 118     }
 119
 120     @Override
 121     public void completeUpdate(DocumentWrapper<Role> wrapDoc) throws Exception {
 122         Role upAcc = wrapDoc.getWrappedObject();
 123         getServiceContext().setOutput(upAcc);
 124         sanitize(upAcc);
 125     }
 126
 127     @Override
 128     public void handleGet(DocumentWrapper<Role> wrapDoc) throws Exception {
 129         setCommonPart(extractCommonPart(wrapDoc));
 130         sanitize(getCommonPart());
 131         getServiceContext().setOutput(role);
 132     }
 133
 134     @Override
 135     public void handleGetAll(DocumentWrapper<List> wrapDoc) throws Exception {
 136         RolesList rolesList = extractCommonPartList(wrapDoc);
 137         setCommonPartList(rolesList);
 138         getServiceContext().setOutput(getCommonPartList());
 139     }
 140
 141     @Override
 142     public Role extractCommonPart(
 143             DocumentWrapper<Role> wrapDoc)
 144             throws Exception {
 145         return wrapDoc.getWrappedObject();
 146     }
 147
 148     @Override
 149     public void fillCommonPart(Role obj, DocumentWrapper<Role> wrapDoc)
 150             throws Exception {
 151         throw new UnsupportedOperationException("operation not relevant for AccountDocumentHandler");
 152     }
 153
 154     @Override
 155     public RolesList extractCommonPartList(
 156             DocumentWrapper<List> wrapDoc)
 157             throws Exception {
 158
 159         RolesList rolesList = new RolesList();
 160         List<Role> list = new ArrayList<Role>();
 161         rolesList.setRoles(list);
 162         for (Object obj : wrapDoc.getWrappedObject()) {
 163             Role role = (Role) obj;
 164             sanitize(role);
 165             list.add(role);
 166         }
 167         return rolesList;
 168     }
 169
 170     @Override
 171     public Role getCommonPart() {
 172         return role;
 173     }
 174
 175     @Override
 176     public void setCommonPart(Role role) {
 177         this.role = role;
 178     }
 179
 180     @Override
 181     public RolesList getCommonPartList() {
 182         return rolesList;
 183     }
 184
 185     @Override
 186     public void setCommonPartList(RolesList rolesList) {
 187         this.rolesList = rolesList;
 188     }
 189
 190     @Override
 191     public String getQProperty(
 192             String prop) {
 193         return null;
 194     }
 195
 196     @Override
 197     public DocumentFilter createDocumentFilter() {
 198         DocumentFilter filter = new RoleJpaFilter(this.getServiceContext());
 199         return filter;
 200     }
 201
 202     /**
 203      * sanitize removes data not needed to be sent to the consumer
 204      * @param roleFound
 205      */
 206     private void sanitize(Role role) {
 207         if (!SecurityUtils.isCSpaceAdmin()) {
 208             role.setTenantId(null);
 209         }
 210     }
 211
 212     private String fixRoleName(String role, String tenantId) {
 213         String roleName = role.toUpperCase();
 214         String rolePrefix = "ROLE_" + tenantId + "_";
 215         if (!roleName.startsWith(rolePrefix)) {
 216             roleName = rolePrefix + roleName;
 217         }
 218         return roleName;
 219     }
 220
 221     private void setTenant(Role role) {
 222         //set tenant only if not available from input
 223         if (role.getTenantId() == null || role.getTenantId().isEmpty()) {
 224             role.setTenantId(getServiceContext().getTenantId());
 225         }
 226     }
 227 }