1 /**
2 * Copyright 2005-2012 The Kuali Foundation
3 *
4 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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 package org.kuali.rice.ksb.service;
17
18 import javax.xml.namespace.QName;
19
20 /**
21 * This class is used to register and validate services with basic authentication.
22 *
23 * @author Kuali Rice Team (rice.collab@kuali.org)
24 */
25 public interface BasicAuthenticationService {
26
27 /**
28 * Registers the service credentials of the service
29 *
30 * @param credentials the credentials for the service
31 */
32 public void registerServiceCredentials(BasicAuthenticationCredentials credentials);
33
34 /**
35 * Registers the connection credentials of the service
36 *
37 * @param credentials the credentials for the service
38 */
39 public void registerConnectionCredentials(BasicAuthenticationConnectionCredentials credentials);
40
41 /**
42 * Gets the connection credentials for the given serviceNameSpaceURI and serviceName
43 *
44 * @param serviceNameSpaceURI the serviceNameSpaceURI of the service
45 * @param serviceName the serviceName of the service
46 * @return the BasicAuthenticationConnectionCredentials for the given serviceNameSpaceURI and serviceName
47 */
48 public BasicAuthenticationConnectionCredentials getConnectionCredentials(String serviceNameSpaceURI,
49 String serviceName);
50
51 /**
52 * Validates service authentication for the given serviceNameSpaceURI, serviceName, username and password
53 *
54 * @param serviceNameSpaceURI the serviceNameSpaceURI of the service
55 * @param serviceName the serviceName of the service
56 * @param username the username for the service
57 * @param password the password for the service
58 * @return true if the service can be authenticated
59 */
60 public boolean checkServiceAuthentication(String serviceNameSpaceURI, QName serviceName, String username,
61 String password);
62
63 }