fish.payara.microprofile.config.extensions.ldap.LDAPConfigSourceConfiguration Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
There is a newer version: 6.2024.6
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) [2020] Payara Foundation and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/master/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * The Payara Foundation designates this particular file as subject to the "Classpath"
 * exception as provided by the Payara Foundation in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package fish.payara.microprofile.config.extensions.ldap;

import fish.payara.nucleus.microprofile.config.spi.ConfigSourceConfiguration;
import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.Configured;

/**
 *
 * @author Gaurav Gupta
 */
@Configured(name = "ldap-config-source-configuration")
public interface LDAPConfigSourceConfiguration extends ConfigSourceConfiguration {

    String AUTH_TYPE_SIMPLE = "simple";
    String AUTH_TYPE_NONE = "none";

    String SEARCH_SCOPE_SUBTREE = "subtree";
    String SEARCH_SCOPE_ONELEVEL = "onelevel";
    String SEARCH_SCOPE_OBJECT = "object";

    String LDAP_CONTEXT_FACTORY = "com.sun.jndi.ldap.LdapCtxFactory";
    String LDAP_CONNECT_TIMEOUT = "com.sun.jndi.ldap.connect.timeout";
    String LDAP_READ_TIMEOUT = "com.sun.jndi.ldap.read.timeout";

    @Attribute(required = true)
    String getUrl();
    void setUrl(String url);

    @Attribute(required = true, defaultValue = AUTH_TYPE_SIMPLE)
    String getAuthType();
    void setAuthType(String authType);

    @Attribute(dataType=Boolean.class, defaultValue = "false")
    String getStartTLSEnabled();
    void setStartTLSEnabled(String startTLSEnabled);

    @Attribute
    String getBindDN();
    void setBindDN(String bindDN);

    @Attribute
    String getBindDNPassword();
    void setBindDNPassword(String bindDNPassword);

    @Attribute
    String getSearchBase();
    void setSearchBase(String searchBase);

    @Attribute
    String getSearchFilter();
    void setSearchFilter(String searchFilter);
    
    @Attribute
    String getSearchScope();
    void setSearchScope(String searchScope);

    @Attribute
    String getConnectionTimeout();
    void setConnectionTimeout(String connectionTimeout);

    @Attribute
    String getReadTimeout();
    void setReadTimeout(String readTimeout);

}