CredentialsProvider.java

// Copyright (c) 2015, SAS Institute Inc., Cary, NC, USA, All Rights Reserved
package com.sas.unravl.auth;

import com.fasterxml.jackson.databind.node.ObjectNode;
import com.sas.unravl.UnRAVLRuntime;

import java.io.IOException;

/**
 * An interface for an object that can provide user credentials (login id,
 * password) for connecting to a host. Set the provider via
 * {@link com.sas.unravl.UnRAVLPlugins#setCredentialsProvider(CredentialsProvider)}
 * . The default, if not overridden, is the {@link NetrcCredentialsProvider}.
 * 
 * @author David.Biesack@sas.com
 */
public interface CredentialsProvider {

    /**
     * Get credentials for the host.
     * 
     * @param host
     *            the host name or host:port string
     * @param auth
     *            The JsonNode containing the auth contents (usually login and
     *            password). Examples would be
     * 
     *            <pre>
     *            { "basic" : true }
     *            { "oath2" : "https://www.example.com/auth/token" }
     * </pre>
     * @param mock
     *            if true, return mock credentials
     * @return an object containing the user login name and password. This may
     *         be a {@link OAuth2Credentials} object if the credentials contain
     *         <code>clintId</code>, <code>clientPassword</code>, or
     *         <code>accessToken</code>
     * @throws IOException
     *             if we could not read the .netrc file
     */
    public HostCredentials getHostCredentials(String host, ObjectNode auth,
            boolean mock) throws IOException;

    /**
     * Get credentials for the host, user, and password. Note: If reading
     * credentials from a .netrc file, the credentials are <em>not</em> cached;
     * we reread the .netrc file each time. (This allows one script to obtain
     * credentials from a service and store them in .netrc in the current
     * directory.)
     *
     * @param host
     *            the host name or host:port string
     * @param userName
     *            the user's login name/id
     * @param password
     *            the user's password/secret
     * @param mock
     *            if true, return mock credentials
     * @return an object containing the user login name and password
     * @throws IOException
     *             if there is an I/O exception trying to read stored
     *             credentials
     */
    public abstract HostCredentials getHostCredentials(String host,
            String userName, String password, boolean mock) throws IOException;

    public void setRuntime(UnRAVLRuntime runtime);
}