com.siemens.mindsphere.sdk.auth

Class TokenUtility

Object

TokenUtility

public class TokenUtility
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOST_ENVIRONMENT

Method Summary

Modifier and Type	Method and Description
static void	checkUserSetup(String clientId, String clientSecret, String tenant, String subTenant, TokenScope tokenType) Verifies if mandatory user details available before requesting for token.
static String	getAuthorizationToken(RestClientConfig config, MindsphereCredentials creds) Returns bearer token for the requested client.
static MindsphereCredentials	getCredentialFromEnv(MindsphereCredentials creds) Method to fetch credentials from sytem's environment variable if it has not been provided
static String	getEnvironmentSpecificGateWayUrl(RestClientConfig config) Returns gate way URL specific to the configured environment

Methods inherited from class Object

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

Field Detail

HOST_ENVIRONMENT

public static final String HOST_ENVIRONMENT

Method Detail

getAuthorizationToken

public static String getAuthorizationToken(RestClientConfig config,
                                           MindsphereCredentials creds)
                                    throws MindsphereException

Returns bearer token for the requested client.

Parameters:

config - RestClientConfig having client configuration such as proxy settings.

creds - Credentials object used by the client to set credentials.

Returns:

bearer token

Throws:

MindsphereException - thrown if some error occurs while fetching the token.

getCredentialFromEnv

public static MindsphereCredentials getCredentialFromEnv(MindsphereCredentials creds)
                                                  throws MindsphereForbiddenAccessException

Method to fetch credentials from sytem's environment variable if it has not been provided

Parameters:

creds - Credentials object used by the client to set credentials

Returns:

MindsphereCredentials having client id and clientAccessKey

Throws:

MindsphereForbiddenAccessException - thrown if clientId, clientSecret and tenant details are not set

checkUserSetup

public static void checkUserSetup(String clientId,
                                  String clientSecret,
                                  String tenant,
                                  String subTenant,
                                  TokenScope tokenType)
                           throws MindsphereForbiddenAccessException

Verifies if mandatory user details available before requesting for token.

Parameters:

clientId - Client id for authorization.

clientSecret - clientSecret for authorization.

tenant - tenant Id for authorization.

subTenant - subTenant Id for authorization.

tokenType - type of token for authorization.

Throws:

MindsphereForbiddenAccessException - thrown if any of the mandatory parameters is missing.

getEnvironmentSpecificGateWayUrl

public static String getEnvironmentSpecificGateWayUrl(RestClientConfig config)

Returns gate way URL specific to the configured environment

Parameters:

config - RestClientConfig instance to get the host environment (region) value

Returns:

gate way URL