it.reply.orchestrator.service

Interface IamService

All Known Implementing Classes:

IamServiceImpl

public interface IamService

Method Summary

Modifier and Type	Method and Description
void	assignOwnership(org.springframework.web.client.RestTemplate restTemplate, String clientId, String iamUrl, String accountId, String token) Assign the ownership of a client.
boolean	checkIam(org.springframework.web.client.RestTemplate restTemplate, String idpUrl) Check if a given idp ia an IAM.
Map<String,String>	createClient(org.springframework.web.client.RestTemplate restTemplate, String iamRegistration, String uuid, String userEmail, String scopes) Create an IAM client setting the minimal information, in addition to the mail field.
void	deleteAllClients(org.springframework.web.client.RestTemplate restTemplate, Map<Boolean,Set<Resource>> resources, Boolean force) Delete all the clients stored in resources.
boolean	deleteClient(org.springframework.web.client.RestTemplate restTemplate, String clientId, String iamUrl, String token) Delete a client.
String	getInfoIamClient(org.springframework.web.client.RestTemplate restTemplate, String clientId, String iamUrl, String token) Get information about a client.
String	getOrchestratorScopes() getOrchestratorScopes.
String	getTokenClientCredentials(org.springframework.web.client.RestTemplate restTemplate, String iamClientId, String iamClientSecret, String iamClientScopes, String iamTokenEndpoint) Get a token with client credentials as grant type.
WellKnownResponse	getWellKnown(org.springframework.web.client.RestTemplate restTemplate, String issuer) Create a WellKnownResponse object for an IAM idp containing registration_endpoint, token_endpoint, and scopes_supported.
String	updateClient(org.springframework.web.client.RestTemplate restTemplate, String clientId, String iamUrl, String token, String jsonUpdated) Update information about a client.

Method Detail

getOrchestratorScopes

String getOrchestratorScopes()

getOrchestratorScopes.

Returns:

the orchestrator scopes

getWellKnown

WellKnownResponse getWellKnown(org.springframework.web.client.RestTemplate restTemplate,
                               String issuer)

Create a WellKnownResponse object for an IAM idp containing registration_endpoint, token_endpoint, and scopes_supported.

Parameters:

restTemplate - object used to make HTTP requests

issuer - the identity provider

Returns:

the WellKnownResponse object

getTokenClientCredentials

String getTokenClientCredentials(org.springframework.web.client.RestTemplate restTemplate,
                                 String iamClientId,
                                 String iamClientSecret,
                                 String iamClientScopes,
                                 String iamTokenEndpoint)

Get a token with client credentials as grant type.

Parameters:

restTemplate - object used to make HTTP requests

iamClientId - client_id

iamClientSecret - client_secret

iamClientScopes - scopes to ask in the request

iamTokenEndpoint - IAM token endpoint

Returns:

the token with client credentials as grant type

createClient

Map<String,String> createClient(org.springframework.web.client.RestTemplate restTemplate,
                                String iamRegistration,
                                String uuid,
                                String userEmail,
                                String scopes)

Create an IAM client setting the minimal information, in addition to the mail field. As output it gives the client_id and registration_access_token of the created client.

Parameters:

restTemplate - object used to make HTTP requests

iamRegistration - registration endpoint used to create a client

uuid - uuid of the deployment, used to set the client name

userEmail - user email, used to set the contacts field of the client

scopes - scopes to set for the new client

Returns:

a map of client_id:registration_access_token

deleteClient

boolean deleteClient(org.springframework.web.client.RestTemplate restTemplate,
                     String clientId,
                     String iamUrl,
                     String token)

Delete a client.

Parameters:

restTemplate - object used to make HTTP requests

clientId - client_id

iamUrl - IAM endpoint to contact for the client deletion

token - the registration_access_token used for the deletion

Returns:

true if the deletion has been successful

deleteAllClients

void deleteAllClients(org.springframework.web.client.RestTemplate restTemplate,
                      Map<Boolean,Set<Resource>> resources,
                      Boolean force)

Delete all the clients stored in resources.

Parameters:

restTemplate - object used to make HTTP requests

resources - resources linked to a given deployment

force - flag to force the deletion of a deployment skipping the deletion of IAM clients

assignOwnership

void assignOwnership(org.springframework.web.client.RestTemplate restTemplate,
                     String clientId,
                     String iamUrl,
                     String accountId,
                     String token)

Assign the ownership of a client.

Parameters:

restTemplate - object used to make HTTP requests

clientId - client_id

iamUrl - IAM Url

accountId - the id of the owner to be assigned to the client

token - the token with client credentials as grant type using the orchestrator client

checkIam

boolean checkIam(org.springframework.web.client.RestTemplate restTemplate,
                 String idpUrl)

Check if a given idp ia an IAM.

Parameters:

restTemplate - object used to make HTTP requests

idpUrl - Url to be checked if it is an IAM or not

Returns:

true if the idpurl is an IAM, otherwise false

getInfoIamClient

String getInfoIamClient(org.springframework.web.client.RestTemplate restTemplate,
                        String clientId,
                        String iamUrl,
                        String token)

Get information about a client.

Parameters:

restTemplate - object used to make HTTP requests

clientId - client_id

iamUrl - IAM Url

token - the token to use

Returns:

the json obtained as output from the HTPP request

updateClient

String updateClient(org.springframework.web.client.RestTemplate restTemplate,
                    String clientId,
                    String iamUrl,
                    String token,
                    String jsonUpdated)

Update information about a client.

Parameters:

restTemplate - object used to make HTTP requests

clientId - client_id

iamUrl - IAM Url

token - the token to use

jsonUpdated - the updated json obtained as output

Returns:

the json with the updated info about the client