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   * An enum describing the three possible actions for referrals :
24   * <ul>
25   * <li>Ignore : The referrals will be retruned as is (ie, the 'ref' attribute type will be present in the entry</li>
26   * <li>Follow : The referral will be chased by the client</li>
27   * <li>Throws : An LdapReferralException will be thrown</li>
28   * </ul>
29   * @author <a href="mailto:dev@directory.apache.org"> Apache Directory Project</a>
30   */
31  public enum ReferralsPolicyEnum
32  {
33      IGNORE,
34      FOLLOW,
35      THROW
36  }