org.jets3t.service.impl.rest

Class XmlResponsesSaxParser.ListBucketHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.jets3t.service.impl.rest.DefaultXmlHandler

org.jets3t.service.impl.rest.XmlResponsesSaxParser.ListBucketHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

Enclosing class:

XmlResponsesSaxParser

public class XmlResponsesSaxParser.ListBucketHandler
extends DefaultXmlHandler

Handler for ListBucket response XML documents. The document is parsed into S3Objects available via the getObjects() method.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	bucketName
private java.util.List<java.lang.String>	commonPrefixes
private StorageObject	currentObject
private StorageOwner	currentOwner
private boolean	insideCommonPrefixes
private java.lang.String	lastKey
private boolean	listingTruncated
private java.lang.String	nextMarker
private java.util.List<StorageObject>	objects
private java.lang.String	requestMarker
private long	requestMaxKeys
private java.lang.String	requestPrefix

Constructor Summary

Constructors

Constructor and Description
ListBucketHandler()

Method Summary

Modifier and Type	Method and Description
void	endElement(java.lang.String name, java.lang.String elementText)
java.lang.String[]	getCommonPrefixes()
java.lang.String	getMarkerForNextListing() If the listing is truncated this method will return the marker that should be used in subsequent bucket list calls to complete the listing.
java.lang.String	getNextMarker()
StorageObject[]	getObjects()
java.lang.String	getRequestMarker()
long	getRequestMaxKeys()
java.lang.String	getRequestPrefix()
boolean	isListingTruncated()
void	startElement(java.lang.String name)

Methods inherited from class org.jets3t.service.impl.rest.DefaultXmlHandler

characters, endDocument, endElement, startDocument, startElement, startElement

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Field Detail

currentObject

private StorageObject currentObject

currentOwner

private StorageOwner currentOwner

insideCommonPrefixes

private boolean insideCommonPrefixes

objects

private final java.util.List<StorageObject> objects

commonPrefixes

private final java.util.List<java.lang.String> commonPrefixes

bucketName

private java.lang.String bucketName

requestPrefix

private java.lang.String requestPrefix

requestMarker

private java.lang.String requestMarker

requestMaxKeys

private long requestMaxKeys

listingTruncated

private boolean listingTruncated

lastKey

private java.lang.String lastKey

nextMarker

private java.lang.String nextMarker

Constructor Detail

ListBucketHandler

public ListBucketHandler()

Method Detail

getMarkerForNextListing

public java.lang.String getMarkerForNextListing()

If the listing is truncated this method will return the marker that should be used in subsequent bucket list calls to complete the listing.

Returns:

null if the listing is not truncated, otherwise the next marker if it's available or the last object key seen if the next marker isn't available.

isListingTruncated

public boolean isListingTruncated()

Returns:

true if the listing document was truncated, and therefore only contained a subset of the available S3 objects.

getObjects

public StorageObject[] getObjects()

Returns:

the S3 objects contained in the listing.

getCommonPrefixes

public java.lang.String[] getCommonPrefixes()

getRequestPrefix

public java.lang.String getRequestPrefix()

getRequestMarker

public java.lang.String getRequestMarker()

getNextMarker

public java.lang.String getNextMarker()

getRequestMaxKeys

public long getRequestMaxKeys()

startElement

public void startElement(java.lang.String name)

Overrides:

startElement in class DefaultXmlHandler

endElement

public void endElement(java.lang.String name,
                       java.lang.String elementText)

Overrides:

endElement in class DefaultXmlHandler