1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.configuration2.builder;
18
19 import javax.naming.Context;
20
21 /**
22 * <p>
23 * Definition of a properties interface for parameters of a JNDI configuration.
24 * </p>
25 * <p>
26 * This interface defines properties related to the JNDI tree to be represented by a {@code JNDIConfiguration}.
27 * </p>
28 * <p>
29 * <strong>Important note:</strong> This interface is not intended to be implemented by client code! It defines a set of
30 * available properties and may be extended even in minor releases.
31 * </p>
32 *
33 * @since 2.0
34 * @param <T> the type of the result of all set methods for method chaining
35 */
36 public interface JndiBuilderProperties<T> {
37 /**
38 * Sets the JNDI context to be used by the JNDI configuration.
39 *
40 * @param ctx the JNDI {@code Context}
41 * @return a reference to this object for method chaining
42 */
43 T setContext(Context ctx);
44
45 /**
46 * Sets the prefix in the JNDI tree. When creating the root JNDI context this prefix is taken into account.
47 *
48 * @param p the prefix
49 * @return a reference to this object for method chaining
50 */
51 T setPrefix(String p);
52 }