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     */
020    package org.apache.directory.shared.ldap.schema.registries;
021    
022    import org.apache.directory.shared.ldap.exception.LdapException;
023    import org.apache.directory.shared.ldap.schema.Normalizer;
024    
025    
026    /**
027     * Normalizer registry service class.
028     *
029     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
030     * @version $Rev: 923524 $
031     */
032    public interface NormalizerRegistry extends SchemaObjectRegistry<Normalizer>,
033        Iterable<Normalizer>
034    {
035        /**
036         * Registers a new Normalizer with this registry.
037         *
038         * @param normalizer the Normalizer to register
039         * @throws LdapException if the Normalizer is already registered or
040         * the registration operation is not supported
041         */
042        void register( Normalizer normalizer ) throws LdapException;
043    
044    
045        /**
046         * Removes the Normalizer registered with this registry, using its
047         * numeric OID.
048         * 
049         * @param numericOid the numeric identifier
050         * @throws LdapException if the numeric identifier is invalid
051         */
052        Normalizer unregister( String numericOid ) throws LdapException;
053        
054        
055        /**
056         * Unregisters all Normalizers defined for a specific schema from
057         * this registry.
058         * 
059         * @param schemaName the name of the schema whose Normalizers will be removed from
060         */
061        void unregisterSchemaElements( String schemaName ) throws LdapException;
062        
063        
064        /**
065         * Copy the NormalizerRegistry
066         */
067        NormalizerRegistry copy();
068    }