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