AuthenticationSettings Enum

Package:

com.microsoft.aad.adal

• java.lang.Object
• • java.lang.Enum<AuthenticationSettings>
  • • com.microsoft.aad.adal.AuthenticationSettings

public enum AuthenticationSettings

Settings to be used in AuthenticationContext.

Inherited Members

com.microsoft.aad.adal._authentication_settings_1a0baa345cd82945efa4a8cdd725e618a3

Methods

getActivityPackageName()

public String getActivityPackageName()

get package name to setup intent for AuthenticationActivity.

Returns

String

Package name for activity

getBrokerPackageName()

public String getBrokerPackageName()

Gets packagename for broker app that installed authenticator.

Returns

String

packagename

getBrokerSignature()

public String getBrokerSignature()

Gets broker signature for broker app that installed authenticator.

Returns

String

signature

getConnectTimeOut()

public int getConnectTimeOut()

Get the connect timeout.

Returns

int

connect timeout

getDeviceCertificateProxy()

public Class getDeviceCertificateProxy()

get class for work place join related API. This is only used from Authenticator side.

Returns

Class<?>

Class

getDisableWebViewHardwareAcceleration()

public boolean getDisableWebViewHardwareAcceleration()

Method to check whether WebView used in AuthenticationActivity and AuthenticationDialog would be hardware accelerated or not.

Returns

boolean

true if WebView is hardwareAccelerated otherwise false

getExpirationBuffer()

public int getExpirationBuffer()

Gets expiration buffer.

Returns

int

the amount of buffer that is provided to the expiration time.

getReadTimeOut()

public int getReadTimeOut()

Get the read timeout.

Returns

int

read timeout

getSecretKeyData()

public byte [] getSecretKeyData()

Get bytes to derive secretKey to use in encrypt/decrypt.

Returns

byte []

byte[] secret data

getSharedPrefPackageName()

public String getSharedPrefPackageName()

Gets package name provided for shared preferences.

Returns

String

package name provided for shared preferences

getSkipBroker()

public boolean getSkipBroker()

<xreftitle>Deprecated</xreftitle>

<xrefdescription>

  <p>As of release 1.1.14, replaced by <xref uid="com.microsoft.aad.adal.AuthenticationSettings.getUseBroker()" data-throw-if-not-resolved="false" data-raw-source="getUseBroker()"></xref></p>

</xrefdescription>

Returns

boolean

true if broker is not used, false otherwise

getUseBroker()

public boolean getUseBroker()

Get broker usage.

Returns

boolean

true if broker is used.

setActivityPackageName(String activityPackageName)

public void setActivityPackageName(String activityPackageName)

set package name to setup intent for AuthenticationActivity.

Parameters

activityPackageName

String

activity to use from different package

setBrokerPackageName(String packageName)

public void setBrokerPackageName(String packageName)

Sets package name for broker app that installed authenticator.

Parameters

packageName

String

package name related to broker

setBrokerSignature(String brokerSignature)

public void setBrokerSignature(String brokerSignature)

Sets broker app info for ADAL to use.

Parameters

brokerSignature

String

Signature for broker

setConnectTimeOut(int timeOutMillis)

public void setConnectTimeOut(int timeOutMillis)

Sets the maximum time in milliseconds to wait while connecting. Connecting to a server will fail with a SocketTimeoutException if the timeout elapses before a connection is established. Default value is 30000 milliseconds.

Parameters

timeOutMillis

int

the non-negative connect timeout in milliseconds.

setDeviceCertificateProxyClass(Class clazz)

public void setDeviceCertificateProxyClass(Class clazz)

set class for work place join related API. This is only used from Authenticator side.

Parameters

clazz

Class

class for workplace join

setDisableWebViewHardwareAcceleration(boolean enable)

public void setDisableWebViewHardwareAcceleration(boolean enable)

Method to enable/disable WebView hardware acceleration used in AuthenticationActivity and AuthenticationDialog. By default hardware acceleration is enable in WebView.

Parameters

enable

boolean

if true, WebView would be hardwareAccelerated else it would be disable.

setExpirationBuffer(int expirationBuffer)

public void setExpirationBuffer(int expirationBuffer)

When checking access token expiration, it will check if the time to expiration is less than this value(in seconds). Example: Set to 300 to give 5min buffer. Token with Expiry time of 12:04 will say expired when actual time is 12:00 with 5min buffer.

Parameters

expirationBuffer

int

the time buffer provided to expiration time.

setReadTimeOut(int timeOutMillis)

public void setReadTimeOut(int timeOutMillis)

Sets the maximum time to wait for an input stream read to complete before giving up. Reading will fail with a SocketTimeoutException if the timeout elapses before data becomes available. The default value is 30000.

Parameters

timeOutMillis

int

the read timeout in milliseconds. Non-negative

setSecretKey(byte[] rawKey)

public void setSecretKey(byte[] rawKey)

set raw bytes to derive secretKey to use in encrypt/decrypt. KeySpec algorithm is AES.

Parameters

rawKey

byte []

App related key to use in encrypt/decrypt

setSharedPrefPackageName(String packageNameForSharedFile)

public void setSharedPrefPackageName(String packageNameForSharedFile)

Sets package name to use DefaultTokenCacheStore with sharedUserId apps.

Parameters

packageNameForSharedFile

String

Package name of other app

setSkipBroker(boolean skip)

public void setSkipBroker(boolean skip)

<xreftitle>Deprecated</xreftitle>

<xrefdescription>

  <p>As of release 1.1.14, replaced by <xref uid="com.microsoft.aad.adal.AuthenticationSettings.setUseBroker(boolean)" data-throw-if-not-resolved="false" data-raw-source="setUseBroker(boolean)"></xref></p>

</xrefdescription>

Parameters

skip

boolean

true if broker has to be skipped, false otherwise

setUseBroker(boolean useBroker)

public void setUseBroker(boolean useBroker)

Set flag to use or skip broker. By default, the flag value is false and ADAL will not talk to broker.

Parameters

useBroker

boolean

True to use broker

Azure SDK for Java

Latest