DZone
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
Refcards Trend Reports
Events Video Library
Refcards
Trend Reports

Events

View Events Video Library

Zones

Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks

Generative AI has transformed nearly every industry. How can you leverage GenAI to improve your productivity and efficiency?

SBOMs are essential to circumventing software supply chain attacks, and they provide visibility into various software components.

Related

  • Understanding Time Series Databases
  • Exploring Data Redaction Enhancements in Oracle Database 23ai
  • The Rise of the Intelligent AI Agent: Revolutionizing Database Management With Agentic DBA
  • Top NoSQL Databases and Use Cases

Trending

  • MCP and The Spin-Off CoT Pattern: How AI Agents Really Use Tools
  • How to Reduce Technical Debt With Artificial Intelligence (AI)
  • Docker Model Runner: Running AI Models Locally Made Simple
  • Master AI Development: The Ultimate Guide to LangChain, LangGraph, LangFlow, and LangSmith
  1. DZone
  2. Data Engineering
  3. Databases
  4. 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.

By 
Bill O'Neil user avatar
Bill O'Neil
·
Jun. 09, 17 · Tutorial
Likes (5)
Comment
Save
Tweet
Share
16.1K 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.

Related

  • Understanding Time Series Databases
  • Exploring Data Redaction Enhancements in Oracle Database 23ai
  • The Rise of the Intelligent AI Agent: Revolutionizing Database Management With Agentic DBA
  • Top NoSQL Databases and Use Cases

Partner Resources

×

Comments

The likes didn't load as expected. Please refresh the page and try again.

ABOUT US

  • About DZone
  • Support and feedback
  • Community research
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

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

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 3343 Perimeter Hill Drive
  • Suite 100
  • Nashville, TN 37211
  • [email protected]

Let's be friends: