-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Decouple more classes from XContentBuilder and make builder strict (#…
…29197) This commit decouples `BytesRef`, `Releaseable`, and `TimeValue` from XContentBuilder, and paves the way for doupling `ByteSizeValue` as well. It moves much of the Lucene and Joda encoding into a new SPI extension that is loaded by XContentBuilder to know how to encode these values. Part of doing this also allows us to make JSON encoding strict, as we no longer allow just any old object to be passed (in the past it was possible to get json that was `"field": "java.lang.Object@d8355a8"` if no one was careful about what was passed in). Relates to #28504
- Loading branch information
Showing
18 changed files
with
171 additions
and
65 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
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
78 changes: 78 additions & 0 deletions
78
server/src/main/java/org/elasticsearch/common/xcontent/XContentElasticsearchExtension.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,78 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package org.elasticsearch.common.xcontent; | ||
|
|
||
| import org.apache.lucene.util.BytesRef; | ||
| import org.elasticsearch.common.bytes.BytesReference; | ||
| import org.elasticsearch.common.unit.ByteSizeValue; | ||
| import org.elasticsearch.common.unit.TimeValue; | ||
| import org.joda.time.DateTimeZone; | ||
| import org.joda.time.tz.CachedDateTimeZone; | ||
| import org.joda.time.tz.FixedDateTimeZone; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
|
|
||
| /** | ||
| * SPI extensions for Elasticsearch-specific classes (like the Lucene or Joda | ||
| * dependency classes) that need to be encoded by {@link XContentBuilder} in a | ||
| * specific way. | ||
| */ | ||
| public class XContentElasticsearchExtension implements XContentBuilderExtension { | ||
|
|
||
| @Override | ||
| public Map<Class<?>, XContentBuilder.Writer> getXContentWriters() { | ||
| Map<Class<?>, XContentBuilder.Writer> writers = new HashMap<>(); | ||
|
|
||
| // Fully-qualified here to reduce ambiguity around our (ES') Version class | ||
| writers.put(org.apache.lucene.util.Version.class, (b, v) -> b.value(Objects.toString(v))); | ||
| writers.put(DateTimeZone.class, (b, v) -> b.value(Objects.toString(v))); | ||
| writers.put(CachedDateTimeZone.class, (b, v) -> b.value(Objects.toString(v))); | ||
| writers.put(FixedDateTimeZone.class, (b, v) -> b.value(Objects.toString(v))); | ||
|
|
||
| writers.put(BytesReference.class, (b, v) -> { | ||
| if (v == null) { | ||
| b.nullValue(); | ||
| } else { | ||
| BytesRef bytes = ((BytesReference) v).toBytesRef(); | ||
| b.value(bytes.bytes, bytes.offset, bytes.length); | ||
| } | ||
| }); | ||
|
|
||
| writers.put(BytesRef.class, (b, v) -> { | ||
| if (v == null) { | ||
| b.nullValue(); | ||
| } else { | ||
| BytesRef bytes = (BytesRef) v; | ||
| b.value(bytes.bytes, bytes.offset, bytes.length); | ||
| } | ||
| }); | ||
| return writers; | ||
| } | ||
|
|
||
| @Override | ||
| public Map<Class<?>, XContentBuilder.HumanReadableTransformer> getXContentHumanReadableTransformers() { | ||
| Map<Class<?>, XContentBuilder.HumanReadableTransformer> transformers = new HashMap<>(); | ||
| transformers.put(TimeValue.class, v -> ((TimeValue) v).millis()); | ||
| transformers.put(ByteSizeValue.class, v -> ((ByteSizeValue) v).getBytes()); | ||
| return transformers; | ||
| } | ||
| } |
Oops, something went wrong.