org.coos.messaging.jmx.ManagementService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of messaging-lib
There is a newer version: 1.3.1
/**
 * COOS - Connected Objects Operating System (www.connectedobjects.org).
 *
 * Copyright (C) 2009 Telenor ASA and Tellu AS. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 *
 * You may also contact one of the following for additional information:
 * Telenor ASA, Snaroyveien 30, N-1331 Fornebu, Norway (www.telenor.no)
 * Tellu AS, Hagalokkveien 13, N-1383 Asker, Norway (www.tellu.no)
 */
package org.coos.messaging.jmx;

import org.coos.messaging.Plugin;


/**
 * Management service class. Instantiate this using ManagementFactory.
 *
 * @author Robert Bjarum, tellu AS
 *
 * @see ManagementFactory
 *
 */
public interface ManagementService {

    /**
     * Register a instance of managed object for monitoring (and management).
     *
     * @param object manage object
     */
    public ManagedObject register(ManagedObject managedObject, boolean force);

    /**
     * Unregister a managed object returned from a call to register() method or other derived methods.
     *
     * @param object manage object
     */
    public void unregister(ManagedObject object);

    /**
     * Register a Plugin instance for monitoring (and management).
     *
     * @param plugin the Plugin instance to register
     * @return an instance of the managed object (a wrapper around the Plugin instance).
     */
    public ManagedObject registerPlugin(Plugin plugin);

    /**
     * Register a COOS instance for monitoring (and management).
     *
     * This method takes Object as input, but requires it to be of type COOS. However COOS is not defined
     * in the scope of the ManagementService interface.
     *
     * @param coos the COOS instance to register
     * @return an instance of the managed object (a wrapper around the COOS instance).
     */
    public ManagedObject registerCoos(Object coos);

    /**
     * Register a Router instance for monitoring (and management).
     *
     * @param coos the Router instance to register
     * @return an instance of the managed object (a wrapper around the Router instance).
     */
    public ManagedObject registerRouter(Object router);

}