io.fabric8.maven.docker.config.NetworkConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docker-maven-plugin Show documentation
Docker Maven Plugin
There is a newer version: 0.45.0
package io.fabric8.maven.docker.config;
/*
 *
 * Copyright 2016 Roland Huss
 *
 * 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.
 */

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import org.apache.maven.plugins.annotations.Parameter;

/**
 * Network config encapsulating network specific configuration
 * @author roland
 * @since 29/07/16
 */

public class NetworkConfig implements Serializable {

    @Parameter
    private String name;

    @Parameter
    private Mode mode;

    private List aliases = new ArrayList<>();

    // Use by Maven to add flattened  entries
    // See  http://blog.sonatype.com/2011/03/configuring-plugin-goals-in-maven-3/
    public void addAlias(String alias) {
        aliases.add(alias);
    }

    /**
     * Legacy constructor using the <net> config
     * @param net net, encapsulating mode & name.
     */
    public NetworkConfig(String net) {
        initLegacyNetSpec(net);
    }


    public NetworkConfig(Mode mode, String name) {
        this.name = name;
        this.mode = mode;
    }

    public NetworkConfig() {
        name = null;
        mode = null;
    }

    private void initLegacyNetSpec(String net) {
        if (net != null) {
            this.mode = extractMode(net);
            if (this.mode == Mode.container) {
                this.name = net.substring(Mode.container.name().length() + 1);
            } else if (this.mode == Mode.custom) {
                this.name = net;
            } else {
                this.name = null;
            }
        } else {
            this.mode = null;
            this.name = null;
        }
    }

    private Mode extractMode(String mode) {
        if (mode != null && mode.length() > 0) {
            try {
                return Mode.valueOf(mode.toLowerCase());
            } catch (IllegalArgumentException exp) { /* could be a custom mode, too */ }
            if (mode.toLowerCase().startsWith(Mode.container.name() + ":")) {
                return Mode.container;
            } else {
                return Mode.custom;
            }
        }
        return null;
    }

    public List getAliases() {
        return aliases;
    }

    public boolean isCustomNetwork() {
        return (mode != null && mode == Mode.custom) || (mode == null && name != null);
    }

    public boolean isStandardNetwork() {
        return mode != null && mode != Mode.custom;
    }

    public String getStandardMode(String containerId) {
        if (isCustomNetwork()) {
            throw new IllegalArgumentException("Custom network for network '" + name +
                                               "' can not be used as standard mode");
        }
        if (mode == null) {
            return null;
        }
        return mode.name().toLowerCase() + (mode == Mode.container ? ":" + containerId : "");
    }

    public String getContainerAlias() {
        return mode == Mode.container ? name : null;
    }

    public String getCustomNetwork() {
        return mode == Mode.custom || mode == null ? name : null;
    }

    public boolean hasAliases() {
        return aliases != null && !aliases.isEmpty();
    }

    public Mode getMode() {
        return mode;
    }

    public String getName() {
        return name;
    }

    // ==============================================================================

    // Mode used for determining the network
    public enum Mode {
        none,
        bridge,
        host,
        container,
        custom;
    }

    public static class Builder {

        private final NetworkConfig config = new NetworkConfig();
        private boolean isEmpty = true;

        public NetworkConfig build() {
            return isEmpty ? null : config;
        }

        public Builder mode(String mode) {
            config.mode = set(mode != null ? Mode.valueOf(mode) : null);
            return this;
        }

        public Builder name(String name) {
            config.name = set(name);
            return this;
        }


        public Builder aliases(List aliases) {
            config.aliases = set(aliases);
            return this;
        }

        private  T set(T prop) {
            if (prop != null) {
                isEmpty = false;
            }
            return prop;
        }
    }
}