Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
CredentialsSource |
|
| 1.0;1 |
1 | /* | |
2 | * Copyright 2005-2007 The Kuali Foundation | |
3 | * | |
4 | * | |
5 | * Licensed under the Educational Community License, Version 2.0 (the "License"); | |
6 | * you may not use this file except in compliance with the License. | |
7 | * You may obtain a copy of the License at | |
8 | * | |
9 | * http://www.opensource.org/licenses/ecl2.php | |
10 | * | |
11 | * Unless required by applicable law or agreed to in writing, software | |
12 | * distributed under the License is distributed on an "AS IS" BASIS, | |
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
14 | * See the License for the specific language governing permissions and | |
15 | * limitations under the License. | |
16 | */ | |
17 | package org.kuali.rice.core.api.security.credentials; | |
18 | ||
19 | /** | |
20 | * Inteface for abstracting out how we obtain credentials to access secure | |
21 | * applications across the bus. | |
22 | * | |
23 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
24 | * @since 0.9 | |
25 | */ | |
26 | public interface CredentialsSource { | |
27 | ||
28 | /** | |
29 | * Returns the supported CredentialsType. This should never be null. | |
30 | * | |
31 | * @return the supported credentials type. | |
32 | */ | |
33 | CredentialsType getSupportedCredentialsType(); | |
34 | ||
35 | /** | |
36 | * Returns the SecurityContext which should have the proper credentials to | |
37 | * give to any system requiring credentials. This class has no guarantees | |
38 | * what a user will do with the credentials and should thus always return a | |
39 | * thread-safe version. | |
40 | * | |
41 | * @param serviceDefinition The Service Definition for which we want | |
42 | * credentials for. | |
43 | * @return the credentials, or null if credentials could not be obtained. | |
44 | */ | |
45 | Credentials getCredentials(String serviceEndpoint); | |
46 | } |