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.model.message;
21  
22  
23  /**
24   * Protocol request and response altering control interface. Any number of
25   * controls may be associated with a protocol message. Each control may be
26   * associated with a Request, a response, or both.
27   * 
28   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
29   */
30  public interface Control
31  {
32      /**
33       * @return The Control's OID
34       */
35      String getOid();
36  
37  
38      /**
39       * Tells if the control is critical or not.
40       *
41       * @return <code>true</code> if the control is critical, <code>false</code> otherwise 
42       */
43      boolean isCritical();
44  
45  
46      /**
47       * Sets the critical flag which determines whether or not this control is
48       * critical for the correct operation of a request or response message. The
49       * default for this value should be false.
50       * 
51       * @param isCritical true if the control is critical false otherwise.
52       */
53      void setCritical( boolean isCritical );
54  }