com.siemens.mindsphere.sdk.agentmanagement.apiclient

Class AgentsDefaultSettingClient

Object

MindsphereAPIClient

AgentsDefaultSettingClient

public class AgentsDefaultSettingClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentsDefaultSettingClient.ClientBuilder

Nested classes/interfaces inherited from class MindsphereAPIClient

MindsphereAPIClient.Builder<T extends MindsphereAPIClient.Builder<T>>

Field Summary

Fields inherited from class MindsphereAPIClient

credentials, restClientConfig, restTemplate

Constructor Summary

Constructors

Constructor and Description
AgentsDefaultSettingClient(AgentsDefaultSettingClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static AgentsDefaultSettingClient.ClientBuilder	builder()
CreatedObjects	getAccessToken(String entityId) Creates an agent for the given asset id, on boards the agent and grants an access token.
CreatedObjects	getAccessToken(String entityId, String agentName) Creates an agent for the given asset id, on boards the agent and grants an access token.
CreatedObjects	getAccessToken(String entityId, String agentName, Agent.SecurityProfileEnum profile) Creates an agent for the given asset id, on boards the agent and grants an access token.
AccessToken	getAccessTokenAfterOnBoardedWithSharedSecret(String agentID, String tenant, String clientSecret) Grants an access token when status is "ON BOARDED" for agents with SHARED_SECRET security profile.
CreatedObjects	getAccessTokenDuringStatusOnBoarding(String agentId) On boards the agent and grants an access token when status is "ON BOARDING".
CreatedObjects	getAccessTokenForAgent(String agentId) On boards the agent and grants an access token.
CreatedObjects	getAccessTokenForAgent(String agentId, String tenant) On boards the agent and grants an access token.
CreatedObjects	getAccessTokenForEntity(String entityId, String tenant) Creates an agent for the given asset id, on boards the agent and grants an access token.
AccessToken	getAccessTokenFromClientAssertion(String clientAssertion) Grants an Access Token using client assertion which can be used to access mindsphere services.
CreatedObjects	getAccessTokenWithOnBoardingConfig(BoardingConfiguration boardingConfig) On boards the agent and grants an access token.
CreatedObjects	getAccessTokenWithRSA(String entityId) Creates an agent for the given asset id, on boards the agent and grants an access token.
CreatedObjects	getAccessTokenWithSharedSecret(String entityId) Creates an agent for the given asset id, on boards the agent and grants an access token.
String	getClientAssertionForRSAProfile(String agentID, String tenant) It generates client assertion for an agent with RSA profile.
String	getClientAssertionForSharedSecret(String agentID, String tenant, String clientSecret) It generates client assertion for an agent with SHARED SECRET profile.
JWKModel	getKeysForRSAProfile() It geneartes RSA public and private keys.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AgentsDefaultSettingClient

public AgentsDefaultSettingClient(AgentsDefaultSettingClient.ClientBuilder builder)

Method Detail

builder

public static AgentsDefaultSettingClient.ClientBuilder builder()

getAccessToken

public CreatedObjects getAccessToken(String entityId)
                              throws MindsphereException

Creates an agent for the given asset id, on boards the agent and grants an access token. Grants an Access Token which can be used to access mindsphere services. This method serves as quick start method to on board an agent and get an access token. It creates an agent for the given asset with "SHARED_SECRET" security profile. It gets boarding configuration and on boards the agent using the client secret. It creates a client assertion signs it with client secret and gets a token. All the created record sets are returned to the caller in response. Data source is not configured by default, so user has to configure the data points as per the requirement.

200 - OK

400 - Bad Request

Parameters:

entityId - asset Id

Returns:

CreatedObjects Returns a list of objects created during this process.

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

getAccessTokenWithSharedSecret

public CreatedObjects getAccessTokenWithSharedSecret(String entityId)
                                              throws MindsphereException

Creates an agent for the given asset id, on boards the agent and grants an access token. Grants an Access Token which can be used to access mindsphere services. This method serves as quick start method to on board an agent and get an access token. It creates an agent for the given asset with "SHARED_SECRET" security profile. It gets boarding configuration and on boards the agent using the client secret. It creates a client assertion signs it with client secret and gets a token. All the created record sets are returned to the caller in response. Data source is not configured by default, so user has to configure the data points as per the requirement.

200 - OK

400 - Bad Request

Parameters:

entityId - asset Id

Returns:

CreatedObjects Returns a list of objects created during this process.

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

getAccessTokenWithRSA

public CreatedObjects getAccessTokenWithRSA(String entityId)
                                     throws MindsphereException

Creates an agent for the given asset id, on boards the agent and grants an access token. Grants an Access Token which can be used to access mindsphere services. This method serves as quick start method to on board an agent and get an access token. It creates an agent for the given asset with "RSA" security profile. It gets boarding configuration and on boards the agent using the client secret. It creates a client assertion signs it with client secret and gets a token. All the created record sets are returned to the caller in response. Data source is not configured by default, so user has to configure the data points as per the requirement.

200 - OK

400 - Bad Request

Parameters:

entityId - asset Id

Returns:

CreatedObjects Returns a list of objects created during this process.

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

getAccessTokenForAgent

public CreatedObjects getAccessTokenForAgent(String agentId)
                                      throws MindsphereException

On boards the agent and grants an access token. Grants an Access Token which can be used to access mindsphere services. This serves as quick start method to on board the given agent and get an access token. It gets boarding configuration and on boards the agent using the client secret. It creates a client assertion signs it with client secret and gets a token. All the created record sets are returned to the caller in response. Data source is not configured by default, so user has to configure the data points as per the requirement.

200 - OK

400 - Bad Request

Parameters:

agentId - agentId.

Returns:

CreatedObjects Returns a list of objects created during this process.

Throws:

MindsphereException - if an error occurs while attempting to invoke the API boarding configuration is interrupted

getAccessTokenForEntity

public CreatedObjects getAccessTokenForEntity(String entityId,
                                              String tenant)
                                       throws MindsphereException

Creates an agent for the given asset id, on boards the agent and grants an access token. Grants an Access Token which can be used to access mindsphere services. This method serves as quick start method to on board an agent and get an access token. It creates an agent for the given asset with "SHARED_SECRET" security profile. It gets boarding configuration and on boards the agent using the client secret. It creates a client assertion signs it with client secret and gets a token. All the created record sets are returned to the caller in response. Data source is not configured by default, so user has to configure the data points as per the requirement.

200 - OK

400 - Bad Request

Parameters:

entityId - asset Id

tenant - tenant

Returns:

CreatedObjects Returns a list of objects created during this process.

Throws:

MindsphereException - if an error occurs while attempting to invoke the API boarding configuration is interrupted

getAccessTokenForAgent

public CreatedObjects getAccessTokenForAgent(String agentId,
                                             String tenant)
                                      throws MindsphereException

On boards the agent and grants an access token. Grants an Access Token which can be used to access mindsphere services. This serves as quick start method to on board the given agent and get an access token. It gets boarding configuration and on boards the agent using the client secret. It creates a client assertion signs it with client secret and gets a token. All the created record sets are returned to the caller in response. Data source is not configured by default, so user has to configure the data points as per the requirement.

200 - OK

400 - Bad Request

Parameters:

agentId - agentId.

tenant - tenant.

Returns:

CreatedObjects Returns a list of objects created during this process.

Throws:

MindsphereException - if an error occurs while attempting to invoke the API boarding configuration is interrupted

getAccessTokenWithOnBoardingConfig

public CreatedObjects getAccessTokenWithOnBoardingConfig(BoardingConfiguration boardingConfig)
                                                  throws MindsphereException

On boards the agent and grants an access token. Grants an Access Token which can be used to access mindsphere services. This serves as quick start method to on board the given agent and get an access token. It takes boarding configuration and on boards the agent using the client secret. It creates a client assertion signs it with client secret and gets a token. All the created record sets are returned to the caller in response. Data source is not configured by default, so user has to configure the data points as per the requirement.

200 - OK

400 - Bad Request

Parameters:

boardingConfig - Boarding Configuration required to on board. This can be received from boardingClient.getBoardingConfiguration(agentId)

Returns:

CreatedObjects Returns a list of objects created during this process.

Throws:

MindsphereException - if an error occurs while attempting to invoke the API boarding configuration is interrupted

getAccessTokenDuringStatusOnBoarding

public CreatedObjects getAccessTokenDuringStatusOnBoarding(String agentId)
                                                    throws MindsphereException

On boards the agent and grants an access token when status is "ON BOARDING". Grants an Access Token which can be used to access mindsphere services. This serves as quick start method to on board the given agent and get an access token. It takes boarding configuration and on boards the agent using the client secret. It creates a client assertion signs it with client secret and gets a token. All the created record sets are returned to the caller in response. Data source is not configured by default, so user has to configure the data points as per the requirement.

200 - OK

400 - Bad Request

Parameters:

agentId - agentId

Returns:

CreatedObjects Returns a list of objects created during this process.

Throws:

MindsphereException - if an error occurs while attempting to invoke the API boarding configuration is interrupted

getAccessTokenAfterOnBoardedWithSharedSecret

public AccessToken getAccessTokenAfterOnBoardedWithSharedSecret(String agentID,
                                                                String tenant,
                                                                String clientSecret)
                                                         throws MindsphereException

Grants an access token when status is "ON BOARDED" for agents with SHARED_SECRET security profile. Grants an Access Token which can be used to access mindsphere services. It creates a client assertion signs it with client secret and gets a token.

200 - OK

400 - Bad Request

Parameters:

agentID - agentId

tenant - tenant.

clientSecret - clientSecret received in on boarding stage. This can be obtained from registrationClient.onBoardAgent()

Returns:

AccessToken Returns AccessToken.

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

getKeysForRSAProfile

public JWKModel getKeysForRSAProfile()
                              throws MindsphereClientException

It geneartes RSA public and private keys. This can be used to get public key required for on boarding an agent with RSA profile. After on boarding private key is to be saved with the user.

200 - OK

400 - Bad Request

Returns:

JWKModel Returns JWKModel having generated key sets.

Throws:

MindsphereClientException - if an error occurs while creating RSA Keys.

getClientAssertionForRSAProfile

public String getClientAssertionForRSAProfile(String agentID,
                                              String tenant)
                                       throws MindsphereClientException

It generates client assertion for an agent with RSA profile. This client assertion can be used to get access token.

200 - OK

400 - Bad Request

Parameters:

agentID - agentId

tenant - tenant.

Returns:

client assertion

Throws:

MindsphereClientException - if an error occurs while creating client assertion

getClientAssertionForSharedSecret

public String getClientAssertionForSharedSecret(String agentID,
                                                String tenant,
                                                String clientSecret)
                                         throws MindsphereClientException

It generates client assertion for an agent with SHARED SECRET profile. This client assertion can be used to get access token.

200 - OK

400 - Bad Request

Parameters:

agentID - agentId

tenant - tenant.

clientSecret - clientSecret obtained while on boarding the agent

Returns:

client assertion

Throws:

MindsphereClientException - if an error occurs while attempting to create client assertion

getAccessToken

public CreatedObjects getAccessToken(String entityId,
                                     String agentName,
                                     Agent.SecurityProfileEnum profile)
                              throws MindsphereException

Creates an agent for the given asset id, on boards the agent and grants an access token. Grants an Access Token which can be used to access mindsphere services. This method serves as quick start method to on board an agent and get an access token. It gets boarding configuration and on boards the agent using the client secret. It creates a client assertion signs it with client secret and gets a token. All the created record sets are returned to the caller in response. Data source is not configured by default, so user has to configure the data points as per the requirement.

200 - OK

400 - Bad Request

Parameters:

entityId - asset Id

agentName - agent Name

profile - SHARED_SECRET/ RSA

Returns:

CreatedObjects Returns a list of objects created during this process.

Throws:

MindsphereException - if an error occurs while attempting to invoke the API boarding configuration is interrupted

getAccessToken

public CreatedObjects getAccessToken(String entityId,
                                     String agentName)
                              throws MindsphereException

Creates an agent for the given asset id, on boards the agent and grants an access token. Grants an Access Token which can be used to access mindsphere services. This method serves as quick start method to on board an agent and get an access token. It creates an agent for the created asset with "SHARED_SECRET" security profile. It gets boarding configuration and on boards the agent using the client secret. It creates a client assertion signs it with client secret and gets a token. All the created record sets are returned to the caller in response. Data source is not configured by default, so user has to configure the data points as per the requirement.

200 - OK

400 - Bad Request

Parameters:

entityId - asset Id

agentName - agent Name

Returns:

CreatedObjects Returns a list of objects created during this process.

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

getAccessTokenFromClientAssertion

public AccessToken getAccessTokenFromClientAssertion(String clientAssertion)
                                              throws MindsphereException

Grants an Access Token using client assertion which can be used to access mindsphere services. It uses "client_credentials" as grant type and "urn:ietf:params:oauth:client-assertion-type:jwt-bearer" as client assertion type. Agent needs to be on boarded before accessing this method.

200 - OK

400 - Bad Request

Parameters:

clientAssertion - client Assertion this can be obtained from agentsDefaultSettingClient.getClientAssertionForSharedSecret() or agentsDefaultSettingClient.getClientAssertionForRSA()

Returns:

AccessToken

Throws:

MindsphereException - if an error occurs while attempting to invoke the API