Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010 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 com.amazonaws.http;
 
 import java.util.Map;
 
 
 
Default implementation of HttpResponseHandler that handles a successful response from an AWS service and unmarshalls the result using a StAX unmarshaller.

Parameters:
<T> Indicates the type being unmarshalled by this response handler.
 
 public class StaxResponseHandler<T> implements HttpResponseHandler<AmazonWebServiceResponse<T>> {

    
The StAX unmarshaller to use when handling the response
 
Shared logger for profiling information
 
     private static final Log log = LogFactory.getLog("com.amazonaws.request");

    
Shared factory for creating XML event readers
 
     private static XMLInputFactory xmlInputFactory = XMLInputFactory.newInstance();
 
     static {
        
It's important that character event coalescing is enabled so that when we pull character data out of an element, we get all of it in one event and don't miss any. Without coalescing turned on, some values (ex: newlines) can cause the data to be split into multiple character events.
 
     }


    
Constructs a new response handler that will use the specified StAX unmarshaller to unmarshall the service response and uses the specified response element path to find the root of the business data in the service's response.

Parameters:
responseUnmarshaller The StAX unmarshaller to use on the response.
 
     public StaxResponseHandler(Unmarshaller<T, StaxUnmarshallerContextresponseUnmarshaller) {
         this. = responseUnmarshaller;
 
         /*
          * Even if the invoked operation just returns null, we still need an
          * unmarshaller to run so we can pull out response metadata.
          *
          * We might want to pass this in through the client class so that we
          * don't have to do this check here.
          */
         if (this. == null) {
             this. = new VoidStaxUnmarshaller<T>();
         }
     }


    
 
     public AmazonWebServiceResponse<T> handle(HttpResponse responsethrows Exception {
         .trace("Parsing service response XML");
         XMLEventReader eventReader = .createXMLEventReader(response.getContent());
         try {
             AmazonWebServiceResponse<T> awsResponse = new AmazonWebServiceResponse<T>();
             StaxUnmarshallerContext unmarshallerContext = new StaxUnmarshallerContext(eventReader);
             unmarshallerContext.registerMetadataExpression("ResponseMetadata/RequestId", 2, .);
             unmarshallerContext.registerMetadataExpression("requestId", 2, .);
             registerAdditionalMetadataExpressions(unmarshallerContext);
 
            T result = .unmarshall(unmarshallerContext);
            awsResponse.setResult(result);
            Map<StringStringmetadata = unmarshallerContext.getMetadata();
            awsResponse.setResponseMetadata(new ResponseMetadata(metadata));
            .trace("Done parsing service response");
            return awsResponse;
        } finally {
            try {eventReader.close();} catch (Exception e) {}
        }
    }

    
Hook for subclasses to override in order to collect additional metadata from service responses.

Parameters:
unmarshallerContext The unmarshaller context used to process a service's response data.
    protected void registerAdditionalMetadataExpressions(StaxUnmarshallerContext unmarshallerContext) {}

    
Since this response handler completely consumes all the data from the underlying HTTP connection during the handle method, we don't need to keep the HTTP connection open.

    public boolean needsConnectionLeftOpen() {
        return false;
    }
New to GrepCode? Check out our FAQ X