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  
21  package org.apache.directory.server.ldap.handlers.sasl;
22  
23  
24  /**
25   * SASL Constants used to store informations releated to the Challenge/response
26   * exchange during the SASL negociation.
27   *
28   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
29   */
30  public final class SaslConstants
31  {
32      /**
33       * A key constant for storing the SASL Server in the session.
34       */
35      public static final String SASL_SERVER = "saslServer";
36  
37      /**
38       * A key constant for storing the SASL host in the session
39       */
40      public static final String SASL_HOST = "host";
41  
42      /**
43       * A key constant used when creating a SaslServer
44       */
45      public static final String LDAP_PROTOCOL = "ldap";
46  
47      /**
48       * A key constant for storing the place where we are to search for user's pasword
49       */
50      public static final String SASL_USER_BASE_DN = "userBaseDn";
51  
52      /**
53       * A key constant for storing the current mechanism
54       */
55      public static final String SASL_MECH = "saslMech";
56  
57      /**
58       * A key constant for storing the authenticated user
59       */
60      public static final String SASL_AUTHENT_USER = "saslAuthentUser";
61  
62      /**
63       * A key constant for storing the evaluated credentials
64       */
65      public static final String SASL_CREDS = "saslCreds";
66  
67      /**
68       * A key constant for storing the Quality Of Protection
69       */
70      public static final String SASL_QOP = "saslQop";
71  
72      /**
73       * A key constant for storing the realm
74       */
75      public static final String SASL_REALM = "saslRealm";
76  
77      /**
78       * A key constant representing the SASL properties 
79       */
80      public static final String SASL_PROPS = "saslProps";
81  
82      /**
83       * A key constant representing the SASL mechanism handler
84       */
85      public static final String SASL_MECH_HANDLER = "saslmechHandler";
86  
87      /**
88       * A key constant representing the SASL IoFilter 
89       */
90      public static final String SASL_FILTER = "SASL_FILTER";
91  
92  
93      private SaslConstants()
94      {
95      }
96  }