1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.model.schema;
21
22
23 import java.util.Map;
24
25
26 /**
27 * A class is used to resolve the normalizer mapping hash used for normalization.
28 * This interface is implemented and passed into several kinds of parsers that
29 * need to handle the normalization of LDAP name strings.
30 *
31 * Why you may ask are we doing this? Why not just pass in the map of
32 * normalizers to these parsers and let them use that? First off this mapping
33 * will not be static when dynamic updates are enabled to schema. So if
34 * we just passed in the map then there would be no way to set a new map or
35 * trigger the change of the map when schema changes. Secondly we cannot just
36 * pass server side objects that return this mapping because these parsers may
37 * and will be used in client side applications. They will not have access to
38 * these server side objects that generate these mappings. Instead when a
39 * resolver is used we can create mock or almost right implementations.
40 *
41 * @param <E> The normalizer type
42 *
43 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
44 */
45 public interface NormalizerMappingResolver<E extends Normalizer>
46 {
47 /**
48 * Gets the Map containing the normalizers associated to an OID or name
49 *
50 * @return The normalizer Map
51 * @throws Exception If not found
52 */
53 Map<String, E> getNormalizerMapping() throws Exception;
54 }