![JAR search and dependency download from the Maven repository](/logo.png)
org.jvnet.hk2.jmx.api.HK2JmxSpecifier Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2013-2015 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.jvnet.hk2.jmx.api;
import javax.management.ObjectName;
import org.glassfish.hk2.api.ActiveDescriptor;
import org.glassfish.hk2.api.Filter;
import org.jvnet.hk2.annotations.Contract;
/**
* This service must be implemented in order to specify those
* descriptors that might be reflected into JMX
*
* @author jwells
*
*/
@Contract
public interface HK2JmxSpecifier {
/**
* Gets the string for connecting to the JmxServer
*
* @return The name of the JmxServer to connect to, or null for the platform server
*/
public String getJmxServerName();
/**
* Returns true for descriptors that should possibly have
* instances put into JMX. May be an implementation
* of IndexedFilter
*
* @return The non-null filter to determine what descriptors
* should be considered for adding to Jmx
*/
public Filter getJmxDescriptorFilter();
/**
* Gets the Object that should be used either directly
* or to be modelled.
*
* @param descriptor The descriptor from which this instance was created
* @param instance The instance created
* @return The object to either be placed directly into JMX or to be
* modelled. If this returns null then this instance will not be put into
* Jmx
*/
public Object getJmxObject(ActiveDescriptor> descriptor, Object instance);
/**
* Returns the policy to use for adding the next JmxObject
* @return
*/
public String getAnalysisPolicy();
public ObjectName getObjectName(Object instance);
public String getObjectNamePolicy();
public String getDomainName();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy