org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer Maven / Gradle / Ivy
/*
* Copyright 2012-2015 the original author or authors.
*
* 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.springframework.boot.context.embedded;
import java.io.File;
import java.net.InetAddress;
import java.util.List;
import java.util.Set;
import java.util.concurrent.TimeUnit;
/**
* Simple interface that represents customizations to an
* {@link EmbeddedServletContainerFactory}.
*
* @author Dave Syer
* @author Andy Wilkinson
* @author Stephane Nicoll
* @see EmbeddedServletContainerFactory
* @see EmbeddedServletContainerCustomizer
*/
public interface ConfigurableEmbeddedServletContainer {
/**
* Sets the context path for the embedded servlet container. The context should start
* with a "/" character but not end with a "/" character. The default context path can
* be specified using an empty string.
* @param contextPath the contextPath to set
*/
void setContextPath(String contextPath);
/**
* Sets the display name of the application deployed in the embedded servlet
* container.
* @param displayName the displayName to set
* @since 1.3.0
*/
void setDisplayName(String displayName);
/**
* Sets the port that the embedded servlet container should listen on. If not
* specified port '8080' will be used. Use port -1 to disable auto-start (i.e start
* the web application context but not have it listen to any port).
* @param port the port to set
*/
void setPort(int port);
/**
* The session timeout in seconds (default 30 minutes). If 0 or negative then sessions
* never expire.
* @param sessionTimeout the session timeout
*/
void setSessionTimeout(int sessionTimeout);
/**
* The session timeout in the specified {@link TimeUnit} (default 30 minutes). If 0 or
* negative then sessions never expire.
* @param sessionTimeout the session timeout
* @param timeUnit the time unit
*/
void setSessionTimeout(int sessionTimeout, TimeUnit timeUnit);
/**
* Sets if session data should be persisted between restarts.
* @param persistSession {@code true} if session data should be persisted
*/
void setPersistSession(boolean persistSession);
/**
* Set the directory used to store serialized session data.
* @param sessionStoreDir the directory or {@code null} to use a default location.
*/
void setSessionStoreDir(File sessionStoreDir);
/**
* Sets the specific network address that the server should bind to.
* @param address the address to set (defaults to {@code null})
*/
void setAddress(InetAddress address);
/**
* The class name for the jsp servlet if used. If
* {@link #setRegisterJspServlet(boolean) registerJspServlet} is true and this
* class is on the classpath then it will be registered. Since both Tomcat and Jetty
* use Jasper for their JSP implementation the default is
* {@code org.apache.jasper.servlet.JspServlet}.
* @param jspServletClassName the class name for the JSP servlet if used
* @deprecated in 1.3.0 in favor of {@link JspServlet#setClassName(String)}
* @see #setJspServlet
* @see JspServlet#setClassName(String)
*/
@Deprecated
void setJspServletClassName(String jspServletClassName);
/**
* Set if the JspServlet should be registered if it is on the classpath. Defaults to
* {@code true} so that files from the {@link #setDocumentRoot(File) document root}
* will be served.
* @param registerJspServlet if the JSP servlet should be registered
* @deprecated in 1.3.0 in favor of {@link JspServlet#setRegistered(boolean)}
* @see #setJspServlet
* @see JspServlet#setRegistered(boolean)
*/
@Deprecated
void setRegisterJspServlet(boolean registerJspServlet);
/**
* Set if the DefaultServlet should be registered. Defaults to {@code true} so that
* files from the {@link #setDocumentRoot(File) document root} will be served.
* @param registerDefaultServlet if the default servlet should be registered
*/
void setRegisterDefaultServlet(boolean registerDefaultServlet);
/**
* Adds error pages that will be used when handling exceptions.
* @param errorPages the error pages
*/
void addErrorPages(ErrorPage... errorPages);
/**
* Sets the error pages that will be used when handling exceptions.
* @param errorPages the error pages
*/
void setErrorPages(Set errorPages);
/**
* Sets the mime-type mappings.
* @param mimeMappings the mime type mappings (defaults to
* {@link MimeMappings#DEFAULT})
*/
void setMimeMappings(MimeMappings mimeMappings);
/**
* Sets the document root directory which will be used by the web context to serve static
* files.
* @param documentRoot the document root or {@code null} if not required
*/
void setDocumentRoot(File documentRoot);
/**
* Sets {@link ServletContextInitializer} that should be applied in addition to
* {@link EmbeddedServletContainerFactory#getEmbeddedServletContainer(ServletContextInitializer...)}
* parameters. This method will replace any previously set or added initializers.
* @param initializers the initializers to set
* @see #addInitializers
*/
void setInitializers(List initializers);
/**
* Add {@link ServletContextInitializer}s to those that should be applied in addition
* to
* {@link EmbeddedServletContainerFactory#getEmbeddedServletContainer(ServletContextInitializer...)}
* parameters.
* @param initializers the initializers to add
* @see #setInitializers
*/
void addInitializers(ServletContextInitializer... initializers);
/**
* Sets the SSL configuration that will be applied to the container's default
* connector.
* @param ssl the SSL configuration
*/
void setSsl(Ssl ssl);
/**
* Sets the configuration that will be applied to the container's JSP servlet.
* @param jspServlet the JSP servlet configuration
*/
void setJspServlet(JspServlet jspServlet);
/**
* Sets the compression configuration that will be applied to the container's default
* connector.
* @param compression the compression configuration
*/
void setCompression(Compression compression);
}