com.emc.vipr.services.s3.ViPRResponsesSaxParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of s3-client Show documentation
null
There is a newer version: 2.0.3
/*
 * Copyright 2013 EMC Corporation. 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://www.apache.org/licenses/LICENSE-2.0.txt
 *
 * 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.emc.vipr.services.s3;

import com.amazonaws.AmazonClientException;
import com.amazonaws.services.s3.model.transform.XmlResponsesSaxParser;
import com.emc.vipr.services.s3.model.FileAccessObject;
import com.emc.vipr.services.s3.model.GetFileAccessResult;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

/**
 * Overrides XmlResponsesSaxParser to provide additional parsing for ViPR-specific S3 XML responses.
 */
public class ViPRResponsesSaxParser extends XmlResponsesSaxParser {
    private static final Log log = LogFactory.getLog(ViPRResponsesSaxParser.class);

    /**
     * Parses a fileaccess 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 com.amazonaws.AmazonClientException
     *
     */
    public FileAccessResultHandler parseFileAccessResult(InputStream inputStream)
            throws AmazonClientException {
        FileAccessResultHandler handler = new FileAccessResultHandler();
        parseXmlInputStream(handler, inputStream);
        return handler;
    }

    /*
        
        
            cifs://foo.foo/export
            nfs://blah.blah:/export
            
               foo
               cifs://foo.foo/export
               foo
               some_guy
            
            
               blah
               nfs://blah.blah:/export
               blah
               some_girl
            
            false
        
     */
    public class FileAccessResultHandler extends DefaultHandler {
        private GetFileAccessResult result = new GetFileAccessResult();
        private StringBuilder text;
        private List mountPoints = new ArrayList();
        private List objects = new ArrayList();
        private FileAccessObject object, lastObject;

        public GetFileAccessResult getResult() {
            return result;
        }

        @Override
        public void startDocument() {
            text = new StringBuilder();
        }

        @Override
        public void startElement(String uri, String name, String qName, Attributes attrs) {
            if (name.equals("fileaccess_response")) {
                // expected, but no action
            } else if (name.equals("mountPoints")) {
                text.setLength(0);
            } else if (name.equals("hasMore")) {
                text.setLength(0);
            } else if (name.equals("name")) {
                text.setLength(0);
            } else if (name.equals("deviceExport")) {
                text.setLength(0);
            } else if (name.equals("relativePath")) {
                text.setLength(0);
            } else if (name.equals("owner")) {
                text.setLength(0);
            } else if (name.equals("objects")) {
                object = new FileAccessObject();
            } else {
                log.warn("Ignoring unexpected tag <" + name + ">");
            }
        }

        @Override
        public void endElement(String uri, String name, String qName) throws SAXException {
            if (name.equals("mountPoints")) {
                mountPoints.add(text.toString());
            } else if (name.equals("hasMore")) {
                result.setTruncated(Boolean.parseBoolean(text.toString()));
            } else if (name.equals("name") && object != null) {
                object.setName(text.toString());
            } else if (name.equals("deviceExport") && object != null) {
                object.setDeviceExport(text.toString());
            } else if (name.equals("relativePath") && object != null) {
                object.setRelativePath(text.toString());
            } else if (name.equals("owner") && object != null) {
                object.setOwner(text.toString());
            } else if (name.equals("objects")) {
                objects.add(object);
                lastObject = object;
                object = null;
            }
            text.setLength(0);
        }

        @Override
        public void characters(char ch[], int start, int length) {
            this.text.append(ch, start, length);
        }

        @Override
        public void endDocument() throws SAXException {
            result.setMountPoints(mountPoints);
            result.setObjects(objects);
            if (result.isTruncated()) result.setLastKey(lastObject.getName());
        }
    }
}