com.microsoft.aad.msal4j

Class ManagedIdentityApplication

java.lang.Object

com.microsoft.aad.msal4j.AbstractApplicationBase

com.microsoft.aad.msal4j.ManagedIdentityApplication

All Implemented Interfaces:

IManagedIdentityApplication

public class ManagedIdentityApplication
extends AbstractApplicationBase
implements IManagedIdentityApplication

Class to be used to acquire tokens for managed identity. For details see IManagedIdentityApplication

Conditionally thread-safe

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ManagedIdentityApplication.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_AUTHORITY

Fields inherited from class com.microsoft.aad.msal4j.AbstractApplicationBase

authenticationAuthority, log, tokenCache

Method Summary

Modifier and Type	Method and Description
CompletableFuture<IAuthenticationResult>	acquireTokenForManagedIdentity(ManagedIdentityParameters managedIdentityParameters) Acquires tokens from the configured managed identity on an azure resource.
static ManagedIdentityApplication.Builder	builder(ManagedIdentityId managedIdentityId) Creates instance of Builder of ManagedIdentityApplication
String	correlationId() Gets the correlation ID used for tracing requests through the authentication system.
List<String>	getClientCapabilities()
ManagedIdentityId	getManagedIdentityId()
static ManagedIdentitySourceType	getManagedIdentitySource() Returns a ManagedIdentitySourceType value, which is based primarily on environment variables set on the system.
static TokenCache	getSharedTokenCache()
IHttpClient	httpClient() Gets the HTTP client used by the application for all HTTP requests.
boolean	logPii() Gets whether personally identifiable information (PII) is included in log messages.
Proxy	proxy() Gets the proxy configuration used by the application for network communication.
SSLSocketFactory	sslSocketFactory() Gets the SSL socket factory used by the application for secure network communication.

Methods inherited from class com.microsoft.aad.msal4j.AbstractApplicationBase

connectTimeoutForDefaultHttpClient, correlationId, httpClient, logPii, proxy, readTimeoutForDefaultHttpClient, sslSocketFactory

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_AUTHORITY

public static final String DEFAULT_AUTHORITY

See Also:

Constant Field Values

Method Detail

getSharedTokenCache

public static TokenCache getSharedTokenCache()

getManagedIdentityId

public ManagedIdentityId getManagedIdentityId()

getClientCapabilities

public List<String> getClientCapabilities()

acquireTokenForManagedIdentity

public CompletableFuture<IAuthenticationResult> acquireTokenForManagedIdentity(ManagedIdentityParameters managedIdentityParameters)
                                                                        throws Exception

Description copied from interface: IManagedIdentityApplication

Acquires tokens from the configured managed identity on an azure resource.

Specified by:

acquireTokenForManagedIdentity in interface IManagedIdentityApplication

Parameters:

managedIdentityParameters - instance of ManagedIdentityParameters

Returns:

CompletableFuture containing an IAuthenticationResult

Throws:

Exception

builder

public static ManagedIdentityApplication.Builder builder(ManagedIdentityId managedIdentityId)

Creates instance of Builder of ManagedIdentityApplication

Parameters:

managedIdentityId - ManagedIdentityId to specify if System Assigned or User Assigned and provide id if it is user assigned.

Returns:

instance of Builder of ManagedIdentityApplication

getManagedIdentitySource

public static ManagedIdentitySourceType getManagedIdentitySource()

Returns a ManagedIdentitySourceType value, which is based primarily on environment variables set on the system.

Returns:

ManagedIdentitySourceType enum for source type

logPii

public boolean logPii()

Gets whether personally identifiable information (PII) is included in log messages.

Returns:

A boolean value which determines whether PII (personally identifiable information) will be included in log messages. When true, PII will be logged; when false, PII will be masked or omitted from logs.

correlationId

public String correlationId()

Gets the correlation ID used for tracing requests through the authentication system.

Returns:

Correlation ID which is used for diagnostics purposes and is attached to token service requests. The default value is a random UUID.

httpClient

public IHttpClient httpClient()

Gets the HTTP client used by the application for all HTTP requests.

Returns:

Instance of IHttpClient used by the application for network communication with the Microsoft identity platform.

proxy

public Proxy proxy()

Gets the proxy configuration used by the application for network communication.

Returns:

Proxy used by the application for all network communication. Returns null if no proxy is configured.

sslSocketFactory

public SSLSocketFactory sslSocketFactory()

Gets the SSL socket factory used by the application for secure network communication.

Returns:

SSLSocketFactory used by the application for all secure network communication. Returns null if no custom SSL socket factory is configured.