org.ops4j.pax.web.service.WebAppDependencyHolder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pax-web-api Show documentation

Pax Web is a OSGi Http Service based on Jetty 6. Detailed information to be found at http://wiki.ops4j.org/confluence/x/AYAz.

There is a newer version: 9.0.18

Show newest version

/* Copyright 2012 Harald Wellmann
 *
 * 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.ops4j.pax.web.service;

import javax.servlet.ServletContainerInitializer;

import org.osgi.service.http.HttpService;


/**
 * Encapsulates dependencies for a web application. A service implementing this interface
 * is registered with a property {@code bundle.id} set to the web application bundle ID when the
 * dependencies for the given application are satisfied. 
 * 
 * @author Harald Wellmann
 *
 */
public interface WebAppDependencyHolder {
	
	/**
	 * Returns the HTTP service to be used by the given application. Required.
	 * @return HTTP service, never null
	 */
	HttpService getHttpService();
	
	/**
	 * Returns a servlet container initializer to be added to the given application. Optional.
	 * Extensions may use this initializer to customize the servlet context. 
	 * 
	 * @return servlet container initializer, or null.
	 */
	ServletContainerInitializer getServletContainerInitializer();
}