com.siemens.mindsphere.sdk.core.util

Class CommonUtil

Object

CommonUtil

public abstract class CommonUtil
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOST_ENVIRONMENT

Constructor Summary

Constructors

Constructor and Description
CommonUtil()

Method Summary

Modifier and Type	Method and Description
static void	checkUserSetup(String clientId, String clientSecret, String tenant) Verifies if mandatory user details available before requesting for token.
static String	encodeFilter(String filter)
static byte[]	fileToByteArray(File file) Converts the given file to byte stream.
static MindsphereCredentials	getCredentialFromEnv(MindsphereCredentials creds) Method to fetch credentials from sytem's environment variable if it has not been provided
static String	getCredentials(RestClientConfig config, MindsphereCredentials creds) Returns bearer token for the requested client.
static String	getEnvironmentSpecificGateWayUrl(RestClientConfig config) Returns gate way URL specific to the configured environment
static Timestamp	getTimestamp(String timeString) Converts time stamp in string to java Timestamp object.
static String	getURL(String urlKey, RestClientConfig config)
static String	getURL(String baseUrlKey, String apiUrlKey, RestClientConfig config) Method to get fully qualified Url for the requested resource
static ErrorObject	parseException(String inp) Reads the error message received from requested Api and parses to representable format.
void	wrapperFetchTechnicalToken(MindsphereCredentials credentialFromEnv, RestClientConfig config, HttpHeaders header)
String	wrapperGetEnvironmentVarValue(String envKey)
void	wrapperNonStaticAddCredential(RestClientConfig config, MindsphereCredentials creds, HttpHeaders header)
MindsphereCredentials	wrapperNonStaticGetCredentialFromEnv(MindsphereCredentials creds)
String	wrapperNonStaticGetCredentialFromEnv(String envKey)

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

Constructor Detail

CommonUtil

public CommonUtil()

Method Detail

getURL

public static String getURL(String baseUrlKey,
                            String apiUrlKey,
                            RestClientConfig config)

Method to get fully qualified Url for the requested resource

Parameters:

baseUrlKey - base url for a set of operation on same resource

apiUrlKey - Http operation specific end point

config - RestClientConfig instance

Returns:

fully qualified URL to access the resource

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

getURL

public static String getURL(String urlKey,
                            RestClientConfig config)

getCredentials

public static String getCredentials(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

wrapperFetchTechnicalToken

public void wrapperFetchTechnicalToken(MindsphereCredentials credentialFromEnv,
                                       RestClientConfig config,
                                       HttpHeaders header)
                                throws MindsphereException

Throws:

MindsphereException

wrapperGetEnvironmentVarValue

public String wrapperGetEnvironmentVarValue(String envKey)

wrapperNonStaticGetCredentialFromEnv

public String wrapperNonStaticGetCredentialFromEnv(String envKey)

wrapperNonStaticGetCredentialFromEnv

public MindsphereCredentials wrapperNonStaticGetCredentialFromEnv(MindsphereCredentials creds)
                                                           throws MindsphereForbiddenAccessException

Throws:

MindsphereForbiddenAccessException

wrapperNonStaticAddCredential

public void wrapperNonStaticAddCredential(RestClientConfig config,
                                          MindsphereCredentials creds,
                                          HttpHeaders header)
                                   throws MindsphereException

Throws:

MindsphereException

fileToByteArray

public static byte[] fileToByteArray(File file)

Converts the given file to byte stream.

Parameters:

file - input file

Returns:

byte[] of file's content.

getTimestamp

public static Timestamp getTimestamp(String timeString)
                              throws ParseException

Converts time stamp in string to java Timestamp object.

Parameters:

timeString - time stamp in string

Returns:

Timestamp object.

Throws:

ParseException - thrown if an error is encountered when converting String to Timestamp

parseException

public static ErrorObject parseException(String inp)

Reads the error message received from requested Api and parses to representable format.

Parameters:

inp - error message.

Returns:

ErrorObject error object model used by SDK.

checkUserSetup

public static void checkUserSetup(String clientId,
                                  String clientSecret,
                                  String tenant)
                           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.

Throws:

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

encodeFilter

public static String encodeFilter(String filter)