org.ctoolkit.restapi.client.AuthRequest 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) 2018 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;

/**
 * The interface to provide possibility to configure request with authentication token.
 * Once token is being provided at the request level, it bypasses the underlying authorization mechanism.
 *
 * @param  the resource type
 * @author Aurel Medvegy
 */
public interface AuthRequest
        extends Request
{
    /**
     * Setup the authentication schema prefix for the token provided by {@link Request#authBy(String)}.
     *
     * @return the request to chain calls
     */
    Request bearer();

    /**
     * Setup the authentication schema prefix for the token provided by {@link Request#authBy(String)}.
     *
     * @return the request to chain calls
     */
    Request oauth();

    enum AuthScheme
    {
        BEARER( "Bearer" ),

        OAUTH( "OAuth" );

        private String value;

        AuthScheme( String value )
        {
            this.value = value;
        }

        public String getValue()
        {
            return value;
        }
    }

}