001/*
002 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the Eclipse Public License v1.0
006 * which accompanies this distribution, and is available at
007 * http://www.eclipse.org/legal/epl-v10.html
008 *
009 * Contributors:
010 *     bstefanescu
011 */
012package org.nuxeo.ecm.automation.core.operations.document;
013
014import org.nuxeo.ecm.automation.core.Constants;
015import org.nuxeo.ecm.automation.core.annotations.Context;
016import org.nuxeo.ecm.automation.core.annotations.Operation;
017import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
018import org.nuxeo.ecm.automation.core.annotations.Param;
019import org.nuxeo.ecm.automation.core.collectors.DocumentModelCollector;
020import org.nuxeo.ecm.core.api.CoreSession;
021import org.nuxeo.ecm.core.api.DocumentModel;
022import org.nuxeo.ecm.core.api.DocumentRef;
023import org.nuxeo.ecm.core.api.security.ACE;
024import org.nuxeo.ecm.core.api.security.ACL;
025import org.nuxeo.ecm.core.api.security.impl.ACLImpl;
026import org.nuxeo.ecm.core.api.security.impl.ACPImpl;
027
028/**
029 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
030 */
031@Operation(id = SetDocumentACE.ID, category = Constants.CAT_DOCUMENT, label = "Set ACL", description = "Set Acces Control Entry on the input document(s). Returns the document(s).", aliases = { "Document.SetACE" })
032public class SetDocumentACE {
033
034    public static final String ID = "Document.AddACE";
035
036    @Context
037    protected CoreSession session;
038
039    @Param(name = "user")
040    protected String user;
041
042    @Param(name = "permission")
043    String permission;
044
045    @Param(name = "acl", required = false, values = ACL.LOCAL_ACL)
046    String aclName = ACL.LOCAL_ACL;
047
048    @Param(name = "grant", required = false, values = "true")
049    boolean grant = true;
050
051    @Param(name = "overwrite", required = false, values = "true")
052    boolean overwrite = true;
053
054    @OperationMethod(collector = DocumentModelCollector.class)
055    public DocumentModel run(DocumentModel doc) {
056        setACE(doc.getRef());
057        return session.getDocument(doc.getRef());
058    }
059
060    @OperationMethod(collector = DocumentModelCollector.class)
061    public DocumentModel run(DocumentRef doc) {
062        setACE(doc);
063        return session.getDocument(doc);
064    }
065
066    protected void setACE(DocumentRef ref) {
067        ACPImpl acp = new ACPImpl();
068        ACLImpl acl = new ACLImpl(aclName);
069        acp.addACL(acl);
070        ACE ace = new ACE(user, permission, grant);
071        acl.add(ace);
072        session.setACP(ref, acp, overwrite);
073    }
074
075}