Mercurial > hg > release > thermostat-0.5
view agent/core/src/main/java/com/redhat/thermostat/agent/VmStatusListener.java @ 911:03948c38134a
Introduce Service and ExtensionPoint annotations
Thermostat currently has a large number of interfaces that are meant to
be used as services (where a client obtains an instance of the interface
from OSGi) or as extension points (where a client registers an instance
of the interface as an OSGi service and thermostat makes use of it).
There is no clear indication of which interfaces are what.
Clarify this by introducing two annotations @Service and @ExtensionPoint
that should be used to document the purpose of the interface. These
annotations do not imply any behaviour and are for documentation
purposes only.
Also introduce an annotation processor that writes "plugin-docs.xml"
files containing some basic documentation about classes marked with
@Service or @ExtensionPoint. Nothing explicit needs to be done to
invoke the annotation processor, simply including a dependency on
thermostat-annotations (needed to use @Service/@ExtensionPoint anyway)
is enough. These xml files are not included in the jars.
Reviewed-by: ebaron, jerboaa, vanaltj
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-January/004983.html
PR1255
author | Omair Majid <omajid@redhat.com> |
---|---|
date | Tue, 15 Jan 2013 13:00:50 -0500 |
parents | 421d8a954893 |
children | ccac9bcabaa0 |
line wrap: on
line source
/* * Copyright 2013 Red Hat, Inc. * * This file is part of Thermostat. * * Thermostat is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published * by the Free Software Foundation; either version 2, or (at your * option) any later version. * * Thermostat 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 * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with Thermostat; see the file COPYING. If not see * <http://www.gnu.org/licenses/>. * * Linking this code with other modules is making a combined work * based on this code. Thus, the terms and conditions of the GNU * General Public License cover the whole combination. * * As a special exception, the copyright holders of this code give * you permission to link this code with independent modules to * produce an executable, regardless of the license terms of these * independent modules, and to copy and distribute the resulting * executable under terms of your choice, provided that you also * meet, for each linked independent module, the terms and conditions * of the license of that module. An independent module is a module * which is not derived from or based on this code. If you modify * this code, you may extend this exception to your version of the * library, but you are not obligated to do so. If you do not wish * to do so, delete this exception statement from your version. */ package com.redhat.thermostat.agent; import com.redhat.thermostat.annotations.ExtensionPoint; /** * A listener that is notified when a JVM starts or is stopped. * <p> * Register an instance of this class as an OSGi service, and it will be * notified of all VM {@link Status} events. */ @ExtensionPoint public interface VmStatusListener { enum Status { /** A VM has just started now */ VM_STARTED, /** * A delayed version of {@link #VM_STARTED}. A VM was started at some * point in the past. The listener was not informed about it then * (probably because the listener was not registered at the time), but * is being informed about it now. */ VM_ACTIVE, /** A VM was stopped just now */ VM_STOPPED, } // TODO what other information other than pid may be useful for plugins? public void vmStatusChanged(Status newStatus, int pid); }