org.ctoolkit.restapi.client.PayloadRequest 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 extended {@link Request} to provide additional flow actions for requests or responses having a payload.
 *
 * @param  the resource type
 * @author Aurel Medvegy
 */
public interface PayloadRequest
        extends Request
{
    /**
     * Returns the underlying request instance in order to configure an additional query parameters
     * specific to the underlying API implementation.
     *
     * @param type the underlying request type to cast to
     * @return the underlying request instance
     * @throws ClassCastException if wrong type has been requested
     */
     U underlying( Class type );

    /**
     * The type of the answer expected as a result of the remote call execution.
     *
     * @param type the response type different from the default one
     * @return the request to chain calls with newly defined response type
     */
     Request answerBy( @Nonnull Class type );

    /**
     * Execute a remote call and return non default type of the response.
     *
     * @param type the response type different from the default one
     * @return the resource as a result of the remote call
     */
     R finish( @Nonnull Class type );
}