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 027 * by a {@code JNDIConfiguration}. 028 * </p> 029 * <p> 030 * <strong>Important note:</strong> This interface is not intended to be 031 * implemented by client code! It defines a set of available properties and may 032 * be extended even in minor releases. 033 * </p> 034 * 035 * @version $Id: JndiBuilderProperties.java 1624757 2014-09-13 15:47:43Z oheger $ 036 * @since 2.0 037 * @param <T> the type of the result of all set methods for method chaining 038 */ 039public interface JndiBuilderProperties<T> 040{ 041 /** 042 * Sets the JNDI context to be used by the JNDI configuration. 043 * 044 * @param ctx the JNDI {@code Context} 045 * @return a reference to this object for method chaining 046 */ 047 T setContext(Context ctx); 048 049 /** 050 * Sets the prefix in the JNDI tree. When creating the root JNDI context 051 * this prefix is taken into account. 052 * 053 * @param p the prefix 054 * @return a reference to this object for method chaining 055 */ 056 T setPrefix(String p); 057}