Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* jets3t : Java Extra-Tasty S3 Toolkit (for Amazon S3 online storage service)
* This is a java.net project, see https://jets3t.dev.java.net/
*
* Copyright 2006 James Murty
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License 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 org.jets3t.service.impl.rest;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.jets3t.service.Constants;
import org.jets3t.service.Jets3tProperties;
import org.jets3t.service.S3ServiceException;
import org.jets3t.service.acl.AccessControlList;
import org.jets3t.service.acl.CanonicalGrantee;
import org.jets3t.service.acl.EmailAddressGrantee;
import org.jets3t.service.acl.GranteeInterface;
import org.jets3t.service.acl.GroupGrantee;
import org.jets3t.service.acl.Permission;
import org.jets3t.service.model.S3Bucket;
import org.jets3t.service.model.S3BucketLoggingStatus;
import org.jets3t.service.model.S3Object;
import org.jets3t.service.model.S3Owner;
import org.jets3t.service.utils.ServiceUtils;
import org.xml.sax.Attributes;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.DefaultHandler;
import org.xml.sax.helpers.XMLReaderFactory;
/**
* XML Sax parser to read XML documents returned by S3 via the REST interface, converting these
* documents into JetS3t objects.
*
* @author James Murty
*/
public class XmlResponsesSaxParser {
private static final Log log = LogFactory.getLog(XmlResponsesSaxParser.class);
private XMLReader xr = null;
private Jets3tProperties properties = null;
/**
* Constructs the XML SAX parser.
*
* @param properties
* the JetS3t properties that will be applied when parsing XML documents.
*
* @throws S3ServiceException
*/
public XmlResponsesSaxParser(Jets3tProperties properties) throws S3ServiceException {
this.properties = properties;
// Ensure we can load the XML Reader.
try {
xr = XMLReaderFactory.createXMLReader();
} catch (SAXException e) {
// oops, lets try doing this (needed in 1.4)
System.setProperty("org.xml.sax.driver", "org.apache.crimson.parser.XMLReaderImpl");
try {
// Try once more...
xr = XMLReaderFactory.createXMLReader();
} catch (SAXException e2) {
throw new S3ServiceException("Couldn't initialize a sax driver for the XMLReader");
}
}
}
/**
* Constructs the XML SAX parser.
* @throws S3ServiceException
*/
public XmlResponsesSaxParser() throws S3ServiceException {
this(Jets3tProperties.getInstance(Constants.JETS3T_PROPERTIES_FILENAME));
}
/**
* Parses an XML document from an input stream using a document handler.
* @param handler
* the handler for the XML document
* @param inputStream
* an input stream containing the XML document to parse
* @throws S3ServiceException
* any parsing, IO or other exceptions are wrapped in an S3ServiceException.
*/
protected void parseXmlInputStream(DefaultHandler handler, InputStream inputStream)
throws S3ServiceException
{
try {
if (log.isDebugEnabled()) {
log.debug("Parsing XML response document with handler: " + handler.getClass());
}
BufferedReader breader = new BufferedReader(new InputStreamReader(inputStream,
Constants.DEFAULT_ENCODING));
xr.setContentHandler(handler);
xr.setErrorHandler(handler);
xr.parse(new InputSource(breader));
} catch (Throwable t) {
try {
inputStream.close();
} catch (IOException e) {
if (log.isErrorEnabled()) {
log.error("Unable to close response InputStream up after XML parse failure", e);
}
}
throw new S3ServiceException("Failed to parse XML document with handler "
+ handler.getClass(), t);
}
}
protected InputStream sanitizeXmlDocument(DefaultHandler handler, InputStream inputStream)
throws S3ServiceException
{
if (!properties.getBoolProperty("xmlparser.sanitize-listings", true)) {
// No sanitizing will be performed, return the original input stream unchanged.
return inputStream;
} else {
if (log.isDebugEnabled()) {
log.debug("Sanitizing XML document destined for handler " + handler.getClass());
}
InputStream sanitizedInputStream = null;
try {
/* Read object listing XML document from input stream provided into a
* string buffer, so we can replace troublesome characters before
* sending the document to the XML parser.
*/
StringBuffer listingDocBuffer = new StringBuffer();
BufferedReader br = new BufferedReader(
new InputStreamReader(inputStream, Constants.DEFAULT_ENCODING));
char[] buf = new char[8192];
int read = -1;
while ((read = br.read(buf)) != -1) {
listingDocBuffer.append(buf, 0, read);
}
br.close();
// Replace any carriage return (\r) characters with explicit XML
// character entities, to prevent the SAX parser from
// misinterpreting 0x0D characters as 0x0A.
String listingDoc = listingDocBuffer.toString().replaceAll("\r", "
");
sanitizedInputStream = new ByteArrayInputStream(
listingDoc.getBytes(Constants.DEFAULT_ENCODING));
} catch (Throwable t) {
try {
inputStream.close();
} catch (IOException e) {
if (log.isErrorEnabled()) {
log.error("Unable to close response InputStream after failure sanitizing XML document", e);
}
}
throw new S3ServiceException("Failed to sanitize XML document destined for handler "
+ handler.getClass(), t);
}
return sanitizedInputStream;
}
}
/**
* Parses a ListBucket response XML document from an input stream.
* @param inputStream
* XML data input stream.
* @return
* the XML handler object populated with data parsed from the XML stream.
* @throws S3ServiceException
*/
public ListBucketHandler parseListBucketObjectsResponse(InputStream inputStream)
throws S3ServiceException
{
ListBucketHandler handler = new ListBucketHandler();
parseXmlInputStream(handler, sanitizeXmlDocument(handler, inputStream));
return handler;
}
/**
* Parses a ListAllMyBuckets response XML document from an input stream.
* @param inputStream
* XML data input stream.
* @return
* the XML handler object populated with data parsed from the XML stream.
* @throws S3ServiceException
*/
public ListAllMyBucketsHandler parseListMyBucketsResponse(InputStream inputStream)
throws S3ServiceException
{
ListAllMyBucketsHandler handler = new ListAllMyBucketsHandler();
parseXmlInputStream(handler, sanitizeXmlDocument(handler, inputStream));
return handler;
}
/**
* Parses an AccessControlListHandler response XML document from an input stream.
*
* @param inputStream
* XML data input stream.
* @return
* the XML handler object populated with data parsed from the XML stream.
*
* @throws S3ServiceException
*/
public AccessControlListHandler parseAccessControlListResponse(InputStream inputStream)
throws S3ServiceException
{
AccessControlListHandler handler = new AccessControlListHandler();
parseXmlInputStream(handler, inputStream);
return handler;
}
/**
* Parses a LoggingStatus response XML document for a bucket from an input stream.
*
* @param inputStream
* XML data input stream.
* @return
* the XML handler object populated with data parsed from the XML stream.
*
* @throws S3ServiceException
*/
public BucketLoggingStatusHandler parseLoggingStatusResponse(InputStream inputStream)
throws S3ServiceException
{
BucketLoggingStatusHandler handler = new BucketLoggingStatusHandler();
parseXmlInputStream(handler, inputStream);
return handler;
}
public String parseBucketLocationResponse(InputStream inputStream)
throws S3ServiceException
{
BucketLocationHandler handler = new BucketLocationHandler();
parseXmlInputStream(handler, inputStream);
return handler.getLocation();
}
public CopyObjectResultHandler parseCopyObjectResponse(InputStream inputStream)
throws S3ServiceException
{
CopyObjectResultHandler handler = new CopyObjectResultHandler();
parseXmlInputStream(handler, inputStream);
return handler;
}
// ////////////
// Handlers //
// ////////////
/**
* Handler for ListBucket response XML documents.
* The document is parsed into {@link S3Object}s available via the {@link #getObjects()} method.
*/
public class ListBucketHandler extends DefaultHandler {
private S3Object currentObject = null;
private S3Owner currentOwner = null;
private StringBuffer currText = null;
private boolean insideCommonPrefixes = false;
private List objects = new ArrayList();
private List commonPrefixes = new ArrayList();
// Listing properties.
private String bucketName = null;
private String requestPrefix = null;
private String requestMarker = null;
private long requestMaxKeys = 0;
private boolean listingTruncated = false;
private String lastKey = null;
private String nextMarker = null;
public ListBucketHandler() {
super();
this.currText = new StringBuffer();
}
/**
* If the listing is truncated this method will return the marker that should be used
* in subsequent bucket list calls to complete the listing.
*
* @return
* 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.
*/
public String getMarkerForNextListing() {
if (listingTruncated) {
if (nextMarker != null) {
return nextMarker;
} else if (lastKey != null) {
return lastKey;
} else {
if (log.isWarnEnabled()) {
log.warn("Unable to find Next Marker or Last Key for truncated listing");
}
return null;
}
} else {
return null;
}
}
/**
* @return
* true if the listing document was truncated, and therefore only contained a subset of the
* available S3 objects.
*/
public boolean isListingTruncated() {
return listingTruncated;
}
/**
* @return
* the S3 objects contained in the listing.
*/
public S3Object[] getObjects() {
return (S3Object[]) objects.toArray(new S3Object[objects.size()]);
}
public String[] getCommonPrefixes() {
return (String[]) commonPrefixes.toArray(new String[commonPrefixes.size()]);
}
public String getRequestPrefix() {
return requestPrefix;
}
public String getRequestMarker() {
return requestMarker;
}
public String getNextMarker() {
return nextMarker;
}
public long getRequestMaxKeys() {
return requestMaxKeys;
}
public void startDocument() {
}
public void endDocument() {
}
public void startElement(String uri, String name, String qName, Attributes attrs) {
if (name.equals("Contents")) {
currentObject = new S3Object(null);
currentObject.setBucketName(bucketName);
} else if (name.equals("Owner")) {
currentOwner = new S3Owner();
currentObject.setOwner(currentOwner);
} else if (name.equals("CommonPrefixes")) {
insideCommonPrefixes = true;
}
}
public void endElement(String uri, String name, String qName) {
String elementText = this.currText.toString();
// Listing details
if (name.equals("Name")) {
bucketName = elementText;
if (log.isDebugEnabled()) {
log.debug("Examining listing for bucket: " + bucketName);
}
} else if (!insideCommonPrefixes && name.equals("Prefix")) {
requestPrefix = elementText;
} else if (name.equals("Marker")) {
requestMarker = elementText;
} else if (name.equals("NextMarker")) {
nextMarker = elementText;
} else if (name.equals("MaxKeys")) {
requestMaxKeys = Long.parseLong(elementText);
} else if (name.equals("IsTruncated")) {
String isTruncatedStr = elementText.toLowerCase(Locale.getDefault());
if (isTruncatedStr.startsWith("false")) {
listingTruncated = false;
} else if (isTruncatedStr.startsWith("true")) {
listingTruncated = true;
} else {
throw new RuntimeException("Invalid value for IsTruncated field: "
+ isTruncatedStr);
}
}
// Object details.
else if (name.equals("Contents")) {
objects.add(currentObject);
if (log.isDebugEnabled()) {
log.debug("Created new S3Object from listing: " + currentObject);
}
} else if (name.equals("Key")) {
currentObject.setKey(elementText);
lastKey = elementText;
} else if (name.equals("LastModified")) {
try {
currentObject.setLastModifiedDate(ServiceUtils.parseIso8601Date(elementText));
} catch (ParseException e) {
throw new RuntimeException("Unexpected date format in list bucket output", e);
}
} else if (name.equals("ETag")) {
currentObject.setETag(elementText);
} else if (name.equals("Size")) {
currentObject.setContentLength(Long.parseLong(elementText));
} else if (name.equals("StorageClass")) {
currentObject.setStorageClass(elementText);
}
// Owner details.
else if (name.equals("ID")) {
currentOwner.setId(elementText);
} else if (name.equals("DisplayName")) {
currentOwner.setDisplayName(elementText);
}
// Common prefixes.
else if (insideCommonPrefixes && name.equals("Prefix")) {
commonPrefixes.add(elementText);
} else if (name.equals("CommonPrefixes")) {
insideCommonPrefixes = false;
}
this.currText = new StringBuffer();
}
public void characters(char ch[], int start, int length) {
this.currText.append(ch, start, length);
}
}
/**
* Handler for ListAllMyBuckets response XML documents.
* The document is parsed into {@link S3Bucket}s available via the {@link #getBuckets()} method.
*
* @author James Murty
*
*/
public class ListAllMyBucketsHandler extends DefaultHandler {
private S3Owner bucketsOwner = null;
private S3Bucket currentBucket = null;
private StringBuffer currText = null;
private List buckets = null;
public ListAllMyBucketsHandler() {
super();
buckets = new ArrayList();
this.currText = new StringBuffer();
}
/**
* @return
* the buckets listed in the document.
*/
public S3Bucket[] getBuckets() {
return (S3Bucket[]) buckets.toArray(new S3Bucket[buckets.size()]);
}
public void startDocument() {
}
public void endDocument() {
}
public void startElement(String uri, String name, String qName, Attributes attrs) {
if (name.equals("Bucket")) {
currentBucket = new S3Bucket();
} else if (name.equals("Owner")) {
bucketsOwner = new S3Owner();
}
}
public void endElement(String uri, String name, String qName) {
String elementText = this.currText.toString();
// Listing details.
if (name.equals("ID")) {
bucketsOwner.setId(elementText);
} else if (name.equals("DisplayName")) {
bucketsOwner.setDisplayName(elementText);
}
// Bucket item details.
else if (name.equals("Bucket")) {
if (log.isDebugEnabled()) {
log.debug("Created new bucket from listing: " + currentBucket);
}
currentBucket.setOwner(bucketsOwner);
buckets.add(currentBucket);
} else if (name.equals("Name")) {
currentBucket.setName(elementText);
} else if (name.equals("CreationDate")) {
try {
currentBucket.setCreationDate(ServiceUtils.parseIso8601Date(elementText));
} catch (ParseException e) {
throw new RuntimeException("Unexpected date format in list bucket output", e);
}
}
this.currText = new StringBuffer();
}
public void characters(char ch[], int start, int length) {
this.currText.append(ch, start, length);
}
}
/**
* Handler for AccessControlList response XML documents.
* The document is parsed into an {@link AccessControlList} object available via the
* {@link #getAccessControlList()} method.
*
* @author James Murty
*
*/
public class AccessControlListHandler extends DefaultHandler {
private AccessControlList accessControlList = null;
private S3Owner owner = null;
private GranteeInterface currentGrantee = null;
private Permission currentPermission = null;
private StringBuffer currText = null;
private boolean insideACL = false;
public AccessControlListHandler() {
super();
this.currText = new StringBuffer();
}
/**
* @return
* an object representing the ACL document.
*/
public AccessControlList getAccessControlList() {
return accessControlList;
}
public void startDocument() {
}
public void endDocument() {
}
public void startElement(String uri, String name, String qName, Attributes attrs) {
if (name.equals("Owner")) {
owner = new S3Owner();
} else if (name.equals("AccessControlList")) {
accessControlList = new AccessControlList();
accessControlList.setOwner(owner);
insideACL = true;
} else if (name.equals("Grantee")) {
if ("AmazonCustomerByEmail".equals(attrs.getValue("xsi:type"))) {
currentGrantee = new EmailAddressGrantee();
} else if ("CanonicalUser".equals(attrs.getValue("xsi:type"))) {
currentGrantee = new CanonicalGrantee();
} else if ("Group".equals(attrs.getValue("xsi:type"))) {
currentGrantee = new GroupGrantee();
}
}
}
public void endElement(String uri, String name, String qName) {
String elementText = this.currText.toString();
// Owner details.
if (name.equals("ID") && !insideACL) {
owner.setId(elementText);
} else if (name.equals("DisplayName") && !insideACL) {
owner.setDisplayName(elementText);
}
// ACL details.
else if (name.equals("ID")) {
currentGrantee.setIdentifier(elementText);
} else if (name.equals("EmailAddress")) {
currentGrantee.setIdentifier(elementText);
} else if (name.equals("URI")) {
currentGrantee.setIdentifier(elementText);
} else if (name.equals("DisplayName")) {
((CanonicalGrantee) currentGrantee).setDisplayName(elementText);
} else if (name.equals("Permission")) {
currentPermission = Permission.parsePermission(elementText);
} else if (name.equals("Grant")) {
accessControlList.grantPermission(currentGrantee, currentPermission);
} else if (name.equals("AccessControlList")) {
insideACL = false;
}
this.currText = new StringBuffer();
}
public void characters(char ch[], int start, int length) {
this.currText.append(ch, start, length);
}
}
/**
* Handler for LoggingStatus response XML documents for a bucket.
* The document is parsed into an {@link S3BucketLoggingStatus} object available via the
* {@link #getBucketLoggingStatus()} method.
*
* @author James Murty
*
*/
public class BucketLoggingStatusHandler extends DefaultHandler {
private S3BucketLoggingStatus bucketLoggingStatus = null;
private String targetBucket = null;
private String targetPrefix = null;
private StringBuffer currText = null;
public BucketLoggingStatusHandler() {
super();
this.currText = new StringBuffer();
}
/**
* @return
* an object representing the bucket's LoggingStatus document.
*/
public S3BucketLoggingStatus getBucketLoggingStatus() {
return bucketLoggingStatus;
}
public void startDocument() {
}
public void endDocument() {
}
public void startElement(String uri, String name, String qName, Attributes attrs) {
if (name.equals("BucketLoggingStatus")) {
bucketLoggingStatus = new S3BucketLoggingStatus();
}
}
public void endElement(String uri, String name, String qName) {
String elementText = this.currText.toString();
if (name.equals("TargetBucket")) {
targetBucket = elementText;
} else if (name.equals("TargetPrefix")) {
targetPrefix = elementText;
} else if (name.equals("LoggingEnabled")) {
bucketLoggingStatus.setTargetBucketName(targetBucket);
bucketLoggingStatus.setLogfilePrefix(targetPrefix);
}
this.currText = new StringBuffer();
}
public void characters(char ch[], int start, int length) {
this.currText.append(ch, start, length);
}
}
/**
* Handler for CreateBucketConfiguration response XML documents for a bucket.
* The document is parsed into a String representing the bucket's lcoation,
* available via the {@link #getLocation()} method.
*
* @author James Murty
*
*/
public class BucketLocationHandler extends DefaultHandler {
private String location = null;
private StringBuffer currText = null;
public BucketLocationHandler() {
super();
this.currText = new StringBuffer();
}
/**
* @return
* the bucket's location.
*/
public String getLocation() {
return location;
}
public void startDocument() {
}
public void endDocument() {
}
public void startElement(String uri, String name, String qName, Attributes attrs) {
if (name.equals("CreateBucketConfiguration")) {
}
}
public void endElement(String uri, String name, String qName) {
String elementText = this.currText.toString();
if (name.equals("LocationConstraint")) {
if (elementText.length() == 0) {
location = null;
} else {
location = elementText;
}
}
this.currText = new StringBuffer();
}
public void characters(char ch[], int start, int length) {
this.currText.append(ch, start, length);
}
}
public class CopyObjectResultHandler extends DefaultHandler {
// Data items for successful copy
private String etag = null;
private Date lastModified = null;
// Data items for failed copy
private String errorCode = null;
private String errorMessage = null;
private String errorRequestId = null;
private String errorHostId = null;
private boolean receivedErrorResponse = false;
private StringBuffer currText = null;
public CopyObjectResultHandler() {
super();
this.currText = new StringBuffer();
}
public Date getLastModified() {
return lastModified;
}
public String getETag() {
return etag;
}
public String getErrorCode() {
return errorCode;
}
public String getErrorHostId() {
return errorHostId;
}
public String getErrorMessage() {
return errorMessage;
}
public String getErrorRequestId() {
return errorRequestId;
}
public boolean isErrorResponse() {
return receivedErrorResponse;
}
public void startDocument() {
}
public void endDocument() {
}
public void startElement(String uri, String name, String qName, Attributes attrs) {
if (name.equals("CopyObjectResult")) {
receivedErrorResponse = false;
} else if (name.equals("Error")) {
receivedErrorResponse = true;
}
}
public void endElement(String uri, String name, String qName) {
String elementText = this.currText.toString();
if (name.equals("LastModified")) {
try {
lastModified = ServiceUtils.parseIso8601Date(elementText);
} catch (ParseException e) {
throw new RuntimeException("Unexpected date format in copy object output", e);
}
} else if (name.equals("ETag")) {
etag = elementText;
} else if (name.equals("Code")) {
errorCode = elementText;
} else if (name.equals("Message")) {
errorMessage = elementText;
} else if (name.equals("RequestId")) {
errorRequestId = elementText;
} else if (name.equals("HostId")) {
errorHostId = elementText;
}
this.currText = new StringBuffer();
}
public void characters(char ch[], int start, int length) {
this.currText.append(ch, start, length);
}
}
}
