com.emc.vipr.client.core.ObjectBuckets Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vipr-controller-client Show documentation
ViPR Controller Java Client
There is a newer version: 3.5.0.0
Show newest version
/*
 * Copyright (c) 2015 EMC Corporation
 * All Rights Reserved
 */

package com.emc.vipr.client.core;

import static com.emc.vipr.client.core.util.ResourceUtils.defaultList;

import java.net.URI;
import java.util.List;

import javax.ws.rs.core.UriBuilder;

import com.emc.storageos.model.BulkIdParam;
import com.emc.storageos.model.TaskResourceRep;
import com.emc.storageos.model.object.BucketACE;
import com.emc.storageos.model.object.BucketACL;
import com.emc.storageos.model.object.BucketBulkRep;
import com.emc.storageos.model.object.BucketDeleteParam;
import com.emc.storageos.model.object.BucketParam;
import com.emc.storageos.model.object.BucketRestRep;
import com.emc.storageos.model.object.BucketUpdateParam;
import com.emc.storageos.model.object.ObjectBucketACLUpdateParams;
import com.emc.vipr.client.Task;
import com.emc.vipr.client.Tasks;
import com.emc.vipr.client.ViPRCoreClient;
import com.emc.vipr.client.core.impl.PathConstants;
import com.emc.vipr.client.impl.RestClient;

/**
 * ObjectBuckets resources.
 * 
 * Base URL: /object/buckets
 */
public class ObjectBuckets extends ProjectResources implements TaskResources {

    public ObjectBuckets(ViPRCoreClient parent, RestClient client) {
        super(parent, client, BucketRestRep.class, PathConstants.OBJECT_BUCKET_URL);
    }

    @Override
    public Tasks getTasks(URI id) {
        return doGetTasks(id);
    }

    @Override
    public Task getTask(URI id, URI taskId) {
        return doGetTask(id, taskId);
    }

    @Override
    protected List getBulkResources(BulkIdParam input) {
        BucketBulkRep response = client.post(BucketBulkRep.class, input, getBulkUrl());
        return defaultList(response.getBuckets());
    }

    /**
     * Begins deactivating the given bucket by ID.
     * 

     * API Call: POST /object/buckets/{id}/deactivate
     * 
     * @param id
     *            the ID of the file system to deactivate.
     * @param input
     *            the delete configuration.
     * @return a task for monitoring the progress of the operation.
     */
    public Task deactivate(URI id, BucketDeleteParam input) {
        return postTask(input, getDeactivateUrl(), id);
    }

    /**
     * Begins create the bucket.
     * 

     * API Call: POST /object/buckets
     * 
     * @param input
     *            the create configuration.
     * @return a task for monitoring the progress of the operation.
     */
    public Task create(BucketParam input, URI project) {
        URI uri = client.uriBuilder(baseUrl).queryParam("project", project).build();
        TaskResourceRep task = client.postURI(TaskResourceRep.class, input, uri);
        return new Task<>(client, task, resourceClass);
    }

    /**
     * Begins update the bucket.
     * 

     * API Call: PUT /object/buckets
     * 
     * @param input
     *            the create configuration.
     * @return a task for monitoring the progress of the operation.
     */
    public Task update(URI id, BucketUpdateParam input) {
        return putTask(input, getIdUrl(), id);
    }
    
    /**
     * Gets the Bucket ACLs for the given bucket by ID.
     * 

     * API Call: GET /object/buckets/{id}/acl/
     * 
     * @param id is the ID of the file system.
     * @return the list of ACE for the given bucket.
     */
    public List getBucketACL(URI id) {
        BucketACL response = client.get(BucketACL.class, getBucketACLUrl(), id);
        return defaultList(response.getBucketACL());
    }

    /**
     * Update Bucket ACL
     * 
     * API Call: PUT /object/buckets/{id}/acl/
     * 
     * @param id is the ID of the Bucket.
     * @param param
     *            the update/create configuration
     * @return a task for monitoring the progress of the operation.
     */

    public Task updateBucketACL(URI id, ObjectBucketACLUpdateParams param) {
        UriBuilder builder = client.uriBuilder(getBucketACLUrl());
        URI targetUri = builder.build(id);
        return putTaskURI(param, targetUri);
    }

    /**
     * Begins removing a bucket ACL from the given bucket by ID.
     * 
     * API Call: DELETE /object/buckets/{id}/acl/
     * 
     * @param id is the ID of the Bucket.
     * @return a task for monitoring the progress of the operation.
     */
    public Task deleteBucketACL(URI id) {
        return deleteTask(getBucketACLUrl(), id);
    }

    /**
     * Gets the base URL for bucket: /object/buckets/{id}/acl/
     * 
     * @return the Bucket ACL URL.
     */
    protected String getBucketACLUrl() {
        return getIdUrl() + "/acl/";
    }
}