com.github.mjeanroy.junit.servers.jetty.EmbeddedJettyConfiguration Maven / Gradle / Ivy
/**
* The MIT License (MIT)
*
* Copyright (c) 2014-2019
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.github.mjeanroy.junit.servers.jetty;
import com.github.mjeanroy.junit.servers.commons.lang.ToStringBuilder;
import com.github.mjeanroy.junit.servers.servers.AbstractConfiguration;
import com.github.mjeanroy.junit.servers.servers.AbstractConfigurationBuilder;
import org.eclipse.jetty.util.resource.Resource;
import java.util.Objects;
import static com.github.mjeanroy.junit.servers.commons.lang.Preconditions.positive;
/**
* Jetty configuration settings.
*/
public class EmbeddedJettyConfiguration extends AbstractConfiguration {
/**
* The default {@link Builder#stopTimeout} value.
*/
private static final int DEFAULT_STOP_TIMEOUT = 30000;
/**
* The default {@link Builder#stopAtShutdown} flag.
*/
private static final boolean DEFAULT_STOP_AT_SHUTDOWN = true;
/**
* Configure the stop timeout in milliseconds: set a graceful stop time.
*
* @see org.eclipse.jetty.server.Server#setStopTimeout(long)
*/
private final int stopTimeout;
/**
* Configure jetty embedded server to stop at shutdown.
*
*
*
* If true, the server instance will be explicitly stopped when the
* JVM is shutdown. Otherwise the JVM is stopped with the server running.
*
* @see org.eclipse.jetty.server.Server#setStopAtShutdown(boolean)
*/
private final boolean stopAtShutdown;
/**
* The Jetty base resource (default is "./src/main/webapp").
*/
private final Resource baseResource;
/**
* Control which parts of the container’s classpath should be processed for things like annotations,
* META-INF/resources, META-INF/web-fragment.xml and tlds inside META-INF.
*
* @see org.eclipse.jetty.webapp.WebInfConfiguration#CONTAINER_JAR_PATTERN
*/
private final String containerJarPattern;
/**
* Control which parts of the webinf’s classpath should be processed for things like annotations,
* META-INF/resources, META-INF/web-fragment.xml and tlds inside META-INF.
*/
private final String webInfJarPattern;
/**
* Get configuration builder.
*
* @return Builder.
*/
public static Builder builder() {
return new Builder();
}
/**
* Get default configuration.
*
* @return Default configuration.
*/
public static EmbeddedJettyConfiguration defaultConfiguration() {
return new Builder().build();
}
// Private constructor, use static builder.
private EmbeddedJettyConfiguration(Builder builder) {
super(
builder.getClasspath(),
builder.getPath(),
builder.getWebapp(),
builder.getPort(),
builder.getEnvProperties(),
builder.getHooks(),
builder.getParentClassLoader(),
builder.getOverrideDescriptor()
);
this.stopTimeout = builder.getStopTimeout();
this.stopAtShutdown = builder.isStopAtShutdown();
this.baseResource = builder.getBaseResource();
this.containerJarPattern = builder.getContainerJarPattern();
this.webInfJarPattern = builder.getWebInfJarPattern();
}
/**
* Get {@link #stopTimeout}.
*
* @return {@link #stopTimeout}
*/
public int getStopTimeout() {
return stopTimeout;
}
/**
* Get {@link #stopAtShutdown}.
*
* @return {@link #stopAtShutdown}
*/
public boolean isStopAtShutdown() {
return stopAtShutdown;
}
/**
* Get {@link #baseResource}.
*
* @return {@link #baseResource}
*/
public Resource getBaseResource() {
return baseResource;
}
/**
* Get {@link #containerJarPattern}
*
* @return {@link #containerJarPattern}
*/
public String getContainerJarPattern() {
return containerJarPattern;
}
/**
* Get {@link #webInfJarPattern}
*
* @return {@link #webInfJarPattern}
*/
public String getWebInfJarPattern() {
return webInfJarPattern;
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (o instanceof EmbeddedJettyConfiguration) {
EmbeddedJettyConfiguration c = (EmbeddedJettyConfiguration) o;
return c.canEqual(this)
&& super.equals(c)
&& Objects.equals(stopTimeout, c.stopTimeout)
&& Objects.equals(stopAtShutdown, c.stopAtShutdown)
&& Objects.equals(baseResource, c.baseResource)
&& Objects.equals(containerJarPattern, c.containerJarPattern)
&& Objects.equals(webInfJarPattern, c.webInfJarPattern);
}
return false;
}
@Override
protected boolean canEqual(Object o) {
return o instanceof EmbeddedJettyConfiguration;
}
@Override
public int hashCode() {
return Objects.hash(super.hashCode(), stopTimeout, stopAtShutdown, baseResource, containerJarPattern, webInfJarPattern);
}
@Override
public String toString() {
return ToStringBuilder.create(getClass())
.append("port", getPort())
.append("path", getPath())
.append("webapp", getWebapp())
.append("classpath", getClasspath())
.append("overrideDescriptor", getOverrideDescriptor())
.append("parentClassLoader", getParentClassLoader())
.append("stopTimeout", stopTimeout)
.append("stopAtShutdown", stopAtShutdown)
.append("baseResource", baseResource)
.append("containerJarPattern", containerJarPattern)
.append("webInfJarPattern", webInfJarPattern)
.build();
}
/**
* Builder for {@link EmbeddedJettyConfiguration} instances.
*/
public static class Builder extends AbstractConfigurationBuilder {
/**
* Configure the stop timeout in milliseconds: set a graceful stop time.
*
* @see EmbeddedJettyConfiguration#DEFAULT_STOP_TIMEOUT
* @see org.eclipse.jetty.server.Server#setStopTimeout(long)
*/
private int stopTimeout;
/**
* Configure jetty embedded server to stop at shutdown.
*
*
*
* If true, the server instance will be explicitly stopped when the
* JVM is shutdown. Otherwise the JVM is stopped with the server running.
*
* @see EmbeddedJettyConfiguration#DEFAULT_STOP_AT_SHUTDOWN
* @see org.eclipse.jetty.server.Server#setStopAtShutdown(boolean)
*/
private boolean stopAtShutdown;
/**
* The base resource for the Jetty context that will be created.
*/
private Resource baseResource;
/**
* The pattern to control which part of the container classpath will
* be processed.
*
* @see org.eclipse.jetty.webapp.WebInfConfiguration#CONTAINER_JAR_PATTERN
*/
private String containerJarPattern;
/**
* The pattern to control which part of the webinf directory classpath will
* be processed.
*/
private String webInfJarPattern;
private Builder() {
stopTimeout = DEFAULT_STOP_TIMEOUT;
stopAtShutdown = DEFAULT_STOP_AT_SHUTDOWN;
}
@Override
protected Builder self() {
return this;
}
@Override
public EmbeddedJettyConfiguration build() {
return new EmbeddedJettyConfiguration(this);
}
/**
* Get current {@link #stopTimeout} value.
*
* @return {@link #stopTimeout}.
*/
public int getStopTimeout() {
return stopTimeout;
}
/**
* Get current {@link #stopAtShutdown} value.
*
* @return {@link #stopAtShutdown}.
*/
public boolean isStopAtShutdown() {
return stopAtShutdown;
}
/**
* Get current {@link #baseResource} value.
*
* @return {@link #baseResource}.
*/
public Resource getBaseResource() {
return baseResource;
}
/**
* Get current {@link #containerJarPattern} value.
*
* @return {@link #containerJarPattern}
*/
public String getContainerJarPattern() {
return containerJarPattern;
}
/**
* Get current {@link #webInfJarPattern} value.
*
* @return {@link #webInfJarPattern}
*/
public String getWebInfJarPattern() {
return webInfJarPattern;
}
/**
* Update {@link #stopTimeout} value.
*
* @param stopTimeout New {@link #stopTimeout} value.
* @return this
* @throws IllegalArgumentException If {@code stopTimeout} is not positive.
*/
public Builder withStopTimeout(int stopTimeout) {
this.stopTimeout = positive(stopTimeout, "stopTimeout");
return this;
}
/**
* Set {@link #stopAtShutdown} to {@code false}.
* @return this
*/
public Builder disableStopAtShutdown() {
return toggleStopAtShutdown(false);
}
/**
* Set {@link #stopAtShutdown} to {@code true}.
* @return this
*/
public Builder enableStopAtShutdown() {
return toggleStopAtShutdown(true);
}
/**
* Toggle {@link #stopAtShutdown}.
*
* @param stopAtShutdown New {@link #stopAtShutdown} value.
* @return this
*/
private Builder toggleStopAtShutdown(boolean stopAtShutdown) {
this.stopAtShutdown = stopAtShutdown;
return this;
}
/**
* Change {@link #baseResource} value.
*
* @param resource New {@link #baseResource} value.
* @return this
*/
public Builder withBaseResource(Resource resource) {
this.baseResource = resource;
return this;
}
/**
* Change {@link #containerJarPattern} value.
*
* @param containerJarPattern The container JAR pattern.
* @return this
*/
public Builder withContainerJarPattern(String containerJarPattern) {
this.containerJarPattern = containerJarPattern;
return this;
}
/**
* Change {@link #webInfJarPattern} value.
*
* @param webInfJarPattern The webinf JAR pattern.
* @return this
*/
public Builder withWebInfJarPattern(String webInfJarPattern) {
this.webInfJarPattern = webInfJarPattern;
return this;
}
}
}