org.eclipse.rap.http.jetty.JettyCustomizer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.rap.http.jetty
Jetty Http Service for use with the Eclipse RAP Widget Toolkit
The newest version!
/*******************************************************************************
 * Copyright (c) 2008, 2011 Gunnar Wagenknecht, IBM Corporation and others
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 * 
 * Contributors:
 *     Gunnar Wagenknecht - initial API and implementation
 *     IBM Corporation - improvements and ongoing maintenance
 *******************************************************************************/
package org.eclipse.rap.http.jetty;

import java.util.Dictionary;

/**
 * Jetty Customizer allows one to customize Jetty contexts and connectors.
 * 
 * This abstract class must be extended by clients which wish to customize the
 * created Jetty contexts or connectors further.
 * 
 * 
 * @since 1.1
 */
public abstract class JettyCustomizer {

	/**
	 * Called by the framework when the Jetty context has been created and
	 * initialized.
	 * 
	 * Implementors may perform additional configuration of the Jetty context.
	 * However, they must be aware that changing certain central functionalities of
	 * the context such as class loading are already configured by the framework.
	 * Changing those may cause breakage and thus must be avoided.
	 * 
	 * 
	 * @param context  the Jetty context; in case of Jetty 7 the context is of type
	 *                 org.eclipse.jetty.servlet.ServletContextHandler
	 * @param settings the settings as passed to
	 *                 {@link JettyConfigurator#startServer(String, Dictionary)}
	 * @return context the customized context; in case of Jetty 7 the context is of
	 *         type org.eclipse.jetty.servlet.ServletContextHandler
	 */
	public Object customizeContext(Object context, Dictionary settings) {
		return context;
	}

	/**
	 * Called by the framework when the Jetty Http Connector has been created and
	 * initialized.
	 * 
	 * Implementors may perform additional configuration of the Jetty Connector.
	 * 
	 * 
	 * @param connector the Jetty connector; in case of Jetty 7 the context is of
	 *                  type org.eclipse.jetty.server.Connector
	 * @param settings  the settings as passed to
	 *                  {@link JettyConfigurator#startServer(String, Dictionary)}
	 * @return connector the customized connector; in case of Jetty 6 the connector
	 *         is of type org.eclipse.jetty.server.Connector
	 */
	public Object customizeHttpConnector(Object connector, Dictionary settings) {
		return connector;
	}

	/**
	 * Called by the framework when the Jetty Https Connector has been created and
	 * initialized.
	 * 
	 * Implementors may perform additional configuration of the Jetty Connector.
	 * 
	 * 
	 * @param connector the Jetty connector; in case of Jetty 7 the connector is of
	 *                  type oorg.eclipse.jetty.server.Connector
	 * @param settings  the settings as passed to
	 *                  {@link JettyConfigurator#startServer(String, Dictionary)}
	 * @return connector the customized connector; in case of Jetty 7 the connector
	 *         is of type org.eclipse.jetty.server.Connector
	 */
	public Object customizeHttpsConnector(Object connector, Dictionary settings) {
		return connector;
	}
}