-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Unified API for mapping static servlets #125
- Loading branch information
Showing
8 changed files
with
342 additions
and
85 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,7 @@ | ||
| ## 3.0-M5 | ||
|
|
||
| * #125 Unified API for mapping static servlets | ||
|
|
||
| ## 3.0-M4 | ||
|
|
||
| * #124 Upgrade to Jetty 11.0.20 and 10.0.20 | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
164 changes: 116 additions & 48 deletions
164
bootique-jetty-jakarta/src/main/java/io/bootique/jetty/MappedServlet.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,63 +1,131 @@ | ||
| /** | ||
| * Licensed to ObjectStyle LLC under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ObjectStyle LLC licenses | ||
| * this file to you 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 | ||
| /* | ||
| * Licensed to ObjectStyle LLC under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ObjectStyle LLC licenses | ||
| * this file to you 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 | ||
| * 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. | ||
| * 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 io.bootique.jetty; | ||
|
|
||
| import io.bootique.jetty.servlet.MultiBaseStaticServlet; | ||
| import io.bootique.resource.FolderResourceFactory; | ||
| import jakarta.servlet.Servlet; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
|
|
||
| /** | ||
| * A wrapper around a servlet object that provides access to its URL mapping and parameters. | ||
| */ | ||
| public class MappedServlet<T extends Servlet> extends MappedWebArtifact<T> { | ||
|
|
||
| public MappedServlet(T servlet, Set<String> urlPatterns) { | ||
| this(servlet, urlPatterns, null); | ||
| } | ||
|
|
||
| /** | ||
| * @param servlet | ||
| * underlying servlet instance. | ||
| * @param urlPatterns | ||
| * URL patterns that this servlet will respond to. | ||
| * @param name | ||
| * servlet name. If null, Jetty will assign its own name. | ||
| */ | ||
| public MappedServlet(T servlet, Set<String> urlPatterns, String name) { | ||
| this(servlet, urlPatterns, name, Collections.emptyMap()); | ||
| } | ||
|
|
||
| /** | ||
| * @param servlet | ||
| * underlying servlet instance. | ||
| * @param urlPatterns | ||
| * URL patterns that this servlet will respond to. | ||
| * @param name | ||
| * servlet name. If null, Jetty will assign its own name. | ||
| * @param params | ||
| * servlet init parameters map. | ||
| */ | ||
| public MappedServlet(T servlet, Set<String> urlPatterns, String name, Map<String, String> params) { | ||
| super(servlet, urlPatterns, name, params); | ||
| } | ||
|
|
||
| public T getServlet() { | ||
| return getArtifact(); | ||
| } | ||
| /** | ||
| * Creates a builder of a configuration of a "static" MappedServlet that will act as a web server for static | ||
| * files located on classpath or in an external folder. | ||
| * | ||
| * @since 3.0 | ||
| */ | ||
| public static StaticMappedServletBuilder ofStatic(String name) { | ||
| return new StaticMappedServletBuilder(name); | ||
| } | ||
|
|
||
| public MappedServlet(T servlet, Set<String> urlPatterns) { | ||
| this(servlet, urlPatterns, null); | ||
| } | ||
|
|
||
| /** | ||
| * @param servlet underlying servlet instance. | ||
| * @param urlPatterns URL patterns that this servlet will respond to. | ||
| * @param name servlet name. If null, Jetty will assign its own name. | ||
| */ | ||
| public MappedServlet(T servlet, Set<String> urlPatterns, String name) { | ||
| this(servlet, urlPatterns, name, Collections.emptyMap()); | ||
| } | ||
|
|
||
| /** | ||
| * @param servlet underlying servlet instance. | ||
| * @param urlPatterns URL patterns that this servlet will respond to. | ||
| * @param name servlet name. If null, Jetty will assign its own name. | ||
| * @param params servlet init parameters map. | ||
| */ | ||
| public MappedServlet(T servlet, Set<String> urlPatterns, String name, Map<String, String> params) { | ||
| super(servlet, urlPatterns, name, params); | ||
| } | ||
|
|
||
| public T getServlet() { | ||
| return getArtifact(); | ||
| } | ||
|
|
||
| /** | ||
| * @since 3.0 | ||
| */ | ||
| public static class StaticMappedServletBuilder { | ||
|
|
||
| private final String name; | ||
| private String[] urlPatterns; | ||
| private FolderResourceFactory resourceBase; | ||
| // capturing this as a String instead of boolean to allow Jetty apply its own string to boolean parsing | ||
| // later when our value is mixed with the servlet init params | ||
| private String pathInfoOnly; | ||
|
|
||
| protected StaticMappedServletBuilder(String name) { | ||
| this.name = name; | ||
| } | ||
|
|
||
| /** | ||
| * Defines URL patterns for the static servlet. If the call to this method is omitted or the value us null, | ||
| * the root pattern will be used ("/"). | ||
| */ | ||
| public StaticMappedServletBuilder urlPatterns(String... urlPatterns) { | ||
| this.urlPatterns = urlPatterns; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets an optional property that defines the "base" (or "docroot") of the static servlet. This is where the | ||
| * files are stored. If not set, either "bq.jetty.staticResourceBase" or "bq.jetty.servlets.[name].params.resourceBase" | ||
| * configuration properties must be defined. The latter property, if present, will override the value set here, | ||
| * thus allowing to redefine the folder. | ||
| * | ||
| * @param resourceBase a path or URL of the folder where the static files are stored. Must be in a format | ||
| * compatible with Bootique {@link io.bootique.resource.ResourceFactory}. E.g. this may | ||
| * be a filesystem path or a "classpath:" URL. | ||
| */ | ||
| public StaticMappedServletBuilder resourceBase(String resourceBase) { | ||
| this.resourceBase = resourceBase != null ? new FolderResourceFactory(resourceBase) : null; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Optionally configures the static servlet to ignore the servlet path when resolving URLs to subdirectories. | ||
| * Can be overridden via "bq.jetty.servlets.[name].params.pathInfoOnly" configuration property. | ||
| */ | ||
| public StaticMappedServletBuilder pathInfoOnly() { | ||
| this.pathInfoOnly = "true"; | ||
| return this; | ||
| } | ||
|
|
||
| public MappedServlet<?> build() { | ||
|
|
||
| MultiBaseStaticServlet servlet = new MultiBaseStaticServlet(resourceBase, pathInfoOnly); | ||
| Set<String> patterns = this.urlPatterns != null && this.urlPatterns.length > 0 | ||
| ? Set.of(this.urlPatterns) | ||
| : Set.of("/"); | ||
|
|
||
| return new MappedServlet<>(servlet, patterns, name); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.