bundles/org.eclipse.osgi.services/src/org/osgi/service/http/runtime/HttpServiceRuntimeConstants.java

/*
 * Copyright (c) OSGi Alliance (2012, 2014). All Rights Reserved.
 * 
 * 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.osgi.service.http.runtime;


/**
 * Defines standard names for Http Runtime Service constants.
 * 
 * @author $Id$
 */
public final class HttpServiceRuntimeConstants {
	private HttpServiceRuntimeConstants() {
		// non-instantiable
	}

	/**
	 * Http Runtime Service registration property specifying the endpoints upon
	 * which the Http Service Runtime is listening.
	 * 
	 * <p>
	 * An endpoint value is a URL or a relative path, to which the Http service
	 * runtime is listening. For example, {@code http://192.168.1.10:8080/} or
	 * {@code /myapp/}. A relative path may be used if the scheme and authority
	 * parts of the URL are not known, e.g. in a bridged Http Service
	 * implementation. If the Http Service implementation is serving the root
	 * context and neither scheme nor authority is known, the value of the
	 * property is "/". Both, a URL and a relative path, must end with a slash.
	 * <p>
	 * An Http Service Runtime can be listening on multiple endpoints.
	 * 
	 * <p>
	 * The value of this attribute must be of type {@code String},
	 * {@code String[]}, or {@code Collection<String>}.
	 */
	public static final String	HTTP_SERVICE_ENDPOINT_ATTRIBUTE			= "osgi.http.endpoint";

	/**
	 * Http Runtime Service registration property to associate the Http Runtime
	 * Service with one or more Http Service registrations.
	 * 
	 * <p>
	 * If this Http Whiteboard implementation also implements the Http Service
	 * Specification this property is set to a collection of {@code service.id}
	 * for the {@code HttpService} registrations provided by this
	 * implementation.
	 * 
	 * <p>
	 * The value of this attribute must be of type {@code Collection<Long>}.
	 */
	public static final String	HTTP_SERVICE_ID_ATTRIBUTE		= "osgi.http.service.id";
}