Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Query Parameters and Path Parameters in Undertow

DZone's Guide to

Query Parameters and Path Parameters in Undertow

Take a look at how to use query and path parameters in Undertow. In addition to some examples, there are some best practices to keep in mind as well.

· Java Zone ·
Free Resource

Verify, standardize, and correct the Big 4 + more– name, email, phone and global addresses – try our Data Quality APIs now at Melissa Developer Portal!

Query parameters and path parameters are fairly straightforward in Undertow. There is some slight boilerplate because, technically, query and path params can have multiple values. We are using some helper functions (PathParameters.java and QueryParameters.java).

Path Parameter and Query Parameter RoutingHandler

Fairly standard path param syntax. Undertow uses {param}, though you may be used to :param from other frameworks.

private static final HttpHandler ROUTES = new RoutingHandler()
    .get("/hello", ParametersServer::queryParam)
    .get("/hello/{name}/{num}", ParametersServer::pathParam)
    .get("/users/{userId}", ParametersServer::obfuscatedIdRoute)
;


View on GitHub

Path Parameter and Query Parameter HttpHandlers

These should be straightforward. Once again, we are using the following helpers — PathParameters.java and QueryParameters.java

private static void queryParam(HttpServerExchange exchange) {
    String name = Exchange.queryParams().queryParam(exchange, "name").orElse("world");
    int num = Exchange.queryParams().queryParamAsInteger(exchange, "num").orElse(1);
    Exchange.body().sendText(exchange, "Hello " + name + Strings.repeat("!", num));
}

private static void pathParam(HttpServerExchange exchange) {
    String name = Exchange.pathParams().pathParam(exchange, "name").orElse("world");
    int num = Exchange.pathParams().pathParamAsInteger(exchange, "num").orElse(1);
    Exchange.body().sendText(exchange, "Hello " + name + Strings.repeat("!", num));
}


View on GitHub

Server

public static void main(String[] args) {
    // Just some examples for obfuscated parameters.
    LongStream.range(100_000_000, 100_000_003).forEach( id -> {
       log.debug("id: " + id + " hashed: " + HashIds.encode(id));
    });
    SimpleServer server = SimpleServer.simpleServer(ROUTES);
    server.start();
}


View on GitHub

Output

curl localhost:8080/hello
Hello world!
curl localhost:8080/hello?name=bill
Hello bill!
curl 'localhost:8080/hello?name=bill&num=5'
Hello bill!!!!!
curl 'localhost:8080/hello/bill/5'
Hello bill!!!!!


Best Practices

Although it's not very hard to call params in this way, we recommend extracting the logic out even further. Take a look at Request Utilities. Here, you define the string literals and defaults once and only once. Everywhere else in the code that references this param is called just like UserRequests.email(exchange). This way, if you change the param name or even the type of param, it updates all of your code at once. Sharing defaults is also incredibly useful. Another feature of this is that you can cache values on the HttpServerExchange so you can use expensive calls in multiple routes with the cached values.

Obfuscating Sequential Ids

Sometimes you may want to obfuscate sequential ids to reduce the possibility of giving away some information. A quick example can be found at Obfuscating and Shortening Sequential ids with HashIds.

Developers! Quickly and easily gain access to the tools and information you need! Explore, test and combine our data quality APIs at Melissa Developer Portal – home to tools that save time and boost revenue. Our APIs verify, standardize, and correct the Big 4 + more – name, email, phone and global addresses – to ensure accurate delivery, prevent blacklisting and identify risks in real-time.

Topics:
java ,undertow ,query parameters ,path parameters ,tutorial

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}