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.
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
Revamp InboundHttp2ToHttpAdapter builder API #4582
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
132 changes: 132 additions & 0 deletions
132
.../src/main/java/io/netty/handler/codec/http2/AbstractInboundHttp2ToHttpAdapterBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| /* | ||
| * Copyright 2015 The Netty Project | ||
| * | ||
| * The Netty Project licenses this file to you 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.netty.handler.codec.http2; | ||
|
|
||
| import io.netty.handler.codec.TooLongFrameException; | ||
|
|
||
| /** | ||
| * A skeletal builder implementation of {@link InboundHttp2ToHttpAdapter} and its subtypes. | ||
| */ | ||
| public abstract class AbstractInboundHttp2ToHttpAdapterBuilder< | ||
| T extends InboundHttp2ToHttpAdapter, B extends AbstractInboundHttp2ToHttpAdapterBuilder<T, B>> { | ||
|
|
||
| private final Http2Connection connection; | ||
| private int maxContentLength; | ||
| private boolean validateHttpHeaders; | ||
| private boolean propagateSettings; | ||
|
|
||
| /** | ||
| * Creates a new {@link InboundHttp2ToHttpAdapter} builder for the specified {@link Http2Connection}. | ||
| * | ||
| * @param connection the object which will provide connection notification events | ||
| * for the current connection | ||
| */ | ||
| protected AbstractInboundHttp2ToHttpAdapterBuilder(Http2Connection connection) { | ||
| this.connection = connection; | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| protected final B self() { | ||
| return (B) this; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the {@link Http2Connection}. | ||
| */ | ||
| protected Http2Connection connection() { | ||
| return connection; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the maximum length of the message content. | ||
| */ | ||
| protected int maxContentLength() { | ||
| return maxContentLength; | ||
| } | ||
|
|
||
| /** | ||
| * Specifies the maximum length of the message content. | ||
| * | ||
| * @param maxContentLength the maximum length of the message content. If the length of the message content | ||
| * exceeds this value, a {@link TooLongFrameException} will be raised | ||
| * @return {@link AbstractInboundHttp2ToHttpAdapterBuilder} the builder for the {@link InboundHttp2ToHttpAdapter} | ||
| */ | ||
| protected B maxContentLength(int maxContentLength) { | ||
| this.maxContentLength = maxContentLength; | ||
| return self(); | ||
| } | ||
|
|
||
| /** | ||
| * Return {@code true} if HTTP header validation should be performed. | ||
| */ | ||
| protected boolean isValidateHttpHeaders() { | ||
| return validateHttpHeaders; | ||
| } | ||
|
|
||
| /** | ||
| * Specifies whether validation of HTTP headers should be performed. | ||
| * | ||
| * @param validate | ||
| * <ul> | ||
| * <li>{@code true} to validate HTTP headers in the http-codec</li> | ||
| * <li>{@code false} not to validate HTTP headers in the http-codec</li> | ||
| * </ul> | ||
| * @return {@link AbstractInboundHttp2ToHttpAdapterBuilder} the builder for the {@link InboundHttp2ToHttpAdapter} | ||
| */ | ||
| protected B validateHttpHeaders(boolean validate) { | ||
| validateHttpHeaders = validate; | ||
| return self(); | ||
| } | ||
|
|
||
| /** | ||
| * Returns {@code true} if a read settings frame should be propagated along the channel pipeline. | ||
| */ | ||
| protected boolean isPropagateSettings() { | ||
| return propagateSettings; | ||
| } | ||
|
|
||
| /** | ||
| * Specifies whether a read settings frame should be propagated along the channel pipeline. | ||
| * | ||
| * @param propagate if {@code true} read settings will be passed along the pipeline. This can be useful | ||
| * to clients that need hold off sending data until they have received the settings. | ||
| * @return {@link AbstractInboundHttp2ToHttpAdapterBuilder} the builder for the {@link InboundHttp2ToHttpAdapter} | ||
| */ | ||
| protected B propagateSettings(boolean propagate) { | ||
| propagateSettings = propagate; | ||
| return self(); | ||
| } | ||
|
|
||
| /** | ||
| * Builds/creates a new {@link InboundHttp2ToHttpAdapter} instance using this builder's current settings. | ||
| */ | ||
| protected T build() { | ||
| final T instance; | ||
| try { | ||
| instance = build(connection(), maxContentLength(), | ||
| isValidateHttpHeaders(), isPropagateSettings()); | ||
| } catch (Throwable t) { | ||
| throw new IllegalStateException("failed to create a new InboundHttp2ToHttpAdapter", t); | ||
| } | ||
| connection.addListener(instance); | ||
| return instance; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new {@link InboundHttp2ToHttpAdapter} with the specified properties. | ||
| */ | ||
| protected abstract T build(Http2Connection connection, int maxContentLength, | ||
| boolean validateHttpHeaders, boolean propagateSettings) throws Exception; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
codec-http2/src/main/java/io/netty/handler/codec/http2/InboundHttp2ToHttpAdapterBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /* | ||
| * Copyright 2015 The Netty Project | ||
| * | ||
| * The Netty Project licenses this file to you 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.netty.handler.codec.http2; | ||
|
|
||
| /** | ||
| * Builds an {@link InboundHttp2ToHttpAdapter}. | ||
| */ | ||
| public final class InboundHttp2ToHttpAdapterBuilder | ||
| extends AbstractInboundHttp2ToHttpAdapterBuilder<InboundHttp2ToHttpAdapter, InboundHttp2ToHttpAdapterBuilder> { | ||
|
|
||
| /** | ||
| * Creates a new {@link InboundHttp2ToHttpAdapter} builder for the specified {@link Http2Connection}. | ||
| * | ||
| * @param connection the object which will provide connection notification events | ||
| * for the current connection | ||
| */ | ||
| public InboundHttp2ToHttpAdapterBuilder(Http2Connection connection) { | ||
| super(connection); | ||
| } | ||
|
|
||
| @Override | ||
| public InboundHttp2ToHttpAdapterBuilder maxContentLength(int maxContentLength) { | ||
| return super.maxContentLength(maxContentLength); | ||
| } | ||
|
|
||
| @Override | ||
| public InboundHttp2ToHttpAdapterBuilder validateHttpHeaders(boolean validate) { | ||
| return super.validateHttpHeaders(validate); | ||
| } | ||
|
|
||
| @Override | ||
| public InboundHttp2ToHttpAdapterBuilder propagateSettings(boolean propagate) { | ||
| return super.propagateSettings(propagate); | ||
| } | ||
|
|
||
| @Override | ||
| public InboundHttp2ToHttpAdapter build() { | ||
| return super.build(); | ||
| } | ||
|
|
||
| @Override | ||
| protected InboundHttp2ToHttpAdapter build(Http2Connection connection, | ||
| int maxContentLength, | ||
| boolean validateHttpHeaders, | ||
| boolean propagateSettings) throws Exception { | ||
|
|
||
| return new InboundHttp2ToHttpAdapter(connection, maxContentLength, | ||
| validateHttpHeaders, propagateSettings); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
check for null as this should never be null.