com.cyberark.conjur.api.AuthnProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of conjur-api Show documentation

Programmatic Java access to the Conjur API

There is a newer version: 3.0.5

package com.cyberark.conjur.api;


/**
 * Provides Conjur authentication tokens.
 */
public interface AuthnProvider {

    /**
     * Return an authentication token.  This method should be equivalent to {@code authenticate(true)}
     * if the implementation supports token caching.
     * @return a Conjur authentication token
     */
    Token authenticate();

    /**
     * Return an authentication token.  If the implementation supports token caching
     * and useCachedToken is true, it should return a cached token if a valid (non-expired)
     * one is available.  If useCachedToken is false, it should always fetch a fresh token from
     * the Conjur authn service.
     *
     * @param useCachedToken whether to use a cached token.
     * @return a Conjur authentication token
     */
    // TODO orenbm: Do we need this?
    Token authenticate(boolean useCachedToken);
}