ServletParameterParser.java
package server.restful.common.parameter;
import com.beust.jcommander.JCommander;
import com.beust.jcommander.ParameterException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import server.restful.common.parameter.usage.ServletUsageFormatter;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.function.Function;
import java.util.stream.Stream;
import static java.util.Arrays.asList;
import static java.util.Optional.ofNullable;
import static java.util.stream.Stream.*;
import static server.restful.common.parameter.ServletParameterHelper.OPTION_MAX_LENGTH;
/**
*
* Parse servlet parameters using JCommander based on annotated parameter objects. Servlet path is treated like a main
* argument and servlet parameters as options.
*
* @author khaendel
*
*/
public class ServletParameterParser {
private static final List<String> VALUE_ABSENT = asList("", "null", "undefined");
public static final String HELP = "help";
private final JCommander commander;
private final ServletUsageFormatter usageFormatter;
/**
* Parse request parameters and request path according to annotated parameters of the parameterObject.
*
* @param request servlet request to parse
* @param response servlet response to output usage message
* @param parameterObject annotated parameters of the parameterObject
*/
public ServletParameterParser(HttpServletRequest request, HttpServletResponse response, Object parameterObject)
throws IOException {
this(request, response, parameterObject, false);
}
public ServletParameterParser(HttpServletRequest request, HttpServletResponse response, Object parameterObject,
boolean acceptUnknownOptions) throws IOException {
commander = JCommander.newBuilder().addObject(parameterObject).programName(request.getServletPath())
.columnSize(Integer.MAX_VALUE).console(new ServletConsole(response))
.acceptUnknownOptions(acceptUnknownOptions).build();
usageFormatter = new ServletUsageFormatter(commander, request, response);
commander.setUsageFormatter(usageFormatter);
try {
commander.parse(getRequestParametersAsCommandLine(request));
} catch (ParameterException e) {
setException(e);
}
}
public void usage() {
commander.usage();
}
public void setException(Exception exception) {
usageFormatter.setException(exception);
}
public boolean hasException() {
return usageFormatter.getException() != null;
}
public static String[] getRequestParametersAsCommandLine(HttpServletRequest request) {
return concat(
Collections.list(request.getParameterNames()).stream()
.flatMap(name -> Arrays.stream(request.getParameterValues(name))
.filter(v -> VALUE_ABSENT.stream().noneMatch(v::equals))
.filter(v -> !(HELP.equals(name) && Boolean.FALSE.toString().equals(v)))
.map(v -> of((name.length() > OPTION_MAX_LENGTH ? "--" : "-") + name, v)))
.flatMap(Function.identity()),
ofNullable(request.getPathInfo()).map(Stream::of).orElse(empty())).toArray(String[]::new);
}
}