org.jsoftware.restclient.RestClientPlugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-client Show documentation

The newest version!

package org.jsoftware.restclient;

import org.apache.http.client.methods.HttpRequestBase;
import org.jetbrains.annotations.NotNull;

/**
 * RestClientPlugin allows modification of http requests and responses
 * @author szalik
 */
public interface RestClientPlugin {

    /**
     * Plugin context
     * @author szalik
     */
    interface PluginContext {
        /**
         * @return current http request
         */
        HttpRequestBase getRequest();

        /**
         * Not available before request is not sent
         * @throws IllegalStateException if response is not available
         * @return current http response
         */
        RestClientResponse getResponse();

        /**
         * @return if response is available
         */
        boolean isResponseAvailable();

        /**
         * Override http request
         * @param request set request
         */
        void setRequest(HttpRequestBase request);

        /**
         * Override http response
         * @param response set client's response
         */
        void setResponse(RestClientResponse response);

        /**
         * @return requested URI
         */
        String getURI();

        /**
         * @param uri URI to call
         */
        void setURI(String uri);
    }


    /**
     * Chain of responsibility for RestClientPlugins
     */
    interface PluginChain {
        /**
         * Continue chain of plugins
         * @throws Exception if any error in chain occurred
         */
        void continueChain() throws Exception;
    }

    /**
     * Plugin main method
     * @param context http request context
     * @param chain chain of plugins
     * @throws Exception if any error in chain occurred
     */
    void plugin(@NotNull PluginContext context, @NotNull PluginChain chain) throws Exception;
}