com.bmuschko.gradle.docker.DockerRegistryCredentials.groovy Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gradle-docker-plugin Show documentation

Gradle plugin for managing Docker images and containers.

There is a newer version: 6.7.0

/*
 * Copyright 2014 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 com.bmuschko.gradle.docker

import groovy.transform.CompileStatic
import org.gradle.api.Project
import org.gradle.api.credentials.PasswordCredentials
import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.Optional

import javax.annotation.Nullable

@CompileStatic
class DockerRegistryCredentials {
    public static final String DEFAULT_URL = 'https://index.docker.io/v1/'

    /**
     * Registry URL needed to push images. Defaults to "https://index.docker.io/v1/".
     */
    @Input
    final Property url

    /**
     * Registry username needed to push images. Defaults to null.
     */
    @Input
    @Optional
    final Property username

    /**
     * Registry password needed to push images. Defaults to null.
     */
    @Input
    @Optional
    final Property password

    /**
     * Registry email address needed to push images. Defaults to null.
     */
    @Input
    @Optional
    final Property email

    DockerRegistryCredentials(Project project) {
        url = project.objects.property(String)
        url.set(DEFAULT_URL)
        username = project.objects.property(String)
        password = project.objects.property(String)
        email = project.objects.property(String)
    }

    /**
     * Translates the Docker registry credentials into a {@link PasswordCredentials}.
     *
     * @since 4.0.0
     */
    PasswordCredentials asPasswordCredentials() {
        new PasswordCredentials() {
            @Override
            String getUsername() {
                DockerRegistryCredentials.this.username.get()
            }

            @Override
            void setUsername(@Nullable String userName) {
                DockerRegistryCredentials.this.username.set(userName)
            }

            @Override
            String getPassword() {
                DockerRegistryCredentials.this.password.get()
            }

            @Override
            void setPassword(@Nullable String password) {
                DockerRegistryCredentials.this.password.set(password)
            }
        }
    }
}