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.api.ldap.model.schema.registries.helper;
021
022
023import java.util.List;
024
025import org.apache.directory.api.ldap.model.exception.LdapException;
026import org.apache.directory.api.ldap.model.schema.DitStructureRule;
027import org.apache.directory.api.ldap.model.schema.registries.Registries;
028
029
030/**
031 * An helper class used to store all the methods associated with an DitStructureRule
032 * in relation with the Registries and SchemaManager.
033 * 
034 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
035 */
036public final class DitStructureRuleHelper
037{
038    private DitStructureRuleHelper()
039    {
040    }
041
042
043    /**
044     * Inject the DitContentRule into the registries, updating the references to
045     * other SchemaObject
046     *
047     * @param ditStructureRule The DitStructureRule to add to the Registries
048     * @param errors The errors we got while adding the DitContentRule to the Registries
049     * @param registries The Registries
050     * @throws LdapException If the addition failed
051     */
052    public static void addToRegistries( DitStructureRule ditStructureRule, List<Throwable> errors, Registries registries )
053        throws LdapException
054    {
055        if ( registries != null )
056        {
057            try
058            {
059                ditStructureRule.unlock();
060
061                // NOT YET IMPLEMENTED
062            }
063            finally
064            {
065                ditStructureRule.lock();
066            }
067        }
068    }
069}