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 final class LdapSyntaxHelper 39 { 40 private LdapSyntaxHelper() 41 { 42 } 43 44 45 /** 46 * Inject the LdapSyntax into the registries, updating the references to 47 * other SchemaObject 48 * 49 * @param ldapSyntax The LdapSyntax to add to the Registries 50 * @param errors The errors we got while adding the LdapSyntax to the Registries 51 * @param registries The Registries 52 * @throws LdapException If the addition failed 53 */ 54 public static void addToRegistries( LdapSyntax ldapSyntax, List<Throwable> errors, Registries registries ) 55 throws LdapException 56 { 57 if ( registries != null ) 58 { 59 try 60 { 61 ldapSyntax.unlock(); 62 63 SyntaxChecker syntaxChecker = null; 64 65 try 66 { 67 // Gets the associated SyntaxChecker 68 syntaxChecker = registries.getSyntaxCheckerRegistry().lookup( ldapSyntax.getOid() ); 69 } 70 catch ( LdapException ne ) 71 { 72 // No SyntaxChecker ? Associate the Syntax to a catch all SyntaxChecker 73 syntaxChecker = OctetStringSyntaxChecker.builder().setOid( ldapSyntax.getOid() ).build(); 74 } 75 76 // Add the references for S : 77 // S -> SC 78 if ( syntaxChecker != null ) 79 { 80 registries.addReference( ldapSyntax, syntaxChecker ); 81 ldapSyntax.setSyntaxChecker( syntaxChecker ); 82 } 83 } 84 finally 85 { 86 ldapSyntax.lock(); 87 } 88 } 89 } 90 91 92 /** 93 * Remove the LdapSyntax from the Registries, updating the references to 94 * other SchemaObject. 95 * 96 * If one of the referenced SchemaObject does not exist, 97 * an exception is thrown. 98 * 99 * @param ldapSyntax The LdapSyntax to remove from the Registries 100 * @param errors The errors we got while removing the LdapSyntax from the Registries 101 * @param registries The Registries 102 * @throws LdapException If the LdapSyntax is not valid 103 */ 104 public static void removeFromRegistries( LdapSyntax ldapSyntax, List<Throwable> errors, Registries registries ) 105 throws LdapException 106 { 107 if ( ( registries != null ) && ( ldapSyntax.getSyntaxChecker() != null ) ) 108 { 109 /** 110 * Remove the Syntax references (using and usedBy) : 111 * S -> SC 112 */ 113 registries.delReference( ldapSyntax, ldapSyntax.getSyntaxChecker() ); 114 } 115 } 116 }