001/*
002 * (C) Copyright 2013 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 *     Vladimir Pasquier <[email protected]>
018 */
019
020package org.nuxeo.ecm.platform.groups.audit.operation;
021
022import java.io.File;
023import java.io.IOException;
024
025import org.nuxeo.ecm.automation.core.Constants;
026import org.nuxeo.ecm.automation.core.annotations.Context;
027import org.nuxeo.ecm.automation.core.annotations.Operation;
028import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
029import org.nuxeo.ecm.core.api.Blob;
030import org.nuxeo.ecm.core.api.Blobs;
031import org.nuxeo.ecm.platform.groups.audit.ExcelExportConstants;
032import org.nuxeo.ecm.platform.groups.audit.service.ExcelExportService;
033
034/**
035 * Export Groups returns the Nuxeo groups excel report listing subgroups/users as a blob
036 *
037 * @since 5.7
038 */
039@Operation(id = ExportGroups.ID, category = Constants.CAT_USERS_GROUPS, label = "ExportGroups", description = "Export Groups returns the Nuxeo groups excel report listing subgroups/users")
040public class ExportGroups {
041
042    public static final String ID = "UserManager.ExportGroups";
043
044    @Context
045    ExcelExportService service;
046
047    @OperationMethod
048    public Blob run() throws IOException {
049        File export = service.getExcelReport(ExcelExportConstants.EXCEL_EXPORT_ALL_GROUPS);
050        if (export != null) {
051            return Blobs.createBlob(export);
052        }
053        return null;
054    }
055}