/*
    *  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
    *  
   *    https://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.api.ldap.model.schema.registries;
  
  
  import java.util.Iterator;
  import java.util.Map;
  
  import org.apache.directory.api.i18n.I18n;
  import org.apache.directory.api.ldap.model.exception.LdapException;
  import org.apache.directory.api.ldap.model.exception.LdapNoSuchAttributeException;
  import org.apache.directory.api.ldap.model.exception.LdapUnwillingToPerformException;
  import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
  import org.apache.directory.api.ldap.model.schema.AttributeType;
  import org.apache.directory.api.ldap.model.schema.SchemaObjectType;
  import org.apache.directory.api.ldap.model.schema.normalizers.OidNormalizer;
  
  
  /**
   * An immutable wrapper of the AttributeType registry.
   *
   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
   */
  public class ImmutableAttributeTypeRegistry implements AttributeTypeRegistry
  {
      /** The wrapped AttributeType registry */
      AttributeTypeRegistry immutableAttributeTypeRegistry;
  
  
      /**
       * Creates a new instance of ImmutableAttributeTypeRegistry.
       *
       * @param attributeTypeRegistry The wrapped AttributeType registry
       */
      public ImmutableAttributeTypeRegistry( AttributeTypeRegistry attributeTypeRegistry )
      {
          immutableAttributeTypeRegistry = attributeTypeRegistry;
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public Map<String, OidNormalizer> getNormalizerMapping()
      {
          return immutableAttributeTypeRegistry.getNormalizerMapping();
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
  public boolean hasDescendants( String ancestorId ) throws LdapException
      {
          return immutableAttributeTypeRegistry.hasDescendants( ancestorId );
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public boolean hasDescendants( AttributeType ancestor ) throws LdapException
      {
          return immutableAttributeTypeRegistry.hasDescendants( ancestor );
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public Iterator<AttributeType> descendants( String ancestorId ) throws LdapException
      {
          return immutableAttributeTypeRegistry.descendants( ancestorId );
      }
  
  
      /**
       * {@inheritDoc}
      */
     @Override
     public Iterator<AttributeType> descendants( AttributeType ancestor ) throws LdapException
     {
         return immutableAttributeTypeRegistry.descendants( ancestor );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void register( AttributeType attributeType ) throws LdapException
     {
         throw new LdapUnwillingToPerformException( ResultCodeEnum.NO_SUCH_OPERATION, I18n.err( I18n.ERR_13701_CANNOT_MODIFY_AT_REGISTRY_COPY ) );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void registerDescendants( AttributeType attributeType, AttributeType ancestor ) throws LdapException
     {
         throw new LdapUnwillingToPerformException( ResultCodeEnum.NO_SUCH_OPERATION, I18n.err( I18n.ERR_13701_CANNOT_MODIFY_AT_REGISTRY_COPY ) );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void unregisterDescendants( AttributeType attributeType, AttributeType ancestor ) throws LdapException
     {
         throw new LdapUnwillingToPerformException( ResultCodeEnum.NO_SUCH_OPERATION, I18n.err( I18n.ERR_13701_CANNOT_MODIFY_AT_REGISTRY_COPY ) );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public AttributeType unregister( String numericOid ) throws LdapException
     {
         throw new LdapUnwillingToPerformException( ResultCodeEnum.NO_SUCH_OPERATION,
             I18n.err( I18n.ERR_13701_CANNOT_MODIFY_AT_REGISTRY_COPY ) );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void addMappingFor( AttributeType attributeType ) throws LdapException
     {
         throw new LdapUnwillingToPerformException( ResultCodeEnum.NO_SUCH_OPERATION, 
             I18n.err( I18n.ERR_13701_CANNOT_MODIFY_AT_REGISTRY_COPY ) );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void removeMappingFor( AttributeType attributeType ) throws LdapException
     {
         throw new LdapUnwillingToPerformException( ResultCodeEnum.NO_SUCH_OPERATION, I18n.err( I18n.ERR_13701_CANNOT_MODIFY_AT_REGISTRY_COPY ) );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public AttributeType lookup( String oid ) throws LdapException
     {
         return immutableAttributeTypeRegistry.lookup( oid );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String toString()
     {
         return immutableAttributeTypeRegistry.toString();
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public AttributeTypeRegistry copy()
     {
         return immutableAttributeTypeRegistry.copy();
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public int size()
     {
         return immutableAttributeTypeRegistry.size();
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Iterator<AttributeType> iterator()
     {
         return immutableAttributeTypeRegistry.iterator();
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Iterator<String> oidsIterator()
     {
         return immutableAttributeTypeRegistry.oidsIterator();
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public boolean contains( String oid )
     {
         return immutableAttributeTypeRegistry.contains( oid );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getOidByName( String name ) throws LdapException
     {
         try
         {
             return immutableAttributeTypeRegistry.getOidByName( name );
         }
         catch ( LdapException le )
         {
             throw new LdapNoSuchAttributeException( le.getMessage(), le );
         }
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getSchemaName( String oid ) throws LdapException
     {
         return immutableAttributeTypeRegistry.getSchemaName( oid );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public SchemaObjectType getType()
     {
         return immutableAttributeTypeRegistry.getType();
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void renameSchema( String originalSchemaName, String newSchemaName )
     {
         // Do nothing
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void unregisterSchemaElements( String schemaName ) throws LdapException
     {
         throw new LdapUnwillingToPerformException( ResultCodeEnum.NO_SUCH_OPERATION, I18n.err( I18n.ERR_13701_CANNOT_MODIFY_AT_REGISTRY_COPY ) );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public AttributeType get( String oid )
     {
         return immutableAttributeTypeRegistry.get( oid );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void clear() throws LdapException
     {
         throw new LdapUnwillingToPerformException( ResultCodeEnum.NO_SUCH_OPERATION, I18n.err( I18n.ERR_13701_CANNOT_MODIFY_AT_REGISTRY_COPY ) );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public AttributeType unregister( AttributeType schemaObject ) throws LdapException
     {
         throw new LdapUnwillingToPerformException( ResultCodeEnum.NO_SUCH_OPERATION, I18n.err( I18n.ERR_13701_CANNOT_MODIFY_AT_REGISTRY_COPY ) );
     }
 }