001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.api.management;
018
019/**
020 * This module contains jmx related system property key constants.
021 */
022public final class JmxSystemPropertyKeys {
023
024    // disable jmx
025    public static final String DISABLED = "org.apache.camel.jmx.disabled";
026
027    // jmx (rmi registry) port
028    public static final String REGISTRY_PORT = "org.apache.camel.jmx.rmiConnector.registryPort";
029    
030    // jmx (rmi server connection) port
031    public static final String CONNECTOR_PORT = "org.apache.camel.jmx.rmiConnector.connectorPort";
032
033    // jmx domain name
034    public static final String DOMAIN = "org.apache.camel.jmx.mbeanServerDefaultDomain";
035    
036    // the domain name for the camel mbeans
037    public static final String MBEAN_DOMAIN = "org.apache.camel.jmx.mbeanObjectDomainName";
038
039    // JMX service URL path 
040    public static final String SERVICE_URL_PATH = "org.apache.camel.jmx.serviceUrlPath";
041    
042    // A flag that indicates whether the agent should be created
043    public static final String CREATE_CONNECTOR = "org.apache.camel.jmx.createRmiConnector";
044    
045    // use jvm platform mbean server flag
046    public static final String USE_PLATFORM_MBS = "org.apache.camel.jmx.usePlatformMBeanServer";
047
048    // whether all processors or only processors with a custom id given should be registered
049    public static final String ONLY_REGISTER_PROCESSOR_WITH_CUSTOM_ID = "org.apache.camel.jmx.onlyRegisterProcessorWithCustomId";
050
051    // whether to enable gathering load statistics in the background
052    public static final String LOAD_STATISTICS_ENABLED = "org.apache.camel.jmx.loadStatisticsEnabled";
053
054    // whether to enable gathering endpoint runtime statistics
055    public static final String ENDPOINT_RUNTIME_STATISTICS_ENABLED = "org.apache.camel.jmx.endpointRuntimeStatisticsEnabled";
056
057    // the level of statistics enabled
058    public static final String STATISTICS_LEVEL = "org.apache.camel.jmx.statisticsLevel";
059
060    // whether to register always
061    public static final String REGISTER_ALWAYS = "org.apache.camel.jmx.registerAlways";
062
063    // whether to register when starting new routes
064    public static final String REGISTER_NEW_ROUTES = "org.apache.camel.jmx.registerNewRoutes";
065
066    // Whether to remove detected sensitive information (such as passwords) from MBean names and attributes.
067    public static final String MASK = "org.apache.camel.jmx.mask";
068
069    // Whether to include host name in MBean names
070    public static final String INCLUDE_HOST_NAME = "org.apache.camel.jmx.includeHostName";
071
072    // To configure the default management name pattern using a JVM system property
073    public static final String MANAGEMENT_NAME_PATTERN = "org.apache.camel.jmx.managementNamePattern";
074    
075    // flag to enable host ip address instead of host name 
076    public static final String USE_HOST_IP_ADDRESS = "org.apache.camel.jmx.useHostIPAddress";
077
078
079    private JmxSystemPropertyKeys() {
080        // not instantiated
081    }
082
083}