    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *     http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.configuration2.builder;
    018
    019import javax.naming.Context;
    020
    021/**
    022 * <p>
    023 * Definition of a properties interface for parameters of a JNDI configuration.
    024 * </p>
    025 * <p>
    026 * This interface defines properties related to the JNDI tree to be represented by a {@code JNDIConfiguration}.
    027 * </p>
    028 * <p>
    029 * <strong>Important note:</strong> This interface is not intended to be implemented by client code! It defines a set of
    030 * available properties and may be extended even in minor releases.
    031 * </p>
    032 *
    033 * @param <T> the type of the result of all set methods for method chaining
    034 * @since 2.0
    035 */
    036public interface JndiBuilderProperties<T> {
    037    /**
    038     * Sets the JNDI context to be used by the JNDI configuration.
    039     *
    040     * @param ctx the JNDI {@code Context}
    041     * @return a reference to this object for method chaining
    042     */
    043    T setContext(Context ctx);
    044
    045    /**
    046     * Sets the prefix in the JNDI tree. When creating the root JNDI context this prefix is taken into account.
    047     *
    048     * @param p the prefix
    049     * @return a reference to this object for method chaining
    050     */
    051    T setPrefix(String p);
    052}