View Javadoc
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.codec.api;
21  
22  
23  /**
24   * An interface used to abstract the means to detect whether or not an attribute
25   * identifier/descriptor represents a binary attributeType.
26   */
27  public interface ConfigurableBinaryAttributeDetector extends BinaryAttributeDetector
28  {
29      /**
30       * Add some binary Attributes Id to the list of attributes
31       * 
32       * @param binaryAttributes The added binary attributes Id
33       */
34      void addBinaryAttribute( String... binaryAttributes );
35  
36  
37      /**
38       * Remove some binary Attributes Id from the list of attributes
39       * 
40       * @param binaryAttributes The binary attributes Id to remove
41       */
42      void removeBinaryAttribute( String... binaryAttributes );
43  
44  
45      /**
46       * Inject a new set of binary attributes that will replace the old one.
47       * If one inject a null set of attributes, the list of attributes will be
48       * cleared, and reset to the default list of binary attributes. If one
49       * injects an empty String array, then all the attributes will be removed
50       * from the list, and we won't inject the default attributes into it.
51       * 
52       * @param binaryAttributes The new set of binary attributes
53       */
54      void setBinaryAttributes( String... binaryAttributes );
55  }