-
Notifications
You must be signed in to change notification settings - Fork 926
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Motivation:
Allow users to set default options for a specific service
Modifications:
- Add `ServiceOptions` and `@ServiceOption` annotation to allow users
specify default options
Result:
Users are able to set service specific options like below
```java
final HttpService httpService = new HttpService() {
...
@OverRide
public ServiceOptions options() {
return defaultServiceOptions;
}
};
```
or use annotation
```java
final class MyService {
@ServiceOption(requestTimeoutMillis = 11111, maxRequestLength = 1111,
requestAutoAbortDelayMillis = 111)
@get("/test1")
public HttpResponse test() {
return HttpResponse.of("OK");
}
...
}
```
- Closes <#5071>. (If this
resolves the issue.)
<!--
Visit this URL to learn more about how to write a pull request
description:
https://armeria.dev/community/developer-guide#how-to-write-pull-request-description
-->
---------
Co-authored-by: minux <[email protected]>
Co-authored-by: jrhee17 <[email protected]>
Co-authored-by: Ikhun Um <[email protected]>
Co-authored-by: Ikhun Um <[email protected]>
Co-authored-by: minux <[email protected]>- Loading branch information
6 people
authored
Jun 10, 2024
1 parent
b6c4d73
commit 395fc27
Showing
18 changed files
with
772 additions
and
61 deletions.
There are no files selected for viewing
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
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
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
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
49 changes: 49 additions & 0 deletions
49
core/src/main/java/com/linecorp/armeria/server/ServiceOption.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,49 @@ | ||
| /* | ||
| * Copyright 2024 LINE Corporation | ||
| * | ||
| * LINE Corporation 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: | ||
| * | ||
| * https://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 com.linecorp.armeria.server; | ||
|
|
||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| import com.linecorp.armeria.common.HttpRequest; | ||
| import com.linecorp.armeria.common.HttpResponse; | ||
|
|
||
| /** | ||
| * An annotation used to configure {@link ServiceOptions} of an {@link HttpService}. | ||
| */ | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| @Target({ ElementType.METHOD, ElementType.TYPE }) | ||
| public @interface ServiceOption { | ||
|
|
||
| /** | ||
| * Server-side timeout of a request in milliseconds. | ||
| */ | ||
| long requestTimeoutMillis() default -1; | ||
|
|
||
| /** | ||
| * Server-side maximum length of a request. | ||
| */ | ||
| long maxRequestLength() default -1; | ||
|
|
||
| /** | ||
| * The amount of time to wait before aborting an {@link HttpRequest} when its corresponding | ||
| * {@link HttpResponse} is complete. | ||
| */ | ||
| long requestAutoAbortDelayMillis() default -1; | ||
| } |
111 changes: 111 additions & 0 deletions
111
core/src/main/java/com/linecorp/armeria/server/ServiceOptions.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,111 @@ | ||
| /* | ||
| * Copyright 2024 LINE Corporation | ||
| * | ||
| * LINE Corporation 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: | ||
| * | ||
| * https://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 com.linecorp.armeria.server; | ||
|
|
||
| import java.util.Objects; | ||
|
|
||
| import com.google.common.base.MoreObjects; | ||
|
|
||
| import com.linecorp.armeria.common.HttpRequest; | ||
| import com.linecorp.armeria.common.HttpResponse; | ||
| import com.linecorp.armeria.common.annotation.UnstableApi; | ||
|
|
||
| /** | ||
| * Options for configuring an {@link HttpService}. | ||
| * You can override the default options by implementing {@link HttpService#options()}. | ||
| */ | ||
| @UnstableApi | ||
| public final class ServiceOptions { | ||
| private static final ServiceOptions DEFAULT_OPTIONS = builder().build(); | ||
|
|
||
| /** | ||
| * Returns the default {@link ServiceOptions}. | ||
| */ | ||
| public static ServiceOptions of() { | ||
| return DEFAULT_OPTIONS; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a new {@link ServiceOptionsBuilder}. | ||
| */ | ||
| public static ServiceOptionsBuilder builder() { | ||
| return new ServiceOptionsBuilder(); | ||
| } | ||
|
|
||
| private final long requestTimeoutMillis; | ||
| private final long maxRequestLength; | ||
| private final long requestAutoAbortDelayMillis; | ||
|
|
||
| ServiceOptions(long requestTimeoutMillis, long maxRequestLength, long requestAutoAbortDelayMillis) { | ||
| this.requestTimeoutMillis = requestTimeoutMillis; | ||
| this.maxRequestLength = maxRequestLength; | ||
| this.requestAutoAbortDelayMillis = requestAutoAbortDelayMillis; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the server-side timeout of a request in milliseconds. {@code -1} if not set. | ||
| */ | ||
| public long requestTimeoutMillis() { | ||
| return requestTimeoutMillis; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the server-side maximum length of a request. {@code -1} if not set. | ||
| */ | ||
| public long maxRequestLength() { | ||
| return maxRequestLength; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the amount of time to wait before aborting an {@link HttpRequest} when its corresponding | ||
| * {@link HttpResponse} is complete. {@code -1} if not set. | ||
| */ | ||
| public long requestAutoAbortDelayMillis() { | ||
| return requestAutoAbortDelayMillis; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (o == null || getClass() != o.getClass()) { | ||
| return false; | ||
| } | ||
|
|
||
| final ServiceOptions that = (ServiceOptions) o; | ||
|
|
||
| return requestTimeoutMillis == that.requestTimeoutMillis && | ||
| maxRequestLength == that.maxRequestLength && | ||
| requestAutoAbortDelayMillis == that.requestAutoAbortDelayMillis; | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(requestTimeoutMillis, maxRequestLength, requestAutoAbortDelayMillis); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return MoreObjects.toStringHelper(this) | ||
| .add("requestTimeoutMillis", requestTimeoutMillis) | ||
| .add("maxRequestLength", maxRequestLength) | ||
| .add("requestAutoAbortDelayMillis", requestAutoAbortDelayMillis) | ||
| .toString(); | ||
| } | ||
| } | ||
|
|
Oops, something went wrong.