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.LdapSyntax;
027import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
028import org.apache.directory.api.ldap.model.schema.registries.Registries;
029import org.apache.directory.api.ldap.model.schema.syntaxCheckers.OctetStringSyntaxChecker;
030
031
032/**
033 * An helper class used to store all the methods associated with an LdapSyntax
034 * in relation with the Registries and SchemaManager.
035 * 
036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
037 */
038public final class LdapSyntaxHelper
039{
040    private LdapSyntaxHelper()
041    {
042    }
043
044
045    /**
046     * Inject the LdapSyntax into the registries, updating the references to
047     * other SchemaObject
048     *
049     * @param ldapSyntax The LdapSyntax to add to the Registries
050     * @param errors The errors we got while adding the LdapSyntax to the Registries
051     * @param registries The Registries
052     * @throws LdapException If the addition failed
053     */
054    public static void addToRegistries( LdapSyntax ldapSyntax, List<Throwable> errors, Registries registries )
055        throws LdapException
056    {
057        if ( registries != null )
058        {
059            try
060            {
061                ldapSyntax.unlock();
062
063                SyntaxChecker syntaxChecker = null;
064
065                try
066                {
067                    // Gets the associated SyntaxChecker
068                    syntaxChecker = registries.getSyntaxCheckerRegistry().lookup( ldapSyntax.getOid() );
069                }
070                catch ( LdapException ne )
071                {
072                    // No SyntaxChecker ? Associate the Syntax to a catch all SyntaxChecker
073                    syntaxChecker = new OctetStringSyntaxChecker( ldapSyntax.getOid() );
074                }
075
076                // Add the references for S :
077                // S -> SC
078                if ( syntaxChecker != null )
079                {
080                    registries.addReference( ldapSyntax, syntaxChecker );
081                    ldapSyntax.setSyntaxChecker( syntaxChecker );
082                }
083            }
084            finally
085            {
086                ldapSyntax.lock();
087            }
088        }
089    }
090
091
092    /**
093     * Remove the LdapSyntax from the Registries, updating the references to
094     * other SchemaObject.
095     * 
096     * If one of the referenced SchemaObject does not exist,
097     * an exception is thrown.
098     *
099     * @param ldapSyntax The LdapSyntax to remove from the Registries
100     * @param errors The errors we got while removing the LdapSyntax from the Registries
101     * @param registries The Registries
102     * @throws LdapException If the LdapSyntax is not valid
103     */
104    public static void removeFromRegistries( LdapSyntax ldapSyntax, List<Throwable> errors, Registries registries )
105        throws LdapException
106    {
107        if ( ( registries != null ) && ( ldapSyntax.getSyntaxChecker() != null ) )
108        {
109            /**
110             * Remove the Syntax references (using and usedBy) :
111             * S -> SC
112             */
113            registries.delReference( ldapSyntax, ldapSyntax.getSyntaxChecker() );
114        }
115    }
116}