org.ctoolkit.restapi.client.provider.AuthKeyProvider 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.provider;

import javax.annotation.Nullable;
import java.io.InputStream;

/**
 * The provider to provide implementation specific mechanism to retrieve authentication key for API authentication
 * (from file, encrypted datastore etc).
 * 
 * The implementation is optional and once configured will take a precedence.
 * See {@link org.ctoolkit.restapi.client.ApiCredential#ApiCredential(String)} for more info how prefix is being used.
 *
 * @author Aurel Medvegy
 */
public interface AuthKeyProvider
{
    /**
     * Provides an instance of the authentication key as a stream.
     * More info about prefix {@link org.ctoolkit.restapi.client.ApiCredential#ApiCredential(String)}.
     *
     * @param prefix the API prefix used to identify a specific API or null for default
     * @return the authentication key as a stream
     * @throws RuntimeException if the implementation encounters an error while providing an instance.
     */
    InputStream get( @Nullable String prefix );

    /**
     * Returns the boolean indication (lightweight operation) whether for given prefix will
     * {@link #get(String)} return a valid authentication key.
     *
     * @param prefix the API prefix used to identify a specific API or null for default
     * @return true if valid authentication key has been configured
     */
    boolean isConfigured( @Nullable String prefix );
}