| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| */ |
| package org.apache.directory.server.schema.registries; |
| |
| |
| import org.apache.directory.shared.ldap.schema.AttributeType; |
| import org.apache.directory.shared.ldap.schema.OidNormalizer; |
| |
| import javax.naming.NamingException; |
| import java.util.Iterator; |
| import java.util.Map; |
| import java.util.Set; |
| |
| |
| /** |
| * An AttributeType registry service interface. |
| * |
| * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> |
| * @version $Rev$ |
| */ |
| public interface AttributeTypeRegistry extends SchemaObjectRegistry |
| { |
| /** |
| * Registers a new AttributeType with this registry. |
| * |
| * @param attributeType the AttributeType to register |
| * @throws NamingException if the AttributeType is already registered or |
| * the registration operation is not supported |
| */ |
| void register( AttributeType attributeType ) throws NamingException; |
| |
| |
| /** |
| * Gets a set of Strings representing the aliases, and numeric identifiers of |
| * all binary attributes. The set will contain all the aliases for a binary |
| * attributeType (one whose syntax is not human readible) along with its numeric |
| * identifier. |
| * |
| * @return set of aliases and numeric ids for binary attributeTypes |
| * @throws NamingException if there are issues resolving type information |
| */ |
| Set<String> getBinaryAttributes() throws NamingException; |
| |
| /** |
| * Looks up an AttributeType by its unique Object Identifier or by its |
| * unique name. |
| * |
| * @param id the object identifier or name of the AttributeType |
| * @return the AttributeType instance for the oid |
| * @throws NamingException if the AttributeType does not exist |
| */ |
| AttributeType lookup( String id ) throws NamingException; |
| |
| |
| /** |
| * Checks to see if an AttributeType exists. |
| * |
| * @param id the object identifier or name of the AttributeType |
| * @return true if an AttributeType definition exists for the oid, false |
| * otherwise |
| */ |
| boolean hasAttributeType( String id ); |
| |
| |
| /** |
| * Gets an Iterator over the AttributeTypes within this registry. |
| * |
| * @return an iterator over all AttributeTypes in registry |
| */ |
| Iterator<AttributeType> iterator(); |
| |
| |
| /** |
| * Gets an oid/name to normalizer mapping used to normalize distinguished |
| * names. |
| * |
| * @return a map of OID Strings to OidNormalizer instances |
| * @throws NamingException if for some reason this information cannot be returned |
| */ |
| Map<String, OidNormalizer> getNormalizerMapping() throws NamingException; |
| |
| /** |
| * Quick lookup to see if an attribute has descendants. |
| * |
| * @param ancestorId the name alias or OID for an attributeType |
| * @return an Iterator over the AttributeTypes which have the ancestor |
| * within their superior chain to the top |
| * @throws NamingException if the ancestor attributeType cannot be |
| * discerned from the ancestorId supplied |
| */ |
| boolean hasDescendants( String ancestorId ) throws NamingException; |
| |
| /** |
| * Get's an iterator over the set of descendant attributeTypes for |
| * some ancestor's name alias or their OID. |
| * |
| * @param ancestorId the name alias or OID for an attributeType |
| * @return an Iterator over the AttributeTypes which have the ancestor |
| * within their superior chain to the top |
| * @throws NamingException if the ancestor attributeType cannot be |
| * discerned from the ancestorId supplied |
| */ |
| Iterator<AttributeType> descendants( String ancestorId ) throws NamingException; |
| } |