001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.ecm.automation.core.operations.document;
020
021import org.nuxeo.ecm.automation.core.Constants;
022import org.nuxeo.ecm.automation.core.annotations.Context;
023import org.nuxeo.ecm.automation.core.annotations.Operation;
024import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
025import org.nuxeo.ecm.automation.core.annotations.Param;
026import org.nuxeo.ecm.automation.core.collectors.DocumentModelCollector;
027import org.nuxeo.ecm.core.api.CoreSession;
028import org.nuxeo.ecm.core.api.DocumentModel;
029import org.nuxeo.ecm.core.api.DocumentRef;
030import org.nuxeo.ecm.core.api.security.ACP;
031
032/**
033 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
034 */
035@Operation(id = RemoveDocumentACL.ID, category = Constants.CAT_DOCUMENT, label = "Remove ACL", description = "Remove a named Acces Control List from the input document(s). Returns the document(s).")
036public class RemoveDocumentACL {
037
038    public static final String ID = "Document.RemoveACL";
039
040    @Context
041    protected CoreSession session;
042
043    @Param(name = "acl")
044    protected String aclName;
045
046    @OperationMethod(collector = DocumentModelCollector.class)
047    public DocumentModel run(DocumentModel doc) {
048        deleteACL(doc.getRef());
049        return session.getDocument(doc.getRef());
050    }
051
052    @OperationMethod(collector = DocumentModelCollector.class)
053    public DocumentModel run(DocumentRef doc) {
054        deleteACL(doc);
055        return session.getDocument(doc);
056    }
057
058    protected void deleteACL(DocumentRef ref) {
059        ACP acp = session.getACP(ref);
060        acp.removeACL(aclName);
061        acp.removeACL("inherited"); // make sure to not save the inherited acl
062        // which is dynamically computed
063        session.setACP(ref, acp, true);
064    }
065
066}