com.microsoft.identity.client.internal

Class MsalUtils

java.lang.Object

com.microsoft.identity.client.internal.MsalUtils

public final class MsalUtils
extends java.lang.Object

Internal Util class for MSAL.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHROME_PACKAGE
static int	DEFAULT_EXPIRATION_TIME_SEC Default access token expiration time in seconds.
static java.lang.String	ENCODING_UTF8 The encoding scheme the sdk uses.
static java.lang.String	QUERY_STRING_DELIMITER
static java.lang.String	QUERY_STRING_SYMBOL

Method Summary

Modifier and Type	Method and Description
static java.lang.String	appendQueryParameterToUrl(java.lang.String url, java.util.Map<java.lang.String,java.lang.String> requestParams) Append parameter to the url.
static java.lang.String	base64UrlEncodeToString(java.lang.String message)
static java.util.Date	calculateExpiresOn(java.lang.String expiresIn) Calculate expires on based on given exipres in.
static java.util.Set<java.lang.String>	convertArrayToSet(java.lang.String[] values)
static java.lang.String	createHash(java.lang.String msg)
static java.util.Map<java.lang.String,java.lang.String>	decodeUrlToMap(java.lang.String url, java.lang.String delimiter) Decode the given url, and convert it into map with the given delimiter.
static java.util.Map<java.lang.String,java.lang.String>	extractJsonObjectIntoMap(java.lang.String jsonString) Return the unmodifiable Map of response items.
static android.content.pm.ApplicationInfo	getApplicationInfo(android.content.Context context)
static java.lang.String	getChromePackage(android.content.Context context) CHROME_PACKAGE array contains all the chrome packages that is currently available on play store, we will only support chrome stable.
static java.lang.String	getChromePackageWithCustomTabSupport(android.content.Context context) Check if the chrome package with custom tab support is available on the device, and return the package name if available.
static long	getExpiresOn(long expiresIn)
static int	getExpiryOrDefault(java.lang.String expiresIn)
static java.util.Set<java.lang.String>	getScopesAsSet(java.lang.String scopes) Converts the given string of scopes into set.
static java.lang.String	getUniqueUserIdentifier(java.lang.String uid, java.lang.String utid)
static java.net.URL	getUrl(java.lang.String endpoint) create url from given endpoint.
static boolean	hasCustomTabRedirectActivity(android.content.Context context, java.lang.String url) hasCustomTabRedirectActivity - Ensures that the developer has properly configured their AndroidManifest to expose the BrowserTabActivity.
static boolean	isEmpty(java.lang.String message) To improve test-ability with local Junit.
static boolean	isScopeIntersects(java.util.Set<java.lang.String> scopes, java.util.Set<java.lang.String> otherScopes)
static void	throwOnMainThread(java.lang.String methodName)
static java.lang.String	urlFormDecode(java.lang.String source) Perform URL decode on the given source.
static java.lang.String	urlFormEncode(java.lang.String stringToEncode) Translate the given string into the application/x-www-form-urlencoded using the utf_8 encoding scheme(The World Wide Web Consortium Recommendation states that UTF-8 should be used.
static void	validateNonNullArg(java.lang.Object o, java.lang.String argName) Throws MsalArgumentException if the argument is null or empty
static void	validateNonNullArgument(java.lang.Object o, java.lang.String argName) Throws IllegalArgumentException if the argument is null.

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING_UTF8

public static final java.lang.String ENCODING_UTF8

The encoding scheme the sdk uses.

See Also:

Constant Field Values

DEFAULT_EXPIRATION_TIME_SEC

public static final int DEFAULT_EXPIRATION_TIME_SEC

Default access token expiration time in seconds.

See Also:

Constant Field Values

CHROME_PACKAGE

public static final java.lang.String CHROME_PACKAGE

See Also:

Constant Field Values

QUERY_STRING_SYMBOL

public static final java.lang.String QUERY_STRING_SYMBOL

See Also:

Constant Field Values

QUERY_STRING_DELIMITER

public static final java.lang.String QUERY_STRING_DELIMITER

See Also:

Constant Field Values

Method Detail

isEmpty

public static boolean isEmpty(java.lang.String message)

To improve test-ability with local Junit. Android.jar used for local Junit doesn't have a default implementation for TextUtils.

validateNonNullArgument

public static void validateNonNullArgument(java.lang.Object o,
                                           java.lang.String argName)

Throws IllegalArgumentException if the argument is null.

validateNonNullArg

public static void validateNonNullArg(java.lang.Object o,
                                      java.lang.String argName)
                               throws MsalArgumentException

Throws MsalArgumentException if the argument is null or empty

Parameters:

o -

argName -

Throws:

MsalArgumentException

urlFormEncode

public static java.lang.String urlFormEncode(java.lang.String stringToEncode)
                                      throws java.io.UnsupportedEncodingException

Translate the given string into the application/x-www-form-urlencoded using the utf_8 encoding scheme(The World Wide Web Consortium Recommendation states that UTF-8 should be used. Not doing so may introduce incompatibilites.).

Parameters:

stringToEncode - The String to encode.

Returns:

The url encoded string.

Throws:

java.io.UnsupportedEncodingException - If the named encoding is not supported.

urlFormDecode

public static java.lang.String urlFormDecode(java.lang.String source)
                                      throws java.io.UnsupportedEncodingException

Perform URL decode on the given source.

Parameters:

source - The String to decode for.

Returns:

The decoded string.

Throws:

java.io.UnsupportedEncodingException - If encoding is not supported.

extractJsonObjectIntoMap

public static java.util.Map<java.lang.String,java.lang.String> extractJsonObjectIntoMap(java.lang.String jsonString)
                                                                                 throws org.json.JSONException

Return the unmodifiable Map of response items. If the input jsonString is empty or blank, it't not in the correct json format, JsonException will be thrown.

Throws:

org.json.JSONException

calculateExpiresOn

public static java.util.Date calculateExpiresOn(java.lang.String expiresIn)

Calculate expires on based on given exipres in. Data will hold date in milliseconds.

Parameters:

expiresIn - The given expires in that is used to calculate the expires on.

Returns:

The date that the token will be expired.

getExpiryOrDefault

public static int getExpiryOrDefault(java.lang.String expiresIn)

getScopesAsSet

public static java.util.Set<java.lang.String> getScopesAsSet(java.lang.String scopes)

Converts the given string of scopes into set. The input String of scopes is delimited by " ".

Parameters:

scopes - The scopes in the format of string, delimited by " ".

Returns:

Converted scopes in the format of set.

hasCustomTabRedirectActivity

public static boolean hasCustomTabRedirectActivity(android.content.Context context,
                                                   java.lang.String url)

hasCustomTabRedirectActivity - Ensures that the developer has properly configured their AndroidManifest to expose the BrowserTabActivity.

Parameters:

context -

url -

Returns:

getChromePackageWithCustomTabSupport

public static java.lang.String getChromePackageWithCustomTabSupport(android.content.Context context)

Check if the chrome package with custom tab support is available on the device, and return the package name if available.

Parameters:

context - The app Context to check for the package existence.

Returns:

The available package name for chrome. Will return null if no chrome package existed on the device.

getChromePackage

public static java.lang.String getChromePackage(android.content.Context context)

CHROME_PACKAGE array contains all the chrome packages that is currently available on play store, we will only support chrome stable.

Parameters:

context - The app context that is used to check the chrome packages.

Returns:

The chrome package name that exists on the device.

decodeUrlToMap

public static java.util.Map<java.lang.String,java.lang.String> decodeUrlToMap(java.lang.String url,
                                                                              java.lang.String delimiter)

Decode the given url, and convert it into map with the given delimiter.

Parameters:

url - The url to decode for.

delimiter - The delimiter used to parse the url string.

Returns:

The Map of the items decoded with the given delimiter.

appendQueryParameterToUrl

public static java.lang.String appendQueryParameterToUrl(java.lang.String url,
                                                         java.util.Map<java.lang.String,java.lang.String> requestParams)
                                                  throws java.io.UnsupportedEncodingException

Append parameter to the url. If the no query parameters, return the url originally passed in.

Throws:

java.io.UnsupportedEncodingException

base64UrlEncodeToString

public static java.lang.String base64UrlEncodeToString(java.lang.String message)

isScopeIntersects

public static boolean isScopeIntersects(java.util.Set<java.lang.String> scopes,
                                        java.util.Set<java.lang.String> otherScopes)

Returns:

True if there is an intersection between the scopes stored in the token cache key and the request scopes.

createHash

public static java.lang.String createHash(java.lang.String msg)
                                   throws java.security.NoSuchAlgorithmException,
                                          java.io.UnsupportedEncodingException

Throws:

java.security.NoSuchAlgorithmException

java.io.UnsupportedEncodingException

getUrl

public static java.net.URL getUrl(java.lang.String endpoint)

create url from given endpoint. return null if format is not right.

Parameters:

endpoint - url as a string

Returns:

URL object for this string

getUniqueUserIdentifier

public static java.lang.String getUniqueUserIdentifier(java.lang.String uid,
                                                       java.lang.String utid)

getExpiresOn

public static long getExpiresOn(long expiresIn)

getApplicationInfo

public static android.content.pm.ApplicationInfo getApplicationInfo(android.content.Context context)

convertArrayToSet

public static java.util.Set<java.lang.String> convertArrayToSet(java.lang.String[] values)

throwOnMainThread

public static void throwOnMainThread(java.lang.String methodName)

Parameters:

methodName -