WebContainerConstants.java

/* Copyright 2007 Alin Dreghiciu.
 *
 * 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.ops.pax.web.spi;

/**
 * Web Container related constants.
 * 
 * @author Alin Dreghiciu
 * @since 0.3.0, December 27, 2007
 */
//CHECKSTYLE:OFF
public interface WebContainerConstants {

	/**
	 * Service PID used for configuration.
	 */
	String PID = "org.ops4j.pax.web";

	/**
	 * Init param name for specifying a context name.
	 */
	String CONTEXT_NAME = "webapp.context";

	/**
	 * Servlet init param name for specifying a servlet name.
	 */
	String SERVLET_NAME = "servlet-name";

	/**
	 * Filter init param name for specifying a filter name.
	 */
	String FILTER_NAME = "filter-name";

	/**
	 * Filter init param name for specifying a filter-mapping dispatch behaviour
	 * Must be a comma delimited string of:
	 * <ol>
	 * <li>request</li>
	 * <li>forward</li>
	 * <li>include</li>
	 * <li>error</li>
	 * </ol>
	 * 
	 * values are not case sensitive.
	 */
	String FILTER_MAPPING_DISPATCHER = "filter-mapping-dispatcher".intern();

	String PROPERTY_HTTP_USE_NIO = "org.osgi.service.http.useNIO";
	String PROPERTY_HTTP_CHECK_FORWARDED_HEADERS = "org.osgi.service.http.checkForwardedHeaders";
	String PROPERTY_HTTP_PORT = "org.osgi.service.http.port";
	String PROPERTY_HTTP_CONNECTOR_NAME = "org.osgi.service.http.connector.name";
	String PROPERTY_HTTP_SECURE_PORT = "org.osgi.service.http.port.secure";
	String PROPERTY_HTTP_ENABLED = "org.osgi.service.http.enabled";
	String PROPERTY_HTTP_SECURE_ENABLED = "org.osgi.service.http.secure.enabled";
	String PROPERTY_HTTP_SECURE_CONNECTOR_NAME = "org.osgi.service.http.secure.connector.name";

	String PROPERTY_SSL_KEYSTORE = PID + ".ssl.keystore";
	String PROPERTY_SSL_KEYSTORE_TYPE = PID + ".ssl.keystore.type";
	String PROPERTY_SSL_PASSWORD = PID + ".ssl.password";
	String PROPERTY_SSL_KEYPASSWORD = PID + ".ssl.keypassword";

	String PROPERTY_SSL_CLIENT_AUTH_WANTED = PID + ".ssl.clientauthwanted";
	String PROPERTY_SSL_CLIENT_AUTH_NEEDED = PID + ".ssl.clientauthneeded";

	String PROPERTY_SESSION_TIMEOUT = PID + ".session.timeout";
	String PROPERTY_SESSION_COOKIE = PID + ".session.cookie";
	String PROPERTY_SESSION_DOMAIN = PID + ".session.domain";
	String PROPERTY_SESSION_PATH = PID + ".session.path";
	String PROPERTY_SESSION_URL = PID + ".session.url";
	String PROPERTY_WORKER_NAME = PID + ".worker.name";
	String PROPERTY_SESSION_COOKIE_HTTP_ONLY = PID + ".session.cookie.httpOnly";
	String PROPERTY_SESSION_COOKIE_SECURE = PID + ".session.cookie.secure";
	String PROPERTY_SESSION_LAZY_LOAD = PID + ".session.lazyload";
	String PROPERTY_SESSION_STORE_DIRECTORY = PID + ".session.storedirectory";

	String PROPERTY_TEMP_DIR = "javax.servlet.context.tempdir";

	String PROPERTY_LISTENING_ADDRESSES = PID + ".listening.addresses";

	String PROPERTY_LOG_NCSA_ENABLED = "org.ops4j.pax.web.log.ncsa.enabled";
	String PROPERTY_LOG_NCSA_FORMAT = "org.ops4j.pax.web.log.ncsa.format";
	String PROPERTY_LOG_NCSA_RETAINDAYS = "org.ops4j.pax.web.log.ncsa.retaindays";
	String PROPERTY_LOG_NCSA_APPEND = "org.ops4j.pax.web.log.ncsa.append";
	String PROPERTY_LOG_NCSA_EXTENDED = "org.ops4j.pax.web.log.ncsa.extended";
	String PROPERTY_LOG_NCSA_DISPATCH = "org.ops4j.pax.web.log.ncsa.dispatch";
	String PROPERTY_LOG_NCSA_LOGTIMEZONE = "org.ops4j.pax.web.log.ncsa.logtimezone";
	String PROPERTY_LOG_NCSA_LOGDIR = "org.ops4j.pax.web.log.ncsa.directory";
	String PROPERTY_LOG_NCSA_LATENCY = "org.ops4j.pax.web.log.ncsa.latency";
	String PROPERTY_LOG_NCSA_COOKIES = "org.ops4j.pax.web.log.ncsa.cookies";
	String PROPERTY_LOG_NCSA_SERVER = "org.ops4j.pax.web.log.ncsa.server";
	
	
	String PROPERTY_VIRTUAL_HOST_LIST = "org.ops4j.pax.web.default.virtualhosts";
	String PROPERTY_CONNECTOR_LIST = "org.ops4j.pax.web.default.connectors";

	/**
	 * Servlet context attribute containing the bundle context of the bundle
	 * registereing the http context.
	 */
	String BUNDLE_CONTEXT_ATTRIBUTE = "osgi-bundlecontext";

	String PROPERTY_SERVER_CONFIGURATION_FILE = PID + ".config.file";

	String PROPERTY_SERVER_CONFIGURATION_URL = PID + ".config.url";

	/** Manifest header key for web application bundles. */
	String CONTEXT_PATH_KEY = "Web-ContextPath";

}
//CHECKSTYLE:ON