diff options
Diffstat (limited to 'bundles/org.eclipse.equinox.http.jetty/src/org/eclipse/equinox/http/jetty/JettyCustomizer.java')
-rw-r--r-- | bundles/org.eclipse.equinox.http.jetty/src/org/eclipse/equinox/http/jetty/JettyCustomizer.java | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/bundles/org.eclipse.equinox.http.jetty/src/org/eclipse/equinox/http/jetty/JettyCustomizer.java b/bundles/org.eclipse.equinox.http.jetty/src/org/eclipse/equinox/http/jetty/JettyCustomizer.java new file mode 100644 index 000000000..bd90f2c33 --- /dev/null +++ b/bundles/org.eclipse.equinox.http.jetty/src/org/eclipse/equinox/http/jetty/JettyCustomizer.java @@ -0,0 +1,85 @@ +/******************************************************************************* + * Copyright (c) 2008, 2011 Gunnar Wagenknecht, IBM Corporation and others + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Gunnar Wagenknecht - initial API and implementation + * IBM Corporation - improvements and ongoing maintenance + *******************************************************************************/ +package org.eclipse.equinox.http.jetty; + +import java.util.Dictionary; + +/** + * Jetty Customizer allows one to customize Jetty contexts and connectors. + * <p> + * This abstract class must be extended by clients which wish to customize + * the created Jetty contexts or connectors further. + * </p> + * @since 1.1 + */ +public abstract class JettyCustomizer { + + /** + * Called by the framework when the Jetty context has been created + * and initialized. + * <p> + * 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. + * </p> + * @param context + * the Jetty context; in case of Jetty 7 the context is of + * type <code>org.eclipse.jetty.servlet.ServletContextHandler</code> + * @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 <code>org.eclipse.jetty.servlet.ServletContextHandler</code> + */ + public Object customizeContext(Object context, Dictionary<String, ?> settings) { + return context; + } + + /** + * Called by the framework when the Jetty Http Connector has been created + * and initialized. + * <p> + * Implementors may perform additional configuration of the Jetty Connector. + * </p> + * @param connector + * the Jetty connector; in case of Jetty 7 the context is of + * type <code>org.eclipse.jetty.server.Connector</code> + * @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 <code>org.eclipse.jetty.server.Connector</code> + */ + public Object customizeHttpConnector(Object connector, Dictionary<String, ?> settings) { + return connector; + } + + /** + * Called by the framework when the Jetty Https Connector has been created + * and initialized. + * <p> + * Implementors may perform additional configuration of the Jetty Connector. + * </p> + * @param connector + * the Jetty connector; in case of Jetty 7 the connector is of + * type <code>oorg.eclipse.jetty.server.Connector</code> + * @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 <code>org.eclipse.jetty.server.Connector</code> + */ + public Object customizeHttpsConnector(Object connector, Dictionary<String, ?> settings) { + return connector; + } +} |