Skip to content

[UNDERTOW-2736] Align handlers$Builder pattern #1934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
baranowb wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[UNDERTOW-2736] Align handlers$Builder pattern #1934

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions core/src/main/java/io/undertow/server/handlers/ReasonPhraseHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,16 @@

package io.undertow.server.handlers;

import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import io.undertow.UndertowLogger;
import io.undertow.server.HandlerWrapper;
import io.undertow.server.HttpHandler;
import io.undertow.server.HttpServerExchange;
import io.undertow.server.handlers.builder.HandlerBuilder;

/**
* A handler which simply sets a response code.
Expand Down Expand Up @@ -63,4 +70,41 @@ public void handleRequest(final HttpServerExchange exchange) throws Exception {
public String toString() {
return "reason-phrase( " + this.reasonPhrase + " )";
}

public static class Builder implements HandlerBuilder {
@Override
public String name() {
return "reason-phrase";
}

@Override
public Map<String, Class<?>> parameters() {
Map<String, Class<?>> parameters = new HashMap<>();
parameters.put("value", String.class);
return parameters;
}

@Override
public Set<String> requiredParameters() {
final Set<String> req = new HashSet<>();
req.add("value");
return req;
}

@Override
public String defaultParameter() {
return "value";
}

@Override
public HandlerWrapper build(final Map<String, Object> config) {
final String value = (String) config.get("value");
return new HandlerWrapper() {
@Override
public HttpHandler wrap(HttpHandler handler) {
return new ReasonPhraseHandler(handler, value);
}
};
}
}
}
50 changes: 50 additions & 0 deletions core/src/main/java/io/undertow/server/handlers/ResponseCodeHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,16 @@

package io.undertow.server.handlers;

import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import io.undertow.UndertowLogger;
import io.undertow.server.HandlerWrapper;
import io.undertow.server.HttpHandler;
import io.undertow.server.HttpServerExchange;
import io.undertow.server.handlers.builder.HandlerBuilder;

/**
* A handler which simply sets a response code.
Expand Down Expand Up @@ -111,4 +118,47 @@ public void handleRequest(final HttpServerExchange exchange) throws Exception {
public String toString() {
return "response-code( " + this.responseCode + " )";
}

public static class Builder implements HandlerBuilder {

@Override
public String name() {
return "response-code";
}

@Override
public Map<String, Class<?>> parameters() {
Map<String, Class<?>> parameters = new HashMap<>();
parameters.put("value", Integer.class);
return parameters;
}

@Override
public Set<String> requiredParameters() {
final Set<String> req = new HashSet<>();
req.add("value");
return req;
}

@Override
public String defaultParameter() {
return "value";
}

@Override
public HandlerWrapper build(final Map<String, Object> config) {
final Integer value = (Integer) config.get("value");
return new HandlerWrapper() {
@Override
public HttpHandler wrap(HttpHandler handler) {
return new ResponseCodeHandler(handler, value);
}
};
}

@Override
public int priority() {
return 0;
}
}
}
59 changes: 59 additions & 0 deletions core/src/main/java/io/undertow/server/handlers/ResponseHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,17 @@
*/
package io.undertow.server.handlers;

import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import io.undertow.UndertowLogger;
import io.undertow.UndertowMessages;
import io.undertow.server.HandlerWrapper;
import io.undertow.server.HttpHandler;
import io.undertow.server.HttpServerExchange;
import io.undertow.server.handlers.builder.HandlerBuilder;
import io.undertow.util.HeaderMap;
import io.undertow.util.Headers;

Expand Down Expand Up @@ -106,4 +113,56 @@ public String toString() {
+ ((this.body != null) ? ", type='" + this.type + "', body='" + this.body + "'" : "") + " )";
}

public static class Builder implements HandlerBuilder {

@Override
public String name() {
return "response";
}

@Override
public Map<String, Class<?>> parameters() {
Map<String, Class<?>> parameters = new HashMap<>();
parameters.put("code", Integer.class);
parameters.put("reason", String.class);
parameters.put("type", String.class);
parameters.put("body", String.class);
return parameters;
}

@Override
public Set<String> requiredParameters() {
final Set<String> req = new HashSet<>();
req.add("code");
return req;
}

@Override
public String defaultParameter() {
// default parameter - name(paramValue) not supported
return null;
}

@Override
public HandlerWrapper build(final Map<String, Object> config) {
final Integer code = (Integer) config.get("code");
final String reason = (String) config.get("reason");
final String type = (String) config.get("type");
final String body = (String) config.get("body");
return new HandlerWrapper() {
@Override
public HttpHandler wrap(HttpHandler handler) {
if (body == null) {
return new ResponseHandler(code, reason);
} else {
if (type == null) {
return new ResponseHandler(code, reason, body);
} else {
return new ResponseHandler(code, reason, body, type);
}
}
}
};
}
}
}
126 changes: 126 additions & 0 deletions core/src/main/java/io/undertow/server/handlers/RewriteHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
/*
* JBoss, Home of Professional Open Source.
* Copyright 2025 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* Licensed 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
*
* 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.undertow.server.handlers;

import java.util.Collections;
import java.util.Map;
import java.util.Set;

import io.undertow.UndertowLogger;
import io.undertow.attribute.ConstantExchangeAttribute;
import io.undertow.attribute.ExchangeAttribute;
import io.undertow.attribute.ExchangeAttributes;
import io.undertow.attribute.ReadOnlyAttributeException;
import io.undertow.server.HandlerWrapper;
import io.undertow.server.HttpHandler;
import io.undertow.server.HttpServerExchange;
import io.undertow.server.handlers.builder.HandlerBuilder;

/**
* @author <a href="mailto:bbaranow@ibm.com">Bartosz Baranowski</a>
* @author Stuart Douglas
*/
public class RewriteHandler extends SetAttributeHandler {

public RewriteHandler(HttpHandler next, ExchangeAttribute value) {
super(next, ExchangeAttributes.relativePath(), value);
}

@Override
public void handleRequest(HttpServerExchange exchange) throws Exception {
UndertowLogger.PREDICATE_LOGGER.debugf("Request rewritten to [%s] for %s.", getValue().readAttribute(exchange),
exchange);
super.handleRequest(exchange);
}

@Override
public String toString() {
return "rewrite( '" + getValue().toString() + "' )";
}

public static class Builder implements HandlerBuilder {

@Override
public String name() {
return "rewrite";
}

@Override
public Map<String, Class<?>> parameters() {
return Collections.<String, Class<?>> singletonMap("value", ExchangeAttribute.class);
}

@Override
public Set<String> requiredParameters() {
return Collections.singleton("value");
}

@Override
public String defaultParameter() {
return "value";
}

@Override
public HandlerWrapper build(final Map<String, Object> config) {
final ExchangeAttribute configValue = (ExchangeAttribute) config.get("value");
ExchangeAttribute tmpValue = null;
if (configValue instanceof ConstantExchangeAttribute) {
tmpValue = new ConstantExchangeAttribute(normalize(configValue.readAttribute(null)));
} else {
tmpValue = new ExchangeAttribute() {

@Override
public String readAttribute(HttpServerExchange exchange) {
return normalize(configValue.readAttribute(exchange));
}

@Override
public void writeAttribute(HttpServerExchange exchange, String newValue) throws ReadOnlyAttributeException {
throw new ReadOnlyAttributeException("constant", newValue);
}

public String toString() {
return "NDA";
};
};
}
final ExchangeAttribute value = tmpValue;

return new HandlerWrapper() {
@Override
public HttpHandler wrap(HttpHandler handler) {
return new RewriteHandler(handler, value);
}

};
}

@Override
public int priority() {
return 0;
}

private String normalize(final String readAttribute) {
if (readAttribute.startsWith("/")) {
return readAttribute;
} else {
return "/" + readAttribute;
}
}
}
}
2 changes: 2 additions & 0 deletions core/src/main/java/io/undertow/server/handlers/builder/ReasonPhraseHandlerBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@

/**
* @author <a href="mailto:bbaranow@redhat.com">Bartosz Baranowski</a>
* @see {@link ReasonPhraseHandler#Builder}
* @Deprecated(since = "2.5.0", forRemoval = true)
*/
public class ReasonPhraseHandlerBuilder implements HandlerBuilder {
@Override
Expand Down
2 changes: 2 additions & 0 deletions core/src/main/java/io/undertow/server/handlers/builder/ResponseCodeHandlerBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@

/**
* @author Stuart Douglas
* @see {@link ResponseCodeHandler#Builder}
* @Deprecated(since = "2.5.0", forRemoval = true)
*/
public class ResponseCodeHandlerBuilder implements HandlerBuilder {
@Override
Expand Down
3 changes: 3 additions & 0 deletions core/src/main/java/io/undertow/server/handlers/builder/ResponseHandlerBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,13 @@

import io.undertow.server.HandlerWrapper;
import io.undertow.server.HttpHandler;
import io.undertow.server.handlers.ResponseCodeHandler;
import io.undertow.server.handlers.ResponseHandler;

/**
* @author <a href="mailto:bbaranow@redhat.com">Bartosz Baranowski</a>
* @see {@link ResponseCodeHandler#Builder}
* @Deprecated(since = "2.5.0", forRemoval = true)
*/
public class ResponseHandlerBuilder implements HandlerBuilder {
@Override
Expand Down
13 changes: 8 additions & 5 deletions core/src/main/java/io/undertow/server/handlers/builder/RewriteHandlerBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,25 @@

package io.undertow.server.handlers.builder;

import java.util.Collections;
import java.util.Map;
import java.util.Set;

import io.undertow.UndertowLogger;
import io.undertow.attribute.ConstantExchangeAttribute;
import io.undertow.attribute.ExchangeAttribute;
import io.undertow.attribute.ExchangeAttributes;
import io.undertow.attribute.ReadOnlyAttributeException;
import io.undertow.server.HandlerWrapper;
import io.undertow.server.HttpHandler;
import io.undertow.server.HttpServerExchange;
import io.undertow.server.handlers.RewriteHandler;
import io.undertow.server.handlers.SetAttributeHandler;
import io.undertow.UndertowLogger;

import java.util.Collections;
import java.util.Map;
import java.util.Set;

/**
* @author Stuart Douglas
* @see {@link RewriteHandler#Builder}
* @Deprecated(since = "2.5.0", forRemoval = true)
*/
public class RewriteHandlerBuilder implements HandlerBuilder {
@Override
Expand Down
Loading
Loading