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

java.lang.Object
  extended by org.xml.sax.helpers.DefaultHandler
      extended by org.jets3t.service.impl.rest.DefaultXmlHandler
          extended by 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.


Constructor Summary
XmlResponsesSaxParser.ListBucketHandler()
           
 
Method Summary
 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
 

Constructor Detail

XmlResponsesSaxParser.ListBucketHandler

public XmlResponsesSaxParser.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