001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020 package org.apache.directory.shared.ldap.schema.registries; 021 022 023 import org.apache.directory.shared.ldap.exception.LdapException; 024 import org.apache.directory.shared.ldap.schema.SyntaxChecker; 025 026 027 /** 028 * SyntaxChecker registry component's service interface. 029 * 030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 031 * @version $Rev: 923524 $ 032 */ 033 public interface SyntaxCheckerRegistry extends SchemaObjectRegistry<SyntaxChecker>, 034 Iterable<SyntaxChecker> 035 { 036 /** 037 * Registers a new SyntaxChecker with this registry. 038 * 039 * @param syntaxChecker the SyntaxChecker to register 040 * @throws LdapException if the SyntaxChecker is already registered or 041 * the registration operation is not supported 042 */ 043 void register( SyntaxChecker syntaxChecker ) throws LdapException; 044 045 046 /** 047 * Removes the SyntaxChecker registered with this registry, using its 048 * numeric OID. 049 * 050 * @param numericOid the numeric identifier 051 * @throws LdapException if the numeric identifier is invalid 052 */ 053 SyntaxChecker unregister( String numericOid ) throws LdapException; 054 055 056 /** 057 * Unregisters all SyntaxCheckers defined for a specific schema from 058 * this registry. 059 * 060 * @param schemaName the name of the schema whose SyntaxCheckers will be removed from 061 */ 062 void unregisterSchemaElements( String schemaName ) throws LdapException; 063 064 065 /** 066 * Copy the SyntaxCheckerRegistry 067 */ 068 SyntaxCheckerRegistry copy(); 069 }