View Javadoc

1   /*
2    * Copyright 2002-2005 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package net.sf.ldaptemplate;
18  
19  import javax.naming.directory.DirContext;
20  
21  import org.springframework.dao.DataAccessException;
22  
23  /***
24   * Interface used to retrieve and authenticate LDAP contexts.
25   * 
26   * @see net.sf.ldaptemplate.LdapTemplate
27   * 
28   * @author Adam Skogman
29   * @author Mattias Arthursson
30   */
31  public interface ContextSource {
32  
33      /***
34       * Gets a read only LDAP context. You are only gaurrantied that you can read
35       * from the context, but it is not enforced.
36       * 
37       * @return An DirContext, never null.
38       * @throws DataAccessException
39       *             if some error occurs creating an DirContext.
40       */
41      public DirContext getReadOnlyContext() throws DataAccessException;
42  
43      /***
44       * Gets a read-write LDAP context.
45       * 
46       * @return an DirContext, never null.
47       * @throws DataAccessException
48       *             if some error occurs creating an DirContext.
49       */
50      public DirContext getReadWriteContext() throws DataAccessException;
51  }