View Javadoc

1   /*
2    * Copyright 2005-2008 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 org.springframework.ldap.core;
18  
19  /**
20   * An <code>AuthenticationSource</code> is responsible for providing the
21   * principal (user DN) and credentials to be used when creating a new context.
22   * 
23   * @author Mattias Hellborg Arthursson
24   * 
25   */
26  public interface AuthenticationSource {
27      /**
28       * Get the principal to use when creating an authenticated context.
29       * 
30       * @return the principal (userDn).
31       */
32      String getPrincipal();
33  
34      /**
35       * Get the credentials to use when creating an authenticated context.
36       * 
37       * @return the credentials (password).
38       */
39      String getCredentials();
40  }