001/*
002 *   Licensed to the Apache Software Foundation (ASF) under one
003 *   or more contributor license agreements.  See the NOTICE file
004 *   distributed with this work for additional information
005 *   regarding copyright ownership.  The ASF licenses this file
006 *   to you under the Apache License, Version 2.0 (the
007 *   "License"); you may not use this file except in compliance
008 *   with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *   Unless required by applicable law or agreed to in writing,
013 *   software distributed under the License is distributed on an
014 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *   KIND, either express or implied.  See the License for the
016 *   specific language governing permissions and limitations
017 *   under the License.
018 *
019 */
020package org.apache.directory.server.config.beans;
021
022
023import org.apache.directory.api.ldap.model.constants.SchemaConstants;
024import org.apache.directory.api.ldap.model.name.Dn;
025import org.apache.directory.server.config.ConfigurationElement;
026
027
028/**
029 * A class used to store the KdcServer configuration.
030 *
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public class DSBasedServerBean extends ServerBean
034{
035    /**
036     * The single location where entries are stored.  If this service
037     * is catalog based the store will search the system partition
038     * configuration for catalog entries.  Otherwise it will use this
039     * search base as a single point of searching the DIT.
040     */
041    @ConfigurationElement(attributeType = SchemaConstants.ADS_SEARCH_BASE_DN, isOptional = true)
042    private Dn searchBaseDn;
043
044
045    /**
046     * Create a new JournalBean instance
047     */
048    public DSBasedServerBean()
049    {
050    }
051
052
053    /**
054     * Returns the search base Dn.
055     *
056     * @return The search base Dn.
057     */
058    public Dn getSearchBaseDn()
059    {
060        return searchBaseDn;
061    }
062
063
064    /**
065     * @param searchBaseDn The searchBaseDn to set.
066     */
067    public void setSearchBaseDn( Dn searchBaseDn )
068    {
069        this.searchBaseDn = searchBaseDn;
070    }
071
072
073    /**
074     * {@inheritDoc}
075     */
076    @Override
077    public String toString( String tabs )
078    {
079        StringBuilder sb = new StringBuilder();
080
081        sb.append( super.toString( tabs ) );
082        sb.append( toString( tabs, SchemaConstants.ADS_SEARCH_BASE_DN, searchBaseDn ) );
083
084        return sb.toString();
085    }
086
087
088    /**
089     * {@inheritDoc}
090     */
091    @Override
092    public String toString()
093    {
094        return toString( "" );
095    }
096}