LdapConfig.java

/*
 * 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.glowroot.common.config;

import java.util.List;
import java.util.Map;

import javax.annotation.Nullable;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import org.immutables.value.Value;

import org.glowroot.common.util.Versions;

@Value.Immutable
public abstract class LdapConfig {

    @Value.Default
    @JsonInclude(value = Include.NON_EMPTY)
    public String host() {
        return "";
    }

    // need to write zero since it is treated different from null
    // (although in this case zero is not a valid value)
    @JsonInclude(value = Include.NON_NULL)
    public abstract @Nullable Integer port();

    @Value.Default
    @JsonInclude(value = Include.NON_EMPTY)
    public boolean ssl() {
        return false;
    }

    @Value.Default
    @JsonInclude(value = Include.NON_EMPTY)
    public String username() {
        return "";
    }

    @Value.Default
    @JsonInclude(value = Include.NON_EMPTY)
    public String password() {
        return "";
    }

    @Value.Default
    @JsonInclude(value = Include.NON_EMPTY)
    public String userBaseDn() {
        return "";
    }

    @Value.Default
    @JsonInclude(value = Include.NON_EMPTY)
    public String userSearchFilter() {
        return "";
    }

    @Value.Default
    @JsonInclude(value = Include.NON_EMPTY)
    public String groupBaseDn() {
        return "";
    }

    @Value.Default
    @JsonInclude(value = Include.NON_EMPTY)
    public String groupSearchFilter() {
        return "";
    }

    @JsonInclude(value = Include.NON_EMPTY)
    public abstract Map<String, List<String>> roleMappings();

    @Value.Derived
    @JsonIgnore
    public String version() {
        return Versions.getJsonVersion(this);
    }

    @JsonIgnore
    @Value.Derived
    public String url() {
        String url = ssl() ? "ldaps://" : "ldap://";
        url += host();
        Integer port = port();
        if (port != null) {
            url += ":" + port;
        }
        return url;
    }
}