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 */
020package org.apache.directory.api.ldap.codec.api;
021
022
023/**
024 * An interface used to abstract the means to detect whether or not an attribute
025 * identifier/descriptor represents a binary attributeType.
026 */
027public interface ConfigurableBinaryAttributeDetector extends BinaryAttributeDetector
028{
029    /**
030     * Add some binary Attributes Id to the list of attributes
031     * 
032     * @param binaryAttributes The added binary attributes Id
033     */
034    void addBinaryAttribute( String... binaryAttributes );
035
036
037    /**
038     * Remove some binary Attributes Id from the list of attributes
039     * 
040     * @param binaryAttributes The binary attributes Id to remove
041     */
042    void removeBinaryAttribute( String... binaryAttributes );
043
044
045    /**
046     * Inject a new set of binary attributes that will replace the old one.
047     * If one inject a null set of attributes, the list of attributes will be
048     * cleared, and reset to the default list of binary attributes. If one
049     * injects an empty String array, then all the attributes will be removed
050     * from the list, and we won't inject the default attributes into it.
051     * 
052     * @param binaryAttributes The new set of binary attributes
053     */
054    void setBinaryAttributes( String... binaryAttributes );
055}