001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2013 ForgeRock AS.
015 */
016package org.forgerock.opendj.ldap.spi;
017
018/**
019 * Interface for providers, which provide an implementation of one or more interfaces.
020 * <p>
021 * A provider must be declared in the provider-configuration file
022 * {@code META-INF/services/org.forgerock.opendj.ldap.spi.<ProviderClass>}
023 * in order to allow automatic loading of the implementation classes using the
024 * {@code java.util.ServiceLoader} facility.
025 */
026public interface Provider {
027
028    /**
029     * Returns the name of this provider.
030     *
031     * @return name of provider
032     */
033    String getName();
034
035}