JndiBuilderParametersImpl.java

  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. import javax.naming.Context;

  19. /**
  20.  * <p>
  21.  * A specialized parameters object for JNDI configurations.
  22.  * </p>
  23.  * <p>
  24.  * In addition to the basic properties common to all configuration implementations, a JNDI configuration has some
  25.  * special properties defining the subset of the JNDI tree to be managed. This class provides fluent methods for setting
  26.  * these. The {@code getParameters()} method puts all properties defined by the user in a map from where they can be
  27.  * accessed by a builder for JNDI configurations.
  28.  * </p>
  29.  * <p>
  30.  * This class is not thread-safe. It is intended that an instance is constructed and initialized by a single thread
  31.  * during configuration of a {@code ConfigurationBuilder}.
  32.  * </p>
  33.  *
  34.  * @since 2.0
  35.  */
  36. public class JndiBuilderParametersImpl extends BasicBuilderParameters implements JndiBuilderProperties<JndiBuilderParametersImpl> {
  37.     /** Constant for the name of the context property. */
  38.     private static final String PROP_CONTEXT = "context";

  39.     /** Constant for the name of the prefix property. */
  40.     private static final String PROP_PREFIX = "prefix";

  41.     @Override
  42.     public JndiBuilderParametersImpl setContext(final Context ctx) {
  43.         storeProperty(PROP_CONTEXT, ctx);
  44.         return this;
  45.     }

  46.     @Override
  47.     public JndiBuilderParametersImpl setPrefix(final String p) {
  48.         storeProperty(PROP_PREFIX, p);
  49.         return this;
  50.     }
  51. }