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.automation.core.util.DocumentHelper; 028import org.nuxeo.ecm.core.api.CoreSession; 029import org.nuxeo.ecm.core.api.DocumentModel; 030 031/** 032 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a> 033 */ 034@Operation(id = RemoveDocumentBlob.ID, category = Constants.CAT_BLOB, label = "Remove File", description = "Remove the file attached to the input document as specified by the 'xpath' parameter. If the 'xpath' point to a blob list then the list will be cleared. If the file to remove is part of a list it will be removed from the list otherwise the 'xpath' should point to a blob property that will be removed. If the save parameter is set the document modification will be automatically saved. Return the document.", aliases = { "Blob.Remove" }) 035public class RemoveDocumentBlob { 036 037 public static final String ID = "Blob.RemoveFromDocument"; 038 039 @Context 040 protected CoreSession session; 041 042 @Param(name = "xpath", required = false, values = "file:content") 043 protected String xpath = "file:content"; 044 045 @Param(name = "save", required = false, values = "true") 046 protected boolean save = true; 047 048 @OperationMethod(collector = DocumentModelCollector.class) 049 public DocumentModel run(DocumentModel doc) { 050 DocumentHelper.removeProperty(doc, xpath); 051 if (save) { 052 doc = session.saveDocument(doc); 053 } 054 return doc; 055 } 056 057}