Saikred/feature/output handling #3293
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,117 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.imds; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import software.amazon.awssdk.annotations.SdkPublicApi; | ||
| import software.amazon.awssdk.core.document.Document; | ||
| import software.amazon.awssdk.protocols.json.internal.unmarshall.document.DocumentUnmarshaller; | ||
| import software.amazon.awssdk.protocols.jsoncore.JsonNode; | ||
| import software.amazon.awssdk.protocols.jsoncore.JsonNodeParser; | ||
| import software.amazon.awssdk.utils.Validate; | ||
|
|
||
| /** | ||
| * The class is used for Response Handling and Parsing the metadata fetched by the get call in the {@link Ec2Metadata} interface. | ||
| * The class provides convenience methods to the users to parse the metadata as a String, List and Document. | ||
| */ | ||
| @SdkPublicApi | ||
| public class MetadataResponse { | ||
|
|
||
| private static final Logger log = LoggerFactory.getLogger(MetadataResponse.class); | ||
|
|
||
| private static final JsonNodeParser JSON_NODE_PARSER = JsonNode.parserBuilder().removeErrorLocations(true).build(); | ||
|
|
||
| private final String body; | ||
|
|
||
| public MetadataResponse(String body) { | ||
| this.body = Validate.notNull(body, "Metadata is null"); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the Metadata Response body as a String. This method can be used for parsing the retrieved | ||
| * singular metadata from IMDS. | ||
| * | ||
| * @return String Representation of the Metadata Response Body. | ||
| * | ||
| * <p> | ||
| * Example: | ||
| * <pre> | ||
| * {@code | ||
| * | ||
| * Ec2Metadata ec2Metadata = Ec2Metadata.create(); | ||
| * MetadataResponse metadataResponse = client.get("/latest/meta-data/ami-id"); | ||
| * String response = metadataResponse.asString(); | ||
| * } | ||
| * </pre> | ||
| */ | ||
| public String asString() { | ||
| return body; | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Parses the response String into a list of Strings split by delimiter ("\n"). This method can be used for parsing the | ||
| * list-type metadata from IMDS. | ||
| * | ||
| * @return List Representation of the Metadata Response Body. | ||
| * | ||
| * <p> | ||
| * Example: | ||
| * <pre> | ||
| * {@code | ||
| * | ||
| * Ec2Metadata ec2Metadata = Ec2Metadata.create(); | ||
| * MetadataResponse metadataResponse = client.get("/latest/meta-data/ancestor-ami-ids"); | ||
| * List<String>response = metadataResponse.asList(); | ||
| * } | ||
| * </pre> | ||
| */ | ||
| public List<String> asList() { | ||
| return Arrays.asList(body.split("\n")); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Parses the response String into {@link Document} type. This method can be used for | ||
| * parsing the metadata in a String Json Format. | ||
| * | ||
| * @return Document Representation of the Metadata Response Body. | ||
| * @throws IOException in case parsing does not happen correctly. | ||
| * | ||
| * <p> | ||
| * Example: | ||
| * <pre> | ||
| * {@code | ||
| * | ||
| * Ec2Metadata ec2Metadata = Ec2Metadata.create(); | ||
| * MetadataResponse metadataResponse = client.get("/latest/dynamic/instance-identity/document"); | ||
| * Document document = metadataResponse.asDocument(); | ||
| * } | ||
| * </pre> | ||
| */ | ||
|
|
||
| public Document asDocument() throws IOException { | ||
|
|
||
| JsonNode node = JSON_NODE_PARSER.parse(body); | ||
| return node.visit(new DocumentUnmarshaller()); | ||
| } | ||
|
|
||
|
|
||
| } |
This file contains hidden or 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 hidden or 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.
We should put something in the backlog to avoid needing this dependency at GA. I know it was needed for the DocumentMarshaller, but I think it's relatively small and we could copy it to avoid the dependency.