io.micronaut.configuration.security.ldap.context.SearchProvider Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2020 original 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
 *
 * https://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 io.micronaut.configuration.security.ldap.context;

import javax.naming.NamingException;
import java.util.List;

/**
 * Generic functional interface that returns a list of search
 * results from LDAP.
 *
 * @author James Kleeh
 * @since 1.0
 */
@FunctionalInterface
public interface SearchProvider {

    /**
     * @return The list of search results
     * @throws NamingException If the search encounters an exception
     */
    List get() throws NamingException;
}