001/*
002 * (C) Copyright 2016 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 *     Frederic Vadon
018 *     Ricardo Dias
019 */
020package org.nuxeo.ecm.automation.core.operations.document;
021
022import org.nuxeo.ecm.automation.core.Constants;
023import org.nuxeo.ecm.automation.core.annotations.Context;
024import org.nuxeo.ecm.automation.core.annotations.Operation;
025import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
026import org.nuxeo.ecm.automation.core.annotations.Param;
027import org.nuxeo.ecm.automation.core.collectors.DocumentModelCollector;
028import org.nuxeo.ecm.core.api.CoreSession;
029import org.nuxeo.ecm.core.api.DocumentModel;
030import org.nuxeo.ecm.core.api.DocumentModelList;
031
032/**
033 * @since 8.3
034 */
035@Operation(id = RemoveProxies.ID, category = Constants.CAT_DOCUMENT, label = "Remove Document Proxies", description = "Will remove all proxies pointing on the input document. Useful for instance to unpublish a document. Notice: this operation will remove all proxies, including the ones pointing to the current document version (live proxies). Activating the save parameter forces the changes to be written in database immediately (at the cost of performance loss).", aliases = {"Document.RemoveProxies"})
036public class RemoveProxies {
037
038    public static final String ID = "Document.RemoveProxies";
039
040    @Context
041    protected CoreSession session;
042
043    @Param(name = "save", required = false, values = { "true" })
044    protected boolean save = true;
045
046    @OperationMethod(collector = DocumentModelCollector.class)
047    public DocumentModel run(DocumentModel input) {
048        DocumentModelList proxies = session.getProxies(input.getRef(), null);
049        for (DocumentModel proxy : proxies) {
050            session.removeDocument(proxy.getRef());
051        }
052
053        if (save) {
054            session.save();
055        }
056        return input;
057    }
058
059}