001/*
002 * (C) Copyright 2012 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 *     Arnaud Kervern
018 */
019package org.nuxeo.snapshot.operation;
020
021import org.nuxeo.ecm.automation.core.annotations.Operation;
022import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
023import org.nuxeo.ecm.automation.core.annotations.Param;
024import org.nuxeo.ecm.automation.core.collectors.DocumentModelCollector;
025import org.nuxeo.ecm.core.api.DocumentModel;
026import org.nuxeo.ecm.core.api.NuxeoException;
027import org.nuxeo.ecm.core.api.VersioningOption;
028import org.nuxeo.snapshot.Snapshotable;
029
030import static org.nuxeo.ecm.automation.core.Constants.CAT_DOCUMENT;
031import static org.nuxeo.ecm.core.api.VersioningOption.MINOR;
032
033@Operation(id = CreateTreeSnapshot.ID, category = CAT_DOCUMENT, label = "Create snapshot", description = "Create a tree snapshot, input document must be eligible to Snapshotable adapter and output will the snapshot")
034public class CreateTreeSnapshot {
035    public static final String ID = "Document.CreateTreeSnapshot";
036
037    @Param(name = "versioning option", required = false)
038    String versioningOption = MINOR.name();
039
040    @OperationMethod(collector = DocumentModelCollector.class)
041    public DocumentModel run(DocumentModel doc) {
042        Snapshotable adapter = doc.getAdapter(Snapshotable.class);
043        if (adapter == null) {
044            throw new NuxeoException("Unable to get Snapshotable adapter with document: " + doc.getPathAsString());
045        }
046        return adapter.createSnapshot(VersioningOption.valueOf(versioningOption)).getDocument();
047    }
048}