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; 21 22 23 import org.apache.directory.api.ldap.model.exception.LdapException; 24 import org.apache.directory.api.ldap.model.schema.SyntaxChecker; 25 26 27 /** 28 * SyntaxChecker registry component's service interface. 29 * 30 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 31 */ 32 public interface SyntaxCheckerRegistry extends SchemaObjectRegistry<SyntaxChecker>, 33 Iterable<SyntaxChecker> 34 { 35 /** 36 * Registers a new SyntaxChecker with this registry. 37 * 38 * @param syntaxChecker the SyntaxChecker to register 39 * @throws LdapException if the SyntaxChecker is already registered or 40 * the registration operation is not supported 41 */ 42 void register( SyntaxChecker syntaxChecker ) throws LdapException; 43 44 45 /** 46 * Removes the SyntaxChecker registered with this registry, using its 47 * numeric OID. 48 * 49 * @param numericOid the numeric identifier 50 * @throws LdapException if the numeric identifier is invalid 51 */ 52 SyntaxChecker unregister( String numericOid ) throws LdapException; 53 54 55 /** 56 * Unregisters all SyntaxCheckers defined for a specific schema from 57 * this registry. 58 * 59 * @param schemaName the name of the schema whose SyntaxCheckers will be removed from 60 */ 61 void unregisterSchemaElements( String schemaName ) throws LdapException; 62 63 64 /** 65 * Copy the SyntaxCheckerRegistry 66 */ 67 SyntaxCheckerRegistry copy(); 68 }