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 *     Nuxeo - initial API and implementation
018 */
019
020package org.nuxeo.ecm.core.management.api;
021
022import java.util.List;
023
024import org.nuxeo.ecm.core.management.statuses.AdministrableServiceDescriptor;
025
026public interface GlobalAdministrativeStatusManager {
027
028    /**
029     * Returns the identifier of the local Nuxeo Instance.
030     */
031    String getLocalNuxeoInstanceIdentifier();
032
033    /**
034     * Lists the identifiers of all Nuxeo Instances.
035     */
036    List<String> listInstanceIds();
037
038    /**
039     * Retrieve the {@link AdministrativeStatusManager} for a given Nuxeo instance.
040     */
041    AdministrativeStatusManager getStatusManager(String instanceIdentifier);
042
043    /**
044     * Updates the status of a service for all registered Nuxeo instances.
045     */
046    void setStatus(String serviceIdentifier, String state, String message, String login);
047
048    /**
049     * Lists services that are declared to be administrable.
050     */
051    List<AdministrableServiceDescriptor> listRegistredServices();
052
053    /**
054     * Gets the XMAP descriptor for one service.
055     */
056    AdministrableServiceDescriptor getServiceDescriptor(String serviceIdentifier);
057
058    /**
059     * Registers a service given its descriptor.
060     */
061    void registerService(AdministrableServiceDescriptor desc);
062
063}