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 * A specialized parameters object for JNDI configurations. 24 * </p> 25 * <p> 26 * In addition to the basic properties common to all configuration implementations, a JNDI configuration has some 27 * special properties defining the subset of the JNDI tree to be managed. This class provides fluent methods for setting 28 * these. The {@code getParameters()} method puts all properties defined by the user in a map from where they can be 29 * accessed by a builder for JNDI configurations. 30 * </p> 31 * <p> 32 * This class is not thread-safe. It is intended that an instance is constructed and initialized by a single thread 33 * during configuration of a {@code ConfigurationBuilder}. 34 * </p> 35 * 36 * @since 2.0 37 */ 38 public class JndiBuilderParametersImpl extends BasicBuilderParameters implements JndiBuilderProperties<JndiBuilderParametersImpl> { 39 /** Constant for the name of the context property. */ 40 private static final String PROP_CONTEXT = "context"; 41 42 /** Constant for the name of the prefix property. */ 43 private static final String PROP_PREFIX = "prefix"; 44 45 @Override 46 public JndiBuilderParametersImpl setContext(final Context ctx) { 47 storeProperty(PROP_CONTEXT, ctx); 48 return this; 49 } 50 51 @Override 52 public JndiBuilderParametersImpl setPrefix(final String p) { 53 storeProperty(PROP_PREFIX, p); 54 return this; 55 } 56 }