com.intel.cosbench.api.auth
Interface AuthAPI

All Known Implementing Classes:

KeystoneAuth, NoneAuth, SwiftAuth

public interface AuthAPI

Method Summary

void	dispose() clean up Auth API.
Context	getParms() retrieve parameters and current settings used by the AuthAPI.
void	init(Config config, Logger logger) initialize Auth API with parameters contained in config, the parameter list depends on auth type.
AuthContext	login() trigger backend authentication mechanism.

Method Detail

init

void init(Config config,
          Logger logger)

initialize Auth API with parameters contained in config, the parameter list depends on auth type.

Parameters:

config - - one instance from “com.intel.cosbench.config.Config” class, which includes parameters for authentication.

logger - - one instance from “com.intel.cosbench.log.Logger” class, which delivers logging capabilities to Auth API.

login

AuthContext login()

trigger backend authentication mechanism.

Returns:

AuthContext - one AuthContext instance which contains information which can attest if authentication is passed or not.

getParms

Context getParms()

retrieve parameters and current settings used by the AuthAPI.

Returns:

Context - one Context instance which contains all parameters configured for the authentication mechanism.

dispose

void dispose()

clean up Auth API.