FilesContainer.java

/*
 * See COPYING for license information.
 */ 

package com.rackspacecloud.client.cloudfiles;

import java.io.File;
import java.io.IOException;
import java.security.NoSuchAlgorithmException;
import java.util.List;

import org.apache.http.HttpException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class FilesContainer
{
    private String name;
    private List<FilesObject> objects = null;
    private FilesClient client = null;
    private static final Logger log = LoggerFactory.getLogger(FilesContainer.class);

    /**
     * Create a new container (Note, this does not actually create a container on the server)
     *  
     * @param name    The name of the container
     * @param objs    The objects in that container
     * @param client  The client we are currently using
     */
    public FilesContainer(String name, List<FilesObject> objs, FilesClient client)
    {
        this.name = name;
        objects = objs;
        this.client = client;
    }

    /**
     * @param name The name of the container
     * @param client A logged in client
     */
    public FilesContainer(String name, FilesClient client)
    {
        this.name = name;
        this.client = client;
    }

    /**
     * Get the name of the container
     * 
     * @return The name of this container
     */
    public String getName()
    {
        return name;
    }

    /**
     * Set the name of the container
     * 
     * @param name The new name
     */
    public void setName(String name)
    {
        this.name = name;
    }

    /**
     * Returns the contents of this container
     * 
     * @return A list of the contents
     * @throws HttpException There was a problem communicating with the server
     * @throws IOException There was a problem communicating with the server
     * @throws FilesAuthorizationException 
     * @throws FilesInvalidNameException 
     */
    public List<FilesObject> getObjects() throws IOException, FilesAuthorizationException, FilesException
    {
    
        if (client != null)
        {
            if(objects == null) {
            	objects = client.listObjects(name);
            }
            return objects;
        }
        else
        {
            log.error("This Container has no FilesClient defined!");
        }
        return null;
    }

    /**
     * Returns the contents of this container
     * 
     * @param path Limit the results to files under the following path
     * 
     * @return A list of the contents
     * @throws HttpException There was a problem communicating with the server
     * @throws IOException There was a problem communicating with the server
     * @throws FilesAuthorizationException 
     * @throws FilesInvalidNameException 
     */
    public List<FilesObject> getObjects(String path) throws HttpException, IOException, FilesAuthorizationException, FilesException
    {
    
        if (client != null)
        {
            if(objects == null) {
            	objects = client.listObjects(name, path);
            }
            return objects;
        }
        else
        {
            log.error("This Container has no FilesClient defined!");
        }
        return null;
    }

    /**
     * Get useful information on this container
     * 
     * @return The container info
     * @throws HttpException There was a problem communicating with the server
     * @throws IOException There was a problem communicating with the server
     * @throws FilesException 
     */
    public FilesContainerInfo getInfo() throws HttpException, IOException, FilesException
    {
        if (client != null)
        {
            return client.getContainerInfo(name);
        }
        else
        {
            log.error("This container does not have a valid client!");
        }
        return null;
    }

    /**
     * Returns the instance of the client we're using
     * 
     * @return The FilesClient
     */
    public FilesClient getClient()
    {
        return client;
    }

    /**
     * Adds a new object to the container
     * 
     * @param f    The file for this object
     * @param mimeType It's MIME type
     * @return The return code from the server
     * @throws NoSuchAlgorithmException  The MD5 implementation is not installed in the client
     * @throws IOException
     * @throws FilesAuthorizationException 
     * @throws FilesInvalidNameException 
     */
    public boolean addObject (File f, String mimeType) throws NoSuchAlgorithmException, IOException, FilesAuthorizationException, FilesException
    {
        FilesObject obj = new FilesObject(f, mimeType, this);

        if (objects != null)
            objects.add(obj);
        else
        {
           objects = getObjects();
           if (objects != null)
              return objects.add (obj);
        }
        log.error("Could not add Object, it seems something is wrong with this Container or FilesClient!"); 
        return false;
    }

    /**
     * Creates the container represented by this instance on the server
     *
     * @return Either FilesConstants.CONTAINER_CREATED or FilesConstants.CONTAINER_EXISTED or -1 if the client has not been set 
     * @throws HttpException
     * @throws IOException
     * @throws FilesAuthorizationException 
     * @throws FilesInvalidNameException 
     */
    public void createContainer () throws HttpException, IOException, FilesAuthorizationException, FilesException
    {
        if (client != null)
        {
        	client.createContainer(name);
        }
        else
            log.error("This Container has no FilesClient defined!");

    }
}