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 * https://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.registries.helper;
21
22
23 import org.apache.directory.api.ldap.model.exception.LdapException;
24 import org.apache.directory.api.ldap.model.schema.LdapSyntax;
25 import org.apache.directory.api.ldap.model.schema.SchemaErrorHandler;
26 import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
27 import org.apache.directory.api.ldap.model.schema.registries.Registries;
28 import org.apache.directory.api.ldap.model.schema.syntaxCheckers.OctetStringSyntaxChecker;
29
30
31 /**
32 * An helper class used to store all the methods associated with an LdapSyntax
33 * in relation with the Registries and SchemaManager.
34 *
35 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
36 */
37 public final class LdapSyntaxHelper
38 {
39 private LdapSyntaxHelper()
40 {
41 }
42
43
44 /**
45 * Inject the LdapSyntax into the registries, updating the references to
46 * other SchemaObject
47 *
48 * @param ldapSyntax The LdapSyntax to add to the Registries
49 * @param errorHandler Error handler
50 * @param registries The Registries
51 * @throws LdapException If the addition failed
52 */
53 public static void addToRegistries( LdapSyntax ldapSyntax, SchemaErrorHandler errorHandler, Registries registries )
54 throws LdapException
55 {
56 if ( registries != null )
57 {
58 try
59 {
60 ldapSyntax.unlock();
61
62 SyntaxChecker syntaxChecker = null;
63
64 try
65 {
66 // Gets the associated SyntaxChecker
67 syntaxChecker = registries.getSyntaxCheckerRegistry().lookup( ldapSyntax.getOid() );
68 }
69 catch ( LdapException ne )
70 {
71 // No SyntaxChecker ? Associate the Syntax to a catch all SyntaxChecker
72 syntaxChecker = OctetStringSyntaxChecker.builder().setOid( ldapSyntax.getOid() ).build();
73 }
74
75 // Add the references for S :
76 // S -> SC
77 if ( syntaxChecker != null )
78 {
79 registries.addReference( ldapSyntax, syntaxChecker );
80 ldapSyntax.setSyntaxChecker( syntaxChecker );
81 }
82 }
83 finally
84 {
85 ldapSyntax.lock();
86 }
87 }
88 }
89
90
91 /**
92 * Remove the LdapSyntax from the Registries, updating the references to
93 * other SchemaObject.
94 *
95 * If one of the referenced SchemaObject does not exist,
96 * an exception is thrown.
97 *
98 * @param ldapSyntax The LdapSyntax to remove from the Registries
99 * @param errorHandler Error handler
100 * @param registries The Registries
101 */
102 public static void removeFromRegistries( LdapSyntax ldapSyntax, SchemaErrorHandler errorHandler, Registries registries )
103 {
104 if ( ( registries != null ) && ( ldapSyntax.getSyntaxChecker() != null ) )
105 {
106 /**
107 * Remove the Syntax references (using and usedBy) :
108 * S -> SC
109 */
110 registries.delReference( ldapSyntax, ldapSyntax.getSyntaxChecker() );
111 }
112 }
113 }