-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Refactor] XContentType to parse Accept or Content-Type headers (#3077)…
… (#3103) Refactors XContentType.fromMediaTypeOrFormat to fromMediaType so Accept headers and Content-Type headers can be parsed separately. This helps in reusing the same parse logic in for REST Versioning API support. Signed-off-by: Nicholas Walter Knize <[email protected]> (cherry picked from commit d86c88f) Co-authored-by: Nick Knize <[email protected]>
- Loading branch information
1 parent
0e267fe
commit 872dc2f
Showing
13 changed files
with
392 additions
and
98 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
65 changes: 65 additions & 0 deletions
65
libs/x-content/src/main/java/org/opensearch/common/xcontent/MediaType.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,65 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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. | ||
| */ | ||
|
|
||
| /* | ||
| * Modifications Copyright OpenSearch Contributors. See | ||
| * GitHub history for details. | ||
| */ | ||
|
|
||
| package org.opensearch.common.xcontent; | ||
|
|
||
| /** | ||
| * Abstracts a <a href="http://en.wikipedia.org/wiki/Internet_media_type">Media Type</a> and a format parameter. | ||
| * Media types are used as values on Content-Type and Accept headers | ||
| * format is an URL parameter, specifies response media type. | ||
| */ | ||
| public interface MediaType { | ||
| /** | ||
| * Returns a type part of a MediaType | ||
| * i.e. application for application/json | ||
| */ | ||
| String type(); | ||
|
|
||
| /** | ||
| * Returns a subtype part of a MediaType. | ||
| * i.e. json for application/json | ||
| */ | ||
| String subtype(); | ||
|
|
||
| /** | ||
| * Returns a corresponding format for a MediaType. i.e. json for application/json media type | ||
| * Can differ from the MediaType's subtype i.e plain/text has a subtype of text but format is txt | ||
| */ | ||
| String format(); | ||
|
|
||
| /** | ||
| * returns a string representation of a media type. | ||
| */ | ||
| default String typeWithSubtype() { | ||
| return type() + "/" + subtype(); | ||
| } | ||
| } |
135 changes: 135 additions & 0 deletions
135
libs/x-content/src/main/java/org/opensearch/common/xcontent/MediaTypeParser.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,135 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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. | ||
| */ | ||
|
|
||
| /* | ||
| * Modifications Copyright OpenSearch Contributors. See | ||
| * GitHub history for details. | ||
| */ | ||
|
|
||
| package org.opensearch.common.xcontent; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Locale; | ||
| import java.util.Map; | ||
|
|
||
| public class MediaTypeParser<T extends MediaType> { | ||
| private final Map<String, T> formatToMediaType; | ||
| private final Map<String, T> typeWithSubtypeToMediaType; | ||
|
|
||
| public MediaTypeParser(T[] acceptedMediaTypes) { | ||
| this(acceptedMediaTypes, Map.of()); | ||
| } | ||
|
|
||
| public MediaTypeParser(T[] acceptedMediaTypes, Map<String, T> additionalMediaTypes) { | ||
| final int size = acceptedMediaTypes.length + additionalMediaTypes.size(); | ||
| Map<String, T> formatMap = new HashMap<>(size); | ||
| Map<String, T> typeMap = new HashMap<>(size); | ||
| for (T mediaType : acceptedMediaTypes) { | ||
| typeMap.put(mediaType.typeWithSubtype(), mediaType); | ||
| formatMap.put(mediaType.format(), mediaType); | ||
| } | ||
| for (Map.Entry<String, T> entry : additionalMediaTypes.entrySet()) { | ||
| String typeWithSubtype = entry.getKey(); | ||
| T mediaType = entry.getValue(); | ||
|
|
||
| typeMap.put(typeWithSubtype.toLowerCase(Locale.ROOT), mediaType); | ||
| formatMap.put(mediaType.format(), mediaType); | ||
| } | ||
|
|
||
| this.formatToMediaType = Map.copyOf(formatMap); | ||
| this.typeWithSubtypeToMediaType = Map.copyOf(typeMap); | ||
| } | ||
|
|
||
| public T fromMediaType(String mediaType) { | ||
| ParsedMediaType parsedMediaType = parseMediaType(mediaType); | ||
| return parsedMediaType != null ? parsedMediaType.getMediaType() : null; | ||
| } | ||
|
|
||
| public T fromFormat(String format) { | ||
| if (format == null) { | ||
| return null; | ||
| } | ||
| return formatToMediaType.get(format.toLowerCase(Locale.ROOT)); | ||
| } | ||
|
|
||
| /** | ||
| * parsing media type that follows https://tools.ietf.org/html/rfc7231#section-3.1.1.1 | ||
| * @param headerValue a header value from Accept or Content-Type | ||
| * @return a parsed media-type | ||
| */ | ||
| public ParsedMediaType parseMediaType(String headerValue) { | ||
| if (headerValue != null) { | ||
| String[] split = headerValue.toLowerCase(Locale.ROOT).split(";"); | ||
|
|
||
| String[] typeSubtype = split[0].trim().split("/"); | ||
| if (typeSubtype.length == 2) { | ||
| String type = typeSubtype[0]; | ||
| String subtype = typeSubtype[1]; | ||
| T xContentType = typeWithSubtypeToMediaType.get(type + "/" + subtype); | ||
| if (xContentType != null) { | ||
| Map<String, String> parameters = new HashMap<>(); | ||
| for (int i = 1; i < split.length; i++) { | ||
| // spaces are allowed between parameters, but not between '=' sign | ||
| String[] keyValueParam = split[i].trim().split("="); | ||
| if (keyValueParam.length != 2 || hasSpaces(keyValueParam[0]) || hasSpaces(keyValueParam[1])) { | ||
| return null; | ||
| } | ||
| parameters.put(keyValueParam[0], keyValueParam[1]); | ||
| } | ||
| return new ParsedMediaType(xContentType, parameters); | ||
| } | ||
| } | ||
|
|
||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private boolean hasSpaces(String s) { | ||
| return s.trim().equals(s) == false; | ||
| } | ||
|
|
||
| /** | ||
| * A media type object that contains all the information provided on a Content-Type or Accept header | ||
| */ | ||
| public class ParsedMediaType { | ||
| private final Map<String, String> parameters; | ||
| private final T mediaType; | ||
|
|
||
| public ParsedMediaType(T mediaType, Map<String, String> parameters) { | ||
| this.parameters = parameters; | ||
| this.mediaType = mediaType; | ||
| } | ||
|
|
||
| public T getMediaType() { | ||
| return mediaType; | ||
| } | ||
|
|
||
| public Map<String, String> getParameters() { | ||
| return parameters; | ||
| } | ||
| } | ||
| } |
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.