com.sap.it.api.securestore

Interface SecureStoreService

All Superinterfaces:

ITApi

public interface SecureStoreService
extends ITApi

Public API to access the deployed user credentials or the access tokens of the OAuth2 Authorization Code credentials

Method Summary

Modifier and Type	Method and Description
AccessTokenAndUser	getAccesTokenForOauth2AuthorizationCodeCredential(String credentialName) Returns AccessTokenAndUser the access token and user name for an OAuth2 Authorization Code credential.
UserCredential	getUserCredential(String alias) Returns UserCredential containing user credential details deployed on the node against given alias.

Method Detail

getUserCredential

UserCredential getUserCredential(String alias)
                          throws SecureStoreException

Returns UserCredential containing user credential details deployed on the node against given alias.

Parameters:

alias - - the alias used while deploying the user credentials

Returns:

- UserCredential containing details like username and associated properties

Throws:

SecureStoreException - if the provided alias is null or empty, if user credential for the alias does not exist, or any other error occurs, like SercureStore service is not started

getAccesTokenForOauth2AuthorizationCodeCredential

AccessTokenAndUser getAccesTokenForOauth2AuthorizationCodeCredential(String credentialName)
                                                              throws SecureStoreException

Returns AccessTokenAndUser the access token and user name for an OAuth2 Authorization Code credential. The access token is fetched from the OAuth2 authorization server via refresh_token grant type and cached by the implementation. If the access token expires then a new access token is fetched.

Parameters:

credentialName - name of an OAuth2 Authorization Code credential

Returns:

access token and user name

Throws:

SecureStoreException - if the provided credentialName is null or empty, if an OAuth2 Authorization Code credential for the credentialName does not exist, or any other error occurs, like connection problems to the OAUTH authentication server, or the OAuth2 Authorization credential does not yet have a refresh token (because the "Authorize" step was not executed by the Administrator)