/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.ace.agent;
import org.apache.ace.feedback.AuditEvent;
import org.osgi.annotation.versioning.ProviderType;
/**
* Compile time constants for this package. Includes configuration keys and event topics.
*/
@ProviderType
public interface AgentConstants {
/**
* Namespace for all agent configuration property
*/
String CONFIG_KEY_NAMESPACE = "agent";
/**
* Configuration loglevel for default logger. Should be a valid options s specified by {@link LoggingHandler.Levels}
* , default is INFO
.
*/
String CONFIG_LOGGING_LEVEL = CONFIG_KEY_NAMESPACE + ".logging.level";
/**
* Exclude list for auditlog events. Should be a comma separated list of integers, as defined by {@link AuditEvent}.
* Example : '2001,2003,2005,3001'
*/
String CONFIG_LOGGING_EXCLUDE_EVENTS = CONFIG_KEY_NAMESPACE + ".logging.events.exclude";
/**
* Configuration option to disable the default identification handler. When set to true some other bundle must
* provide it as a service. Should be {true,false}
, default is false
.
*
* Note that this property is expected to be set as system or environment setting! *
*/ String CONFIG_IDENTIFICATION_DISABLED = CONFIG_KEY_NAMESPACE + ".identification.disabled"; /** * Configuration option for the agentid of the default identification handler. Should be a filesystem safe string, * default isdefaultAgentID
/
*/
String CONFIG_IDENTIFICATION_AGENTID = CONFIG_KEY_NAMESPACE + ".identification.agentid";
/**
* Configuration option to disable the default discovery handler. When set to true some other bundle must provide it
* as a service. Should be {true,false}
, default is false
.
* * Note that this property is expected to be set as system or environment setting! *
*/ String CONFIG_DISCOVERY_DISABLED = CONFIG_KEY_NAMESPACE + ".discovery.disabled"; /** * Configuration option for the serverURLs of the default discovery handler. Should be a comma-separated list of * valid URLs in order of importance, default ishttp://localhost:8080
.
*/
String CONFIG_DISCOVERY_SERVERURLS = CONFIG_KEY_NAMESPACE + ".discovery.serverurls";
/**
* Configuration option to enable checking for the default discovery handler. Should be e {true,false}, default is
* true.
*/
String CONFIG_DISCOVERY_CHECKING = CONFIG_KEY_NAMESPACE + ".discovery.checking";
/**
* Configuration option to override the default controller with another implementation. This custom implementation
* is expected to be in the same bundle as the agent. Should be a fully qualified class name, and if omitted, the
* default controller will be used.
* * Note that this property is expected to be set as system or environment setting! *
*/ String CONFIG_CONTROLLER_CLASS = CONFIG_KEY_NAMESPACE + ".controller.class"; /** * Configuration option to set streaming behavior of the default controller. Should be{true,false}
,
* default is true
.
*/
String CONFIG_CONTROLLER_STREAMING = CONFIG_KEY_NAMESPACE + ".controller.streaming";
/**
* Configuration option to set fixpackages behavior of the default controller. Should be {true,false}
,
* default is true
.
*/
String CONFIG_CONTROLLER_FIXPACKAGES = CONFIG_KEY_NAMESPACE + ".controller.fixpackages";
/**
* Configuration option to set retries behavior of the default controller. Should be an int, default is
* 1
.
*/
String CONFIG_CONTROLLER_RETRIES = CONFIG_KEY_NAMESPACE + ".controller.retries";
/**
* Configuration option to set initial sync delay seconds of the default controller. Should be an int, default is
* 5
.
*/
String CONFIG_CONTROLLER_SYNCDELAY = CONFIG_KEY_NAMESPACE + ".controller.syncdelay";
/**
* Configuration option to set initial sync interval seconds of the default controller. Should be an int, default is
* 30
.
*/
String CONFIG_CONTROLLER_SYNCINTERVAL = CONFIG_KEY_NAMESPACE + ".controller.syncinterval";
/**
* Configuration option to disable the default {@link ConnectionHandler}. When set to true some other bundle must
* provide it as a service. Should be {true,false}
, default is false
.
* * Note that this property is expected to be set as system or environment setting! *
*/ String CONFIG_CONNECTION_DISABLED = CONFIG_KEY_NAMESPACE + ".connection.disabled"; /** * Configuration auth type for the default {@link ConnectionHandler}. Should be a valid type as specified by * {@link ConnectionHandler.Types}, default ifNONE
.
*/
String CONFIG_CONNECTION_AUTHTYPE = CONFIG_KEY_NAMESPACE + ".connection.authtype";
/**
* Configuration option to set the basic authentication username for the default {@link ConnectionHandler}. Should
* be an string, default is ""
.
*/
String CONFIG_CONNECTION_USERNAME = CONFIG_KEY_NAMESPACE + ".connection.username";
/**
* Configuration option to set the basic authentication password for the default {@link ConnectionHandler}. Should
* be an string, default is ""
.
*/
String CONFIG_CONNECTION_PASSWORD = CONFIG_KEY_NAMESPACE + ".connection.password";
/**
* Configuration option to set the client-cert protocol for the default {@link ConnectionHandler}. Should be a
* string, default is TLS
.
*/
String CONFIG_CONNECTION_SSL_PROTOCOL = CONFIG_KEY_NAMESPACE + ".connection.sslProtocol";
/**
* Configuration option to set the client-cert authentication keystore path for the default
* {@link ConnectionHandler} . Should be a valid path, default is ""
.
*/
String CONFIG_CONNECTION_KEYFILE = CONFIG_KEY_NAMESPACE + ".connection.keyfile";
/**
* Configuration option to set the client-cert authentication keystore password for the default
* {@link ConnectionHandler}. Should be a string, default is ""
.
*/
String CONFIG_CONNECTION_KEYPASS = CONFIG_KEY_NAMESPACE + ".connection.keypass";
/**
* Configuration option to set the client-cert authentication truststore path for the default
* {@link ConnectionHandler}. Should be a valid path, default is ""
.
*/
String CONFIG_CONNECTION_TRUSTFILE = CONFIG_KEY_NAMESPACE + ".connection.trustfile";
/**
* Configuration option to set the client-cert authentication truststore password for the default
* {@link ConnectionHandler}. Should be a string, default is ""
.
*/
String CONFIG_CONNECTION_TRUSTPASS = CONFIG_KEY_NAMESPACE + ".connection.trustpass";
/**
* Configuration option to set the feedback channels for the default {@link FeedbackHandler}. Should be a
* comma-separated string, default is auditlog
.
*/
String CONFIG_FEEDBACK_CHANNELS = CONFIG_KEY_NAMESPACE + ".feedback.channels";
/**
* Event topic used to report changes in the agent's configuration. This topic is used to report configuration
* changes to all interested listeners. To receive these events, register an {@link EventListener} and check for
* this topic. The payload for these kind of events is a snapshot(!) of the current configuration.
*/
String EVENT_AGENT_CONFIG_CHANGED = "agent/config/CHANGED";
/**
* Event topic for deployment install events, as used by the deployment admin service. Note that this event is only
* fired for the installation of deployment packages.
*/
String EVENT_DEPLOYMENT_INSTALL = "org/osgi/service/deployment/INSTALL";
/**
* Event topic for deployment uninstall events, as used by the deployment admin service. Note that this event is
* only fired for the uninstallation of deployment packages.
*/
String EVENT_DEPLOYMENT_UNINSTALL = "org/osgi/service/deployment/UNINSTALL";
/**
* Event topic for deployment install events, as used by the deployment admin service. Note that this event is only
* fired when the installation of deployment packages completes.
*/
String EVENT_DEPLOYMENT_COMPLETE = "org/osgi/service/deployment/COMPLETE";
/**
* HTTP header name used for Deployment Package size estimate, in bytes.
*/
String HEADER_DPSIZE = "X-ACE-DPSize";
}