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:
6 * http://www.collectionspace.org
7 * http://wiki.collectionspace.org
9 * Copyright 2009 University of California at Berkeley
11 * Licensed under the Educational Community License (ECL), Version 2.0.
12 * You may not use this file except in compliance with this License.
14 * You may obtain a copy of the ECL 2.0 License at
16 * https://source.collectionspace.org/collection-space/LICENSE.txt
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 permissionRoles and
22 * limitations under the License.
24 package org.collectionspace.services.authorization.storage;
26 import java.util.ArrayList;
27 import java.util.List;
29 import org.collectionspace.services.authorization.Permission;
30 import org.collectionspace.services.authorization.PermissionRole;
31 import org.collectionspace.services.authorization.PermissionRoleRel;
32 import org.collectionspace.services.authorization.PermissionValue;
33 import org.collectionspace.services.authorization.PermissionsList;
34 import org.collectionspace.services.authorization.PermissionsRolesList;
35 import org.collectionspace.services.authorization.RoleValue;
36 import org.collectionspace.services.authorization.SubjectType;
38 import org.collectionspace.services.common.document.AbstractDocumentHandlerImpl;
39 import org.collectionspace.services.common.document.DocumentFilter;
40 import org.collectionspace.services.common.document.DocumentWrapper;
41 import org.collectionspace.services.common.storage.jpa.JpaDocumentHandler;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
46 * Document handler for PermissionRole association
49 public class PermissionRoleDocumentHandler
50 extends JpaDocumentHandler<PermissionRole, PermissionsRolesList, List<PermissionRoleRel>, List<PermissionRoleRel>> {
52 private final Logger logger = LoggerFactory.getLogger(PermissionRoleDocumentHandler.class);
53 private PermissionRole permissionRole;
54 private PermissionsRolesList permissionRolesList;
57 public void handleCreate(DocumentWrapper<List<PermissionRoleRel>> wrapDoc) throws Exception {
58 fillCommonPart(getCommonPart(), wrapDoc);
62 public void completeCreate(DocumentWrapper<List<PermissionRoleRel>> wrapDoc) throws Exception {
63 PermissionRole pr = getCommonPart();
64 AuthorizationDelegate.addPermissions(getServiceContext(), pr);
68 public void handleUpdate(DocumentWrapper<List<PermissionRoleRel>> wrapDoc) throws Exception {
69 throw new UnsupportedOperationException("operation not relevant for PermissionRoleDocumentHandler");
73 public void completeUpdate(DocumentWrapper<List<PermissionRoleRel>> wrapDoc) throws Exception {
74 throw new UnsupportedOperationException("operation not relevant for PermissionRoleDocumentHandler");
78 public void handleGet(DocumentWrapper<List<PermissionRoleRel>> wrapDoc) throws Exception {
79 setCommonPart(extractCommonPart(wrapDoc));
80 getServiceContext().setOutput(permissionRole);
84 public void handleGetAll(DocumentWrapper<List<PermissionRoleRel>> wrapDoc) throws Exception {
85 throw new UnsupportedOperationException("operation not relevant for PermissionRoleDocumentHandler");
89 public void handleDelete(DocumentWrapper<List<PermissionRoleRel>> wrapDoc) throws Exception {
90 fillCommonPart(getCommonPart(), wrapDoc);
94 public void completeDelete(DocumentWrapper<List<PermissionRoleRel>> wrapDoc) throws Exception {
95 PermissionRole pr = getCommonPart();
96 AuthorizationDelegate.deletePermissions(getServiceContext(), pr);
100 public PermissionRole extractCommonPart(
101 DocumentWrapper<List<PermissionRoleRel>> wrapDoc)
103 List<PermissionRoleRel> prrl = wrapDoc.getWrappedObject();
104 PermissionRole pr = new PermissionRole();
105 SubjectType subject = PermissionRoleUtil.getRelationSubject(getServiceContext());
106 if (prrl.size() == 0) {
109 PermissionRoleRel prr0 = prrl.get(0);
110 if (SubjectType.ROLE.equals(subject)) {
112 List<PermissionValue> pvs = new ArrayList<PermissionValue>();
113 pr.setPermissions(pvs);
114 PermissionValue pv = buildPermissionValue(prr0);
118 List<RoleValue> rvs = new ArrayList<RoleValue>();
120 for (PermissionRoleRel prr : prrl) {
121 RoleValue rv = buildRoleValue(prr);
124 } else if (SubjectType.PERMISSION.equals(subject)) {
126 List<RoleValue> rvs = new ArrayList<RoleValue>();
128 RoleValue rv = buildRoleValue(prr0);
132 List<PermissionValue> pvs = new ArrayList<PermissionValue>();
133 pr.setPermissions(pvs);
134 for (PermissionRoleRel prr : prrl) {
135 PermissionValue pv = buildPermissionValue(prr);
143 public void fillCommonPart(PermissionRole pr, DocumentWrapper<List<PermissionRoleRel>> wrapDoc)
145 List<PermissionRoleRel> prrl = wrapDoc.getWrappedObject();
146 SubjectType subject = pr.getSubject();
147 if (subject == null) {
148 //it is not required to give subject as URI determines the subject
149 subject = PermissionRoleUtil.getRelationSubject(getServiceContext());
151 //subject mismatch should have been checked during validation
153 PermissionRoleUtil.buildPermissionRoleRel(pr, subject, prrl);
157 public PermissionsRolesList extractCommonPartList(
158 DocumentWrapper<List<PermissionRoleRel>> wrapDoc)
161 throw new UnsupportedOperationException("operation not relevant for PermissionRoleDocumentHandler");
165 public PermissionRole getCommonPart() {
166 return permissionRole;
170 public void setCommonPart(PermissionRole permissionRole) {
171 this.permissionRole = permissionRole;
175 public PermissionsRolesList getCommonPartList() {
176 return permissionRolesList;
180 public void setCommonPartList(PermissionsRolesList permissionRolesList) {
181 this.permissionRolesList = permissionRolesList;
185 public String getQProperty(
191 public DocumentFilter createDocumentFilter() {
192 return new DocumentFilter(this.getServiceContext());
195 private PermissionValue buildPermissionValue(PermissionRoleRel prr) {
196 PermissionValue pv = new PermissionValue();
197 pv.setPermissionId(prr.getPermissionId());
198 pv.setResourceName(prr.getPermissionResource());
199 pv.setActionGroup(prr.getActionGroup());
203 private RoleValue buildRoleValue(PermissionRoleRel prr) {
204 RoleValue rv = new RoleValue();
205 rv.setRoleId(prr.getRoleId());
206 rv.setRoleName(prr.getRoleName());