blob: ae42d2bfc06a0063997a54c640baf4d568a58a34 [file] [log] [blame]
/*
* Copyright (C) MX4J.
* All rights reserved.
*
* This software is distributed under the terms of the MX4J License version 1.0.
* See the terms of the MX4J License in the documentation provided with this software.
*/
/*
* Copyright 2005 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.felix.mosgi.jmx.rmiconnector.mx4j.remote;
/**
* @author <a href="mailto:biorn_steedom@users.sourceforge.net">Simone Bordet</a>
* @version $Revision: 1.1.1.1 $
*/
public interface MX4JRemoteConstants
{
/**
* A vertical bar '|' as mandated by the spec
*/
public static final String PROVIDER_PACKAGES_SEPARATOR = "|";
/**
* MX4J provider packages list for JMXConnector and JMXConnectorServer factories
*/
public static final String PROVIDER_PACKAGES = "org.apache.felix.mosgi.jmx.rmiconnector.mx4j.remote.provider" + PROVIDER_PACKAGES_SEPARATOR + "org.apache.felix.mosgi.jmx.rmiconnector.mx4j.tools.remote.provider";
/**
* The string 'ClientProvider' as mandated by the spec
*/
public static final String CLIENT_PROVIDER_CLASS = "ClientProvider";
/**
* The string 'ServerProvider' as mandated by the spec
*/
public static final String SERVER_PROVIDER_CLASS = "ServerProvider";
/**
* The key that specifies resolver packages, very much like
* {@link javax.management.remote.JMXConnectorFactory#PROTOCOL_PROVIDER_PACKAGES}
*/
public static final String PROTOCOL_RESOLVER_PACKAGES = "mx4j.remote.resolver.pkgs";
/**
* A vertical bar '|'
*/
public static final String RESOLVER_PACKAGES_SEPARATOR = PROVIDER_PACKAGES_SEPARATOR;
/**
* MX4J provider packages list for {@link mx4j.remote.ConnectionResolver} subclasses
*/
public static final String RESOLVER_PACKAGES = "org.apache.felix.mosgi.jmx.rmiconnector.mx4j.remote.resolver" + RESOLVER_PACKAGES_SEPARATOR + "org.apache.felix.mosgi.jmx.rmiconnector.mx4j.tools.remote.resolver";
/**
* The string 'Resolver'
*/
public static final String RESOLVER_CLASS = "Resolver";
/**
* The reference implementation uses this property to specify the notification fetch timeout (in ms).
* MX4J will use the same for compatibility. DO NOT CHANGE IT unless the reference implementation changes it.
*/
public static final String FETCH_NOTIFICATIONS_TIMEOUT = "jmx.remote.x.client.fetch.timeout";
/**
* The reference implementation uses this property to specify the maximum number of notification to fetch.
* MX4J will use the same for compatibility. DO NOT CHANGE IT unless the reference implementation changes it.
*/
public static final String FETCH_NOTIFICATIONS_MAX_NUMBER = "jmx.remote.x.client.max.notifications";
/**
* The reference implementation uses this property to specify the notification buffer size.
* MX4J will use the same for compatibility. DO NOT CHANGE IT unless the reference implementation changes it.
*/
public static final String NOTIFICATION_BUFFER_CAPACITY = "jmx.remote.x.buffer.size";
/**
* MX4J's implementation uses this property to specify the distance between the lowest expected notification
* sequence number (sent by the client via fetchNotifications()) and the minimum sequence number of the
* notification buffer. When this difference is greater than the value of this property, old notifications
* are eliminated from the notification buffer
*/
public static final String NOTIFICATION_PURGE_DISTANCE = "jmx.remote.x.notification.purge.distance";
/**
* MX4J's implementation uses this property to specify the amount of time (in ms) the client should sleep
* between notification fetches. A value of 0 means there will be no sleep (fetches will be done one
* after the other).
*/
public static final String FETCH_NOTIFICATIONS_SLEEP = "jmx.remote.x.notification.fetch.sleep";
/**
* MX4J's implementation uses this property to specify the period (in ms) of the heartbeat pulse for
* {@link javax.management.remote.JMXConnector JMXConnectors} that use heartbeat to check if the
* connection with {@link javax.management.remote.JMXConnectorServer JMXConnectorServers} is still alive.
* @see #CONNECTION_HEARTBEAT_RETRIES
*/
public static final String CONNECTION_HEARTBEAT_PERIOD = "jmx.remote.x.connection.heartbeat.period";
/**
* MX4J's implementation uses this property to specify the number of retries of heartbeat pulses before
* declaring the connection between a {@link javax.management.remote.JMXConnector JMXConnector} and a
* {@link javax.management.remote.JMXConnectorServer JMXConnectorServer} failed, at which a
* {@link javax.management.remote.JMXConnectionNotification notification failed} is emitted.
* @see #CONNECTION_HEARTBEAT_PERIOD
*/
public static final String CONNECTION_HEARTBEAT_RETRIES = "jmx.remote.x.connection.heartbeat.retries";
}