org.kuali.rice.ksb.service

Interface BasicAuthenticationService

All Known Implementing Classes:

BasicAuthenticationServiceImpl

public interface BasicAuthenticationService

This class is used to register and validate services with basic authentication.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Modifier and Type	Method and Description
boolean	checkServiceAuthentication(String serviceNameSpaceURI, QName serviceName, String username, String password) Validates service authentication for the given serviceNameSpaceURI, serviceName, username and password
BasicAuthenticationConnectionCredentials	getConnectionCredentials(String serviceNameSpaceURI, String serviceName) Gets the connection credentials for the given serviceNameSpaceURI and serviceName
String	getPasswordForService(String serviceNameSpaceURI, QName serviceName, String username) Gets the password for the given serviceNameSpaceURI, serviceName, username
void	registerConnectionCredentials(BasicAuthenticationConnectionCredentials credentials) Registers the connection credentials of the service
void	registerServiceCredentials(BasicAuthenticationCredentials credentials) Registers the service credentials of the service

Method Detail

registerServiceCredentials

void registerServiceCredentials(BasicAuthenticationCredentials credentials)

Registers the service credentials of the service

Parameters:

credentials - the credentials for the service

registerConnectionCredentials

void registerConnectionCredentials(BasicAuthenticationConnectionCredentials credentials)

Registers the connection credentials of the service

Parameters:

credentials - the credentials for the service

getConnectionCredentials

BasicAuthenticationConnectionCredentials getConnectionCredentials(String serviceNameSpaceURI,
                                                                  String serviceName)

Gets the connection credentials for the given serviceNameSpaceURI and serviceName

Parameters:

serviceNameSpaceURI - the serviceNameSpaceURI of the service

serviceName - the serviceName of the service

Returns:

the BasicAuthenticationConnectionCredentials for the given serviceNameSpaceURI and serviceName

checkServiceAuthentication

boolean checkServiceAuthentication(String serviceNameSpaceURI,
                                   QName serviceName,
                                   String username,
                                   String password)

Validates service authentication for the given serviceNameSpaceURI, serviceName, username and password

Parameters:

serviceNameSpaceURI - the serviceNameSpaceURI of the service

serviceName - the serviceName of the service

username - the username for the service

password - the password for the service

Returns:

true if the service can be authenticated

getPasswordForService

String getPasswordForService(String serviceNameSpaceURI,
                             QName serviceName,
                             String username)

Gets the password for the given serviceNameSpaceURI, serviceName, username

Parameters:

serviceNameSpaceURI - the serviceNameSpaceURI of the service

serviceName - the serviceName of the service

username - the username for the service

Returns:

the password if the service is found