org.gradle.api.internalrepositories.AuthenticationSupporter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
There is a newer version: 8.6
/*
 * Copyright 2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.gradle.api.internal.artifacts.repositories;

import org.gradle.api.Action;
import org.gradle.api.artifacts.repositories.AuthenticationContainer;
import org.gradle.api.artifacts.repositories.PasswordCredentials;
import org.gradle.api.credentials.AwsCredentials;
import org.gradle.api.credentials.Credentials;
import org.gradle.api.credentials.HttpHeaderCredentials;
import org.gradle.api.model.ObjectFactory;
import org.gradle.api.provider.Property;
import org.gradle.api.provider.Provider;
import org.gradle.api.provider.ProviderFactory;
import org.gradle.authentication.Authentication;
import org.gradle.internal.Cast;
import org.gradle.internal.authentication.AllSchemesAuthentication;
import org.gradle.internal.authentication.AuthenticationInternal;
import org.gradle.internal.credentials.DefaultAwsCredentials;
import org.gradle.internal.credentials.DefaultHttpHeaderCredentials;
import org.gradle.internal.credentials.DefaultPasswordCredentials;
import org.gradle.internal.reflect.Instantiator;

import java.util.Collection;
import java.util.Collections;

public class AuthenticationSupporter {
    private final Instantiator instantiator;
    private final AuthenticationContainer authenticationContainer;
    private final ProviderFactory providerFactory;

    private final Property credentials;
    private boolean usesCredentials = false;

    public AuthenticationSupporter(Instantiator instantiator, ObjectFactory objectFactory, AuthenticationContainer authenticationContainer, ProviderFactory providerFactory) {
        this.instantiator = instantiator;
        this.authenticationContainer = authenticationContainer;
        this.credentials = objectFactory.property(Credentials.class);
        this.providerFactory = providerFactory;
    }

    public PasswordCredentials getCredentials() {
        if (!usesCredentials()) {
            return setCredentials(PasswordCredentials.class);
        } else if (credentials.get() instanceof PasswordCredentials) {
            return Cast.uncheckedCast(credentials.get());
        } else {
            throw new IllegalStateException("Can not use getCredentials() method when not using PasswordCredentials; please use getCredentials(Class)");
        }
    }

    public  T getCredentials(Class credentialsType) {
        if (!usesCredentials()) {
            return setCredentials(credentialsType);
        } else if (credentialsType.isInstance(credentials.get())) {
            return Cast.uncheckedCast(credentials.get());
        } else {
            throw new IllegalArgumentException(String.format("Given credentials type '%s' does not match actual type '%s'", credentialsType.getName(), getCredentialsPublicType(credentials.get().getClass()).getName()));
        }
    }

    public void credentials(Action action) {
        if (usesCredentials() && !(credentials.get() instanceof PasswordCredentials)) {
            throw new IllegalStateException("Can not use credentials(Action) method when not using PasswordCredentials; please use credentials(Class, Action)");
        }
        credentials(PasswordCredentials.class, action);
    }

    public  void credentials(Class credentialsType, Action action) throws IllegalStateException {
        action.execute(getCredentials(credentialsType));
    }

    public void credentials(Class credentialsType, Provider identity) {
        this.usesCredentials = true;
        this.credentials.set(providerFactory.credentials(credentialsType, identity));
    }

    public void setConfiguredCredentials(Credentials credentials) {
        this.usesCredentials = true;
        this.credentials.set(credentials);
    }

    private  T setCredentials(Class clazz) {
        this.usesCredentials = true;
        T t = newCredentials(clazz);
        credentials.set(t);
        return t;
    }

    private  T newCredentials(Class clazz) {
        return instantiator.newInstance(getCredentialsImplType(clazz));
    }

    public Property getConfiguredCredentials() {
        return credentials;
    }

    public void authentication(Action action) {
        action.execute(getAuthentication());
    }

    public AuthenticationContainer getAuthentication() {
        return authenticationContainer;
    }

    public Collection getConfiguredAuthentication() {
        populateAuthenticationCredentials();
        if (usesCredentials() && authenticationContainer.size() == 0) {
            return Collections.singleton(new AllSchemesAuthentication(credentials.get()));
        } else {
            return getAuthentication();
        }
    }

    boolean usesCredentials() {
        return usesCredentials;
    }

    private void populateAuthenticationCredentials() {
        // TODO: This will have to be changed when we support setting credentials directly on the authentication
        for (Authentication authentication : authenticationContainer) {
            ((AuthenticationInternal) authentication).setCredentials(credentials.getOrNull());
        }
    }

    // Mappings between public and impl types
    // If the list of mappings grows we should move it to a data structure

    private static  Class getCredentialsImplType(Class publicType) {
        if (publicType == PasswordCredentials.class) {
            return Cast.uncheckedCast(DefaultPasswordCredentials.class);
        } else if (publicType == AwsCredentials.class) {
            return Cast.uncheckedCast(DefaultAwsCredentials.class);
        } else if (publicType == HttpHeaderCredentials.class) {
            return Cast.uncheckedCast(DefaultHttpHeaderCredentials.class);
        } else {
            throw new IllegalArgumentException(String.format("Unknown credentials type: '%s' (supported types: %s, %s and %s).", publicType.getName(), PasswordCredentials.class.getName(), AwsCredentials.class.getName(), HttpHeaderCredentials.class.getName()));
        }
    }

    private static  Class getCredentialsPublicType(Class implType) {
        if (PasswordCredentials.class.isAssignableFrom(implType)) {
            return Cast.uncheckedCast(PasswordCredentials.class);
        } else if (AwsCredentials.class.isAssignableFrom(implType)) {
            return Cast.uncheckedCast(AwsCredentials.class);
        } else if (HttpHeaderCredentials.class.isAssignableFrom(implType)) {
            return Cast.uncheckedCast(HttpHeaderCredentials.class);
        } else {
            throw new IllegalArgumentException(String.format("Unknown credentials implementation type: '%s' (supported types: %s, %s and %s).", implType.getName(), DefaultPasswordCredentials.class.getName(), DefaultAwsCredentials.class.getName(), DefaultHttpHeaderCredentials.class.getName()));
        }
    }

}