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.api.ldap.model.constants;
22  
23  
24  /**
25   * This class contains all the Ldap specific properties described in the JNDI API.
26   * See http://java.sun.com/j2se/1.5.0/docs/guide/jndi/jndi-ldap-gl.html
27   * Final reference -> class shouldn't be extended
28   *
29   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
30   */
31  public final class JndiPropertyConstants
32  {
33      /**
34       *  Ensures no construction of this class, also ensures there is no need for final keyword above
35       *  (Implicit super constructor is not visible for default constructor),
36       *  but is still self documenting.
37       */
38      private JndiPropertyConstants()
39      {
40      }
41  
42      // Pure JNDI properties
43      /** Batch size of search results returned */
44      public static final String JNDI_BATCHSIZE = "java.naming.batchsize";
45  
46      /** List of FQCNs of the control factory classes */
47      public static final String JNDI_FACTORY_CONTROL = "java.naming.factory.control";
48  
49      /** FQCN of the factory creating the InitialContext */
50      public static final String JNDI_FACTORY_INITIAL = "java.naming.factory.initial";
51  
52      /** List of FQCNs of the Object factory */
53      public static final String JNDI_FACTORY_OBJECT = "java.naming.factory.object";
54  
55      /** List of FQCNs of the state factory */
56      public static final String JNDI_FACTORY_STATE = "java.naming.factory.state";
57  
58      /** The Language to use */
59      public static final String JNDI_LANGUAGE = "java.naming.language";
60  
61      /** The list of URL pointing to a LDAP server */
62      public static final String JNDI_PROVIDER_URL = "java.naming.provider.url";
63  
64      /** Tells how the referral should be handled */
65      public static final String JNDI_REFERRAL = "java.naming.referral";
66  
67      /** The Authentication mechanism */
68      public static final String JNDI_SECURITY_AUTHENTICATION = "java.naming.security.authentication";
69  
70      /** The credentials */
71      public static final String JNDI_SECURITY_CREDENTIALS = "java.naming.security.credentials";
72  
73      /** The Principal */
74      public static final String JNDI_SECURITY_PRINCIPAL = "java.naming.security.principal";
75  
76      /** The security protocol to use */
77      public static final String JNDI_SECURITY_PROTOCOL = "java.naming.security.protocol";
78  
79      // Ldap specific properties
80      /** The list of binary attributes */
81      public static final String JNDI_LDAP_ATTRIBUTES_BINARY = "java.naming.ldap.attributes.binary";
82  
83      /** The controls to send when connectiong */
84      public static final String JNDI_LDAP_CONTROL_CONNECT = "java.naming.ldap.control.connect";
85  
86      /** Tells if the old Rdn must be deleted when doing a MODDN */
87      public static final String JNDI_LDAP_DELETE_RDN = "java.naming.ldap.deleteRDN";
88  
89      /** Tells if and how we dereference aliases */
90      public static final String JNDI_LDAP_DAP_DEREF_ALIASES = "java.naming.ldap.derefAliases";
91  
92      /** The FQCN of the socket factory to use to connect to the server */
93      public static final String JNDI_FACTORY_SOCKET = "java.naming.ldap.factory.socket";
94  
95      /** The separator to use when dealing with RefAddr */
96      public static final String JNDI_LDAP_REF_SEPARATOR = "java.naming.ldap.ref.separator";
97  
98      /** The maximum number of referral to follow in a chain of referrals */
99      public static final String JNDI_LDAP_REFERRAL_LIMIT = "java.naming.ldap.referral.limit";
100 
101     /** tells that we want the attributeTypes only to be returned */
102     public static final String JNDI_LDAP_TYPES_ONLY = "java.naming.ldap.typesOnly";
103 
104     /** Specifies the LDAP version to use */
105     public static final String JNDI_LDAP_VERSION = "java.naming.ldap.version";
106 
107     // SASL properties
108     /** The SASL authorization ID */
109     public static final String JNDI_SASL_AUTHORIZATION_ID = "java.naming.security.sasl.authorizationId";
110 
111     /** The SASL Realm */
112     public static final String JNDI_SASL_REALM = "java.naming.security.sasl.realm";
113 
114     /** An instance of CallbackHandler to use when required */
115     public static final String JNDI_SASL_CALLBACK = "java.naming.security.sasl.callback";
116 
117     /** The SASL Quality Of Protection value */
118     public static final String JNDI_SASL_QOP = "javax.security.sasl.qop";
119 
120     /** The cipher strength */
121     public static final String JNDI_SASL_STRENGTH = "javax.security.sasl.strength";
122 
123     /** The maximum size of the receive buffer */
124     public static final String JNDI_SASL_MAX_BUFFER = "javax.security.sasl.maxbuffer";
125 
126     /** Tells if the the server must authenticate the client */
127     public static final String JNDI_SASL_AUTHENTICATION = "javax.security.sasl.server.authentication";
128 
129     /** Tells if the server must support forward secrecy */
130     public static final String JNDI_SASL_POLICY_FORWARD = "javax.security.sasl.policy.forward";
131 
132     /** Tells if the server must require some credentials */
133     public static final String JNDI_SASL_POLICY_CREDENTIALS = "javax.security.sasl.policy.credentials";
134 
135     /** Tells if the server allow Plain text mechanism */
136     public static final String JNDI_SASL_POLICY_NO_PLAIN_TEXT = "javax.security.sasl.policy.noplaintext";
137 
138     /** Tells if the SASL mechanism is protected against active attacks */
139     public static final String JNDI_SASL_POLICY_NO_ACTIVE = "javax.security.sasl.policy.noactive";
140 
141     /** Tells if the SASL mechanism is protected against dictionary attacks */
142     public static final String JNDI_SASL_POLICY_NO_DICTIONARY = "javax.security.sasl.policy.nodictionary";
143 
144     /** Tells if the SASL mechanism accept or not anonymous connections */
145     public static final String JNDI_SASL_POLICY_NO_ANONYMOUS = "javax.security.sasl.policy.noanonymous";
146 }