com.amazonaws.services.s3.model.transform

Class XmlResponsesSaxParser

java.lang.Object

com.amazonaws.services.s3.model.transform.XmlResponsesSaxParser

public class XmlResponsesSaxParser
extends Object

XML Sax parser to read XML documents returned by S3 via the REST interface, converting these documents into objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	XmlResponsesSaxParser.AccessControlListHandler Handler for AccessControlList response XML documents.
class	XmlResponsesSaxParser.BucketCrossOriginConfigurationHandler
class	XmlResponsesSaxParser.BucketLifecycleConfigurationHandler
class	XmlResponsesSaxParser.BucketLocationHandler Handler for CreateBucketConfiguration response XML documents for a bucket.
class	XmlResponsesSaxParser.BucketLoggingConfigurationHandler Handler for LoggingStatus response XML documents for a bucket.
class	XmlResponsesSaxParser.BucketNotificationConfigurationHandler
class	XmlResponsesSaxParser.BucketTaggingConfigurationHandler
class	XmlResponsesSaxParser.BucketVersioningConfigurationHandler
class	XmlResponsesSaxParser.BucketWebsiteConfigurationHandler
class	XmlResponsesSaxParser.CompleteMultipartUploadHandler
class	XmlResponsesSaxParser.CopyObjectResultHandler
class	XmlResponsesSaxParser.DeleteObjectsHandler
class	XmlResponsesSaxParser.InitiateMultipartUploadHandler
class	XmlResponsesSaxParser.ListAllMyBucketsHandler Handler for ListAllMyBuckets response XML documents.
class	XmlResponsesSaxParser.ListBucketHandler Handler for ListBucket response XML documents.
class	XmlResponsesSaxParser.ListMultipartUploadsHandler
class	XmlResponsesSaxParser.ListPartsHandler
class	XmlResponsesSaxParser.ListVersionsHandler Handler for ListVersionsResult XML document.
class	XmlResponsesSaxParser.RequestPaymentConfigurationHandler Handler for RequestPaymentConfiguration response XML documents for a bucket.

Constructor Summary

Constructors

Constructor and Description
XmlResponsesSaxParser() Constructs the XML SAX parser.

Method Summary

Modifier and Type	Method and Description
XmlResponsesSaxParser.AccessControlListHandler	parseAccessControlListResponse(InputStream inputStream) Parses an AccessControlListHandler response XML document from an input stream.
XmlResponsesSaxParser.BucketCrossOriginConfigurationHandler	parseBucketCrossOriginConfigurationResponse(InputStream inputStream)
XmlResponsesSaxParser.BucketLifecycleConfigurationHandler	parseBucketLifecycleConfigurationResponse(InputStream inputStream)
String	parseBucketLocationResponse(InputStream inputStream)
XmlResponsesSaxParser.CompleteMultipartUploadHandler	parseCompleteMultipartUploadResponse(InputStream inputStream)
XmlResponsesSaxParser.CopyObjectResultHandler	parseCopyObjectResponse(InputStream inputStream)
XmlResponsesSaxParser.DeleteObjectsHandler	parseDeletedObjectsResult(InputStream inputStream)
XmlResponsesSaxParser.InitiateMultipartUploadHandler	parseInitiateMultipartUploadResponse(InputStream inputStream)
XmlResponsesSaxParser.ListBucketHandler	parseListBucketObjectsResponse(InputStream inputStream) Parses a ListBucket response XML document from an input stream.
XmlResponsesSaxParser.ListMultipartUploadsHandler	parseListMultipartUploadsResponse(InputStream inputStream)
XmlResponsesSaxParser.ListAllMyBucketsHandler	parseListMyBucketsResponse(InputStream inputStream) Parses a ListAllMyBuckets response XML document from an input stream.
XmlResponsesSaxParser.ListPartsHandler	parseListPartsResponse(InputStream inputStream)
XmlResponsesSaxParser.ListVersionsHandler	parseListVersionsResponse(InputStream inputStream) Parses a ListVersions response XML document from an input stream.
XmlResponsesSaxParser.BucketLoggingConfigurationHandler	parseLoggingStatusResponse(InputStream inputStream) Parses a LoggingStatus response XML document for a bucket from an input stream.
XmlResponsesSaxParser.BucketNotificationConfigurationHandler	parseNotificationConfigurationResponse(InputStream inputStream)
boolean	parseRequestPaymentConfigurationResponse(InputStream inputStream)
XmlResponsesSaxParser.BucketTaggingConfigurationHandler	parseTaggingConfigurationResponse(InputStream inputStream)
XmlResponsesSaxParser.BucketVersioningConfigurationHandler	parseVersioningConfigurationResponse(InputStream inputStream)
XmlResponsesSaxParser.BucketWebsiteConfigurationHandler	parseWebsiteConfigurationResponse(InputStream inputStream)
protected void	parseXmlInputStream(org.xml.sax.helpers.DefaultHandler handler, InputStream inputStream) Parses an XML document from an input stream using a document handler.
protected InputStream	sanitizeXmlDocument(org.xml.sax.helpers.DefaultHandler handler, InputStream inputStream)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlResponsesSaxParser

public XmlResponsesSaxParser()
                      throws AmazonClientException

Constructs the XML SAX parser.

Throws:

AmazonClientException

Method Detail

parseXmlInputStream

protected void parseXmlInputStream(org.xml.sax.helpers.DefaultHandler handler,
                                   InputStream inputStream)
                            throws AmazonClientException

Parses an XML document from an input stream using a document handler.

Parameters:

handler - the handler for the XML document

inputStream - an input stream containing the XML document to parse

Throws:

AmazonClientException - any parsing, IO or other exceptions are wrapped in an S3ServiceException.

sanitizeXmlDocument

protected InputStream sanitizeXmlDocument(org.xml.sax.helpers.DefaultHandler handler,
                                          InputStream inputStream)
                                   throws AmazonClientException

Throws:

AmazonClientException

parseListBucketObjectsResponse

public XmlResponsesSaxParser.ListBucketHandler parseListBucketObjectsResponse(InputStream inputStream)
                                                                       throws AmazonClientException

Parses a ListBucket response XML document from an input stream.

Parameters:

inputStream - XML data input stream.

Returns:

the XML handler object populated with data parsed from the XML stream.

Throws:

AmazonClientException

parseListVersionsResponse

public XmlResponsesSaxParser.ListVersionsHandler parseListVersionsResponse(InputStream inputStream)
                                                                    throws AmazonClientException

Parses a ListVersions response XML document from an input stream.

Parameters:

inputStream - XML data input stream.

Returns:

the XML handler object populated with data parsed from the XML stream.

Throws:

AmazonClientException

parseListMyBucketsResponse

public XmlResponsesSaxParser.ListAllMyBucketsHandler parseListMyBucketsResponse(InputStream inputStream)
                                                                         throws AmazonClientException

Parses a ListAllMyBuckets response XML document from an input stream.

Parameters:

inputStream - XML data input stream.

Returns:

the XML handler object populated with data parsed from the XML stream.

Throws:

AmazonClientException

parseAccessControlListResponse

public XmlResponsesSaxParser.AccessControlListHandler parseAccessControlListResponse(InputStream inputStream)
                                                                              throws AmazonClientException

Parses an AccessControlListHandler response XML document from an input stream.

Parameters:

inputStream - XML data input stream.

Returns:

the XML handler object populated with data parsed from the XML stream.

Throws:

AmazonClientException

parseLoggingStatusResponse

public XmlResponsesSaxParser.BucketLoggingConfigurationHandler parseLoggingStatusResponse(InputStream inputStream)
                                                                                   throws AmazonClientException

Parses a LoggingStatus response XML document for a bucket from an input stream.

Parameters:

inputStream - XML data input stream.

Returns:

the XML handler object populated with data parsed from the XML stream.

Throws:

AmazonClientException

parseBucketLifecycleConfigurationResponse

public XmlResponsesSaxParser.BucketLifecycleConfigurationHandler parseBucketLifecycleConfigurationResponse(InputStream inputStream)

parseBucketCrossOriginConfigurationResponse

public XmlResponsesSaxParser.BucketCrossOriginConfigurationHandler parseBucketCrossOriginConfigurationResponse(InputStream inputStream)

parseBucketLocationResponse

public String parseBucketLocationResponse(InputStream inputStream)
                                   throws AmazonClientException

Throws:

AmazonClientException

parseVersioningConfigurationResponse

public XmlResponsesSaxParser.BucketVersioningConfigurationHandler parseVersioningConfigurationResponse(InputStream inputStream)
                                                                                                throws AmazonClientException

Throws:

AmazonClientException

parseWebsiteConfigurationResponse

public XmlResponsesSaxParser.BucketWebsiteConfigurationHandler parseWebsiteConfigurationResponse(InputStream inputStream)
                                                                                          throws AmazonClientException

Throws:

AmazonClientException

parseNotificationConfigurationResponse

public XmlResponsesSaxParser.BucketNotificationConfigurationHandler parseNotificationConfigurationResponse(InputStream inputStream)
                                                                                                    throws AmazonClientException

Throws:

AmazonClientException

parseTaggingConfigurationResponse

public XmlResponsesSaxParser.BucketTaggingConfigurationHandler parseTaggingConfigurationResponse(InputStream inputStream)
                                                                                          throws AmazonClientException

Throws:

AmazonClientException

parseDeletedObjectsResult

public XmlResponsesSaxParser.DeleteObjectsHandler parseDeletedObjectsResult(InputStream inputStream)

parseCopyObjectResponse

public XmlResponsesSaxParser.CopyObjectResultHandler parseCopyObjectResponse(InputStream inputStream)
                                                                      throws AmazonClientException

Throws:

AmazonClientException

parseCompleteMultipartUploadResponse

public XmlResponsesSaxParser.CompleteMultipartUploadHandler parseCompleteMultipartUploadResponse(InputStream inputStream)
                                                                                          throws AmazonClientException

Throws:

AmazonClientException

parseInitiateMultipartUploadResponse

public XmlResponsesSaxParser.InitiateMultipartUploadHandler parseInitiateMultipartUploadResponse(InputStream inputStream)
                                                                                          throws AmazonClientException

Throws:

AmazonClientException

parseListMultipartUploadsResponse

public XmlResponsesSaxParser.ListMultipartUploadsHandler parseListMultipartUploadsResponse(InputStream inputStream)
                                                                                    throws AmazonClientException

Throws:

AmazonClientException

parseListPartsResponse

public XmlResponsesSaxParser.ListPartsHandler parseListPartsResponse(InputStream inputStream)
                                                              throws AmazonClientException

Throws:

AmazonClientException

parseRequestPaymentConfigurationResponse

public boolean parseRequestPaymentConfigurationResponse(InputStream inputStream)
                                                 throws AmazonClientException

Parameters:

inputStream -

Returns:

true if the bucket's is configured as Requester Pays, false if it is configured as Owner pays.

Throws:

AmazonClientException