001/*
002 * (C) Copyright 2016 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl-2.1.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Stephane Lacoin at Nuxeo (aka matic)
016 */
017package org.nuxeo.connect.tools.report;
018
019import java.io.IOException;
020import javax.management.MXBean;
021
022/**
023 * Remote interface exposed through JMX which snapshots a runtime inventory.
024 *
025 * @since 8.3
026 */
027@MXBean
028public interface ReportServer {
029
030    /**
031     * Makes a runtime inventory and serializes in the provided socket in the
032     * JSON format.
033     *
034     * @return the file path where the snapshot is stored
035     * @throws IOException
036     */
037    void run(String host, int port, String... names) throws IOException;
038
039}