org.glassfish.admin.amx.j2ee.J2EEManagedObject Maven / Gradle / Ivy
Show all versions of payara-micro Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.admin.amx.j2ee;
import javax.management.ObjectName;
import org.glassfish.admin.amx.annotation.Description;
import org.glassfish.admin.amx.annotation.ManagedAttribute;
import org.glassfish.admin.amx.core.AMXProxy;
/**
The J2EEManagedObject model is the base model of all managed objects
in the J2EE Management Model. All managed objects in the J2EE Platform
must implement the J2EEManagedObject model.
*/
public interface J2EEManagedObject extends AMXProxy
{
/**
The ObjectName of the J2EEManagedObject.
All managed objects must have a unique name within the context of
the management domain. The name must not be null.
Note that the Attribute name is case-sensitive
"getobjectName" as defined by JSR 77.
@return the ObjectName of the object, as a String
*/
@ManagedAttribute
public String getobjectName();
/**
If true, indicates that the managed object provides event
notification about events that occur on that object.
NOTE: JSR 77 defines the Attribute name as "eventProvider".
*/
@ManagedAttribute
public boolean iseventProvider();
/**
If true, indicates that this managed object implements the
StateManageable model and is state manageable.
Note that the Attribute name is case-sensitive
"stateManageable" as defined by JSR 77.
*/
@ManagedAttribute
public boolean isstateManageable();
/**
If true, indicates that the managed object supports performance
statistics and therefore implements the StatisticsProvider model.
Note that the Attribute name is case-sensitive
"statisticProvider" as defined by JSR 77.
*/
@ManagedAttribute
public boolean isstatisticsProvider();
}