org.ctoolkit.restapi.client.SingleUploadMediaRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ctoolkit-rest-facade-api Show documentation
Fluent facade API to allow perform REST operations of various APIs through a single interface.
The newest version!
/*
 * Copyright (c) 2017 Comvai, s.r.o. All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

package org.ctoolkit.restapi.client;

import javax.annotation.Nonnull;

/**
 * The upload media request as a wrapper of data and associated (metadata) resource.
 * Gives a possibility to this resource to be either inserted or updated.
 *
 * @author Aurel Medvegy
 */
public interface SingleUploadMediaRequest
{
    /**
     * Insert a resource instance.
     * 
     * Note: the remote call itself will be executed by request instance {@link PayloadRequest} with possibility
     * to provide optional parameters or locale.
     *
     * @return the fluent action, consequent call will return newly inserted instance
     * @throws NotFoundException if not matching request URI has found
     */
    PayloadRequest insert();

    /**
     * Sets the content type for the media associated with this request.
     *
     * @param type the content type to be set
     * @return the fluent action
     */
    SingleUploadMediaRequest ofType( @Nonnull String type );

    /**
     * Sets whether the target input stream should be closed at the end of 'write to' operation.
     * The default value is {@code true}.
     *
     * @param closeStream the boolean value to be set
     * @return the fluent action
     */
    SingleUploadMediaRequest closeStreamAtTheEnd( boolean closeStream );

    /**
     * Sets the resource identifier.
     * 

     * In case of the consequent {@link #insert()} operation it acts as a parent resource identifier
     * In case of the consequent {@link #update()} operation it acts as a resource identifier
     * 
     *
     * @param identifier the unique identifier of the (parent) resource
     * @return the fluent action
     * @throws NotFoundException if not matching request URI has found
     */
    SingleUploadMediaRequest identifiedBy( @Nonnull Identifier identifier );

    /**
     * Sets the resource identifier.
     * 
     * In case of the consequent {@link #insert()} operation it acts as a parent resource identifier
     * In case of the consequent {@link #update()} operation it acts as a resource identifier
     * 
     *
     * @param identifier the unique identifier of the (parent) resource
     * @return the fluent action
     * @throws NotFoundException if not matching request URI has found
     */
    SingleUploadMediaRequest identifiedBy( @Nonnull String identifier );

    /**
     * Sets the resource identifier.
     * 
     * In case of the consequent {@link #insert()} operation it acts as a parent resource identifier
     * In case of the consequent {@link #update()} operation it acts as a resource identifier
     * 
     *
     * @param identifier the unique identifier of the (parent) resource
     * @return the fluent action
     * @throws NotFoundException if not matching request URI has found
     */
    SingleUploadMediaRequest identifiedBy( @Nonnull Long identifier );

    /**
     * Update the given (metadata) resource instance.
     * 
     * Note: the remote call itself will be executed by request instance {@link PayloadRequest} with possibility
     * to provide optional parameters or locale.
     *
     * @return the fluent action, the consequent call will return updated instance
     * @throws NotFoundException if not matching request URI has found
     */
    PayloadRequest update();
}