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