DZone
Java Zone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
  • Refcardz
  • Trend Reports
  • Webinars
  • Zones
  • |
    • Agile
    • AI
    • Big Data
    • Cloud
    • Database
    • DevOps
    • Integration
    • IoT
    • Java
    • Microservices
    • Open Source
    • Performance
    • Security
    • Web Dev
DZone > Java Zone > Query Parameters and Path Parameters in Undertow

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.

Bill O'Neil user avatar by
Bill O'Neil
·
Jun. 09, 17 · Java Zone · Tutorial
Like (5)
Save
Tweet
14.41K Views

Join the DZone community and get the full member experience.

Join For Free

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.

Database

Published at DZone with permission of Bill O'Neil. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • Why to Implement GitOps into Your Kubernetes CI/CD Pipelines
  • How To Deploy Apache Kafka With Kubernetes
  • Kafka Fail-Over Using Quarkus Reactive Messaging
  • Building a Kotlin Mobile App with the Salesforce SDK, Part 3: Synchronizing Data

Comments

Java Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • MVB Program
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends:

DZone.com is powered by 

AnswerHub logo