Skip navigation links
A B C E G I L M P R S U V 

A

Account - Class in com.microsoft.azure.javamsalruntime
Represents an MSALRuntime account in a way that MSAL Java can use to create its own Account object
AccountHandle - Class in com.microsoft.azure.javamsalruntime
Represents an MSALRUNTIME_ACCOUNT_HANDLE
AccountHandle() - Constructor for class com.microsoft.azure.javamsalruntime.AccountHandle
 
acquireTokenInteractively(long, AuthParameters, String, Account) - Method in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
Calls MSALRuntime's AcquireTokenInteractively API to retrieve tokens for a given account, by showing a UI to the user
acquireTokenSilently(AuthParameters, String, Account) - Method in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
Calls MSALRuntime's AcquireTokenSilently API to retrieve tokens for a given account, without showing a UI to the user
additionalParameters(Map<String, String>) - Method in class com.microsoft.azure.javamsalruntime.AuthParameters.AuthParametersBuilder
 
AsyncHandle - Class in com.microsoft.azure.javamsalruntime
Represents an MSALRUNTIME_ASYNC_HANDLE
AsyncHandle() - Constructor for class com.microsoft.azure.javamsalruntime.AsyncHandle
 
AuthParameters - Class in com.microsoft.azure.javamsalruntime
Represents the auth parameters sent to MSALRuntime's SignIn and AcquireToken APIs
AuthParameters.AuthParametersBuilder - Class in com.microsoft.azure.javamsalruntime
 
AuthParametersBuilder(String, String, String) - Constructor for class com.microsoft.azure.javamsalruntime.AuthParameters.AuthParametersBuilder
 
AuthParametersHandle - Class in com.microsoft.azure.javamsalruntime
Represents an MSALRUNTIME_AUTH_PARAMETERS_HANDLE
AuthParametersHandle() - Constructor for class com.microsoft.azure.javamsalruntime.AuthParametersHandle
 
AuthResult - Class in com.microsoft.azure.javamsalruntime
Contains all of the behavior needed to parse the result of calls to MSALRuntime's SignIn and AcquireToken APIs, and to complete an associated AsyncHandler using that parsed result
AuthResult(AuthResultHandle) - Constructor for class com.microsoft.azure.javamsalruntime.AuthResult
 
AuthResultHandle - Class in com.microsoft.azure.javamsalruntime
Represents an MSALRUNTIME_AUTH_RESULT_HANDLE
AuthResultHandle() - Constructor for class com.microsoft.azure.javamsalruntime.AuthResultHandle
 

B

build() - Method in class com.microsoft.azure.javamsalruntime.AuthParameters.AuthParametersBuilder
 

C

callback(WString, Integer, Integer) - Method in class com.microsoft.azure.javamsalruntime.Callbacks.LogCallback
 
callback(ReadAccountResultHandle, Integer) - Method in class com.microsoft.azure.javamsalruntime.Callbacks.ReadAccountResultCallback
This method will be passed to MSALRuntime as a parameter of the ReadAccount APIs
callback(SignOutResultHandle, Integer) - Method in class com.microsoft.azure.javamsalruntime.Callbacks.SignOutResultCallback
This method will be passed to MSALRuntime as a parameter of the SignOut APIs
Callbacks - Class in com.microsoft.azure.javamsalruntime
Class used to encapsulate the behavior of callback methods which are passed into various MSALRuntime APIs, and are called by MSALRuntime when some result is ready to be parsed by the interop
Callbacks() - Constructor for class com.microsoft.azure.javamsalruntime.Callbacks
 
Callbacks.LogCallback - Class in com.microsoft.azure.javamsalruntime
 
Callbacks.ReadAccountResultCallback - Class in com.microsoft.azure.javamsalruntime
 
Callbacks.SignOutResultCallback - Class in com.microsoft.azure.javamsalruntime
 
cancelAsyncOperation() - Method in class com.microsoft.azure.javamsalruntime.MsalRuntimeFuture
Calls MSALRuntime's cancel API to cancel the related async operation, and releases the async handle
claims(String) - Method in class com.microsoft.azure.javamsalruntime.AuthParameters.AuthParametersBuilder
 
close() - Method in class com.microsoft.azure.javamsalruntime.Account
 
close() - Method in class com.microsoft.azure.javamsalruntime.AuthParameters
 
com.microsoft.azure.javamsalruntime - package com.microsoft.azure.javamsalruntime
 

E

enableLogging(boolean) - Static method in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
Sets up the necessary callbacks and handles to integrate MSALRuntime logs into MSAL Java's logging framework, allowing detailed logs from MSALRuntime's native code to appear in javamsalruntime's logs By default, detailed logs from MSALRuntime will not be shown, though some MSALRuntime error messages may appear as part of a thrown exception
enableLoggingPii(boolean) - Static method in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
Allows PII data to appear in MSALRuntime error messages and logs By default, PII logging is disabled
ERROR_HELPER - Static variable in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
 
ErrorHandle - Class in com.microsoft.azure.javamsalruntime
Represents an MSALRUNTIME_ERROR_HANDLE
ErrorHandle() - Constructor for class com.microsoft.azure.javamsalruntime.ErrorHandle
 

G

getAccessToken() - Method in class com.microsoft.azure.javamsalruntime.AuthResult
 
getAccessTokenExpirationTime() - Method in class com.microsoft.azure.javamsalruntime.AuthResult
 
getAccount() - Method in class com.microsoft.azure.javamsalruntime.AuthResult
 
getAccount() - Method in class com.microsoft.azure.javamsalruntime.ReadAccountResult
 
getAccountId() - Method in class com.microsoft.azure.javamsalruntime.Account
Retrieves the account ID from MSALRuntime, and stores it in this Account instance
getAuthorizationHeader() - Method in class com.microsoft.azure.javamsalruntime.AuthResult
Returns the authorization header, used to retrieve a proof-of-possession token
getClientInfo() - Method in class com.microsoft.azure.javamsalruntime.Account
Retrieves the client info String from MSALRuntime, and stores it in this Account instance
getErrorCode() - Method in exception com.microsoft.azure.javamsalruntime.MsalInteropException
 
getErrorMessage() - Method in exception com.microsoft.azure.javamsalruntime.MsalInteropException
 
getHandle() - Method in class com.microsoft.azure.javamsalruntime.AuthParameters
 
getIdToken() - Method in class com.microsoft.azure.javamsalruntime.AuthResult
 

I

isPopAuthorization() - Method in class com.microsoft.azure.javamsalruntime.AuthResult
Returns true if this authResult represents a proof-of-possession authorization

L

LogCallback() - Constructor for class com.microsoft.azure.javamsalruntime.Callbacks.LogCallback
 
LogCallbackHandle - Class in com.microsoft.azure.javamsalruntime
 
LogCallbackHandle() - Constructor for class com.microsoft.azure.javamsalruntime.LogCallbackHandle
 

M

MsalInteropException - Exception in com.microsoft.azure.javamsalruntime
A simple class that can be used to create Exceptions with descriptive messages and our own error codes
MsalInteropException(Throwable) - Constructor for exception com.microsoft.azure.javamsalruntime.MsalInteropException
A catch-all constructor for exceptions that were caught but weren't expected
MsalInteropException(String, String) - Constructor for exception com.microsoft.azure.javamsalruntime.MsalInteropException
A constructor for exceptions that were caught, and we can provide a descriptive message explaining the issue and how to resolve it
MSALRUNTIME_AcquireTokenInteractivelyAsync(long, long, WString, long, Callbacks.AuthResultCallback, Integer, AsyncHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_AcquireTokenSilentlyAsync(long, WString, long, Callbacks.AuthResultCallback, Integer, AsyncHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_CancelAsyncOperation(AsyncHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_CreateAuthParameters(WString, WString, AuthParametersHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetAccessToken(AuthResultHandle, Pointer, IntByReference) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetAccount(AuthResultHandle, AccountHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetAccountId(long, Pointer, IntByReference) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetAuthorizationHeader(AuthResultHandle, Pointer, IntByReference) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetClientInfo(long, Pointer, IntByReference) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetContext(ErrorHandle, Pointer, IntByReference) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetError(AuthResultHandle, ErrorHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetErrorCode(long, LongByReference) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetRawIdToken(AuthResultHandle, Pointer, IntByReference) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetReadAccount(ReadAccountResultHandle, AccountHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetReadAccountError(ReadAccountResultHandle, ErrorHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetSignOutError(SignOutResultHandle, ErrorHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetStatus(ErrorHandle, IntByReference) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetStatus(long, IntByReference) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_GetTag(long, IntByReference) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_IsPopAuthorization(AuthResultHandle, IntByReference) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_LIBRARY - Static variable in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
 
MSALRUNTIME_ReadAccountByIdAsync(WString, WString, Callbacks.ReadAccountResultCallback, Integer, AsyncHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_RegisterLogCallback(Callbacks.LogCallback, Integer, LogCallbackHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_ReleaseAccount(long) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_ReleaseAsyncHandle(long) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_ReleaseAuthParameters(long) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_ReleaseAuthResult(long) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_ReleaseError(long) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_ReleaseLogCallbackHandle(long) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_ReleaseReadAccountResult(long) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_ReleaseSignOutResult(long) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_SetAdditionalParameter(long, WString, WString) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_SetDecodedClaims(long, WString) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_SetIsPiiEnabled(int) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_SetPopParams(long, WString, WString, WString, WString) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_SetRedirectUri(long, WString) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_SetRequestedScopes(long, WString) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_Shutdown() - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_SignInAsync(long, long, WString, WString, Callbacks.AuthResultCallback, Integer, AsyncHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_SignInInteractivelyAsync(long, long, WString, WString, Callbacks.AuthResultCallback, Integer, AsyncHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_SignInSilentlyAsync(long, WString, Callbacks.AuthResultCallback, Integer, AsyncHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_SignOutSilentlyAsync(WString, WString, long, Callbacks.SignOutResultCallback, Integer, AsyncHandle) - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MSALRUNTIME_Startup() - Method in interface com.microsoft.azure.javamsalruntime.MsalRuntimeLibrary
 
MsalRuntimeFuture - Class in com.microsoft.azure.javamsalruntime
Contains any functionality needed to allow callbacks sent to MSALRuntime to complete futures
MsalRuntimeFuture(Callback) - Constructor for class com.microsoft.azure.javamsalruntime.MsalRuntimeFuture
 
MsalRuntimeInterop - Class in com.microsoft.azure.javamsalruntime
A set of APIs intended to map more-or-less directly MSALRuntime's APIs, particularly those related to signing in/signing out users, acquiring tokens, and getting account information All of MsalRuntimeInterop's APIs are non-static, therefore an MsalRuntimeInterop instance must be created before any calls to MSALRuntime are made This class has a static block that will be called when the first MSALRuntimeInterop instance is created, ensuring that any required initialization steps are performed before the first call to any MSALRuntime API
MsalRuntimeInterop() - Constructor for class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
 
MsalRuntimeLibrary - Interface in com.microsoft.azure.javamsalruntime
Uses Java Native Access (JNA) to call C++ functions from Java, and perform conversions between Java classes and native types In order for JNA to call the correct MSALRuntime API, the names and number of parameters in this interface's methods must match those found in MSALRuntime's header files As for data types, JNA should be able to convert any basic Java type (int, long, String, etc.), and it offers a number of classes to mimic native types that have no clear Java equivalent (LongByReference for long*, Pointer for void*, etc.)
MsalRuntimeResponseStatus - Enum in com.microsoft.azure.javamsalruntime
Values here match those in MSALRuntime's MSALRuntimeTypes.MSALRUNTIME_RESPONSE_STATUS enum

P

popParameters(String, URI, String) - Method in class com.microsoft.azure.javamsalruntime.AuthParameters.AuthParametersBuilder
Set the auth scheme for the request.

R

readAccountById(String, String) - Method in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
Retrieves any cached account information for a given account ID
ReadAccountResult - Class in com.microsoft.azure.javamsalruntime
Contains all of the behavior needed to parse the result of calls to MSALRuntime's ReadAccount APIs, and to complete an associated AsyncHandler using that parsed result
ReadAccountResult(ReadAccountResultHandle) - Constructor for class com.microsoft.azure.javamsalruntime.ReadAccountResult
 
ReadAccountResultCallback() - Constructor for class com.microsoft.azure.javamsalruntime.Callbacks.ReadAccountResultCallback
 
ReadAccountResultHandle - Class in com.microsoft.azure.javamsalruntime
Represents an single MSALRUNTIME_READ_ACCOUNT_RESULT_HANDLE
ReadAccountResultHandle() - Constructor for class com.microsoft.azure.javamsalruntime.ReadAccountResultHandle
 
redirectUri(String) - Method in class com.microsoft.azure.javamsalruntime.AuthParameters.AuthParametersBuilder
Sets the redirect URI which is used when authorization is complete.

S

setUsernamePassword(String, String) - Method in class com.microsoft.azure.javamsalruntime.AuthParameters
Deprecated. 
shutdownMsalRuntime() - Static method in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
Calls MSALRuntime's shutdown API
signIn(long, AuthParameters, String, String) - Method in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
Calls MSALRuntime's SignIn API, which will attempt a silent sign in and fall back to interactive if needed
signInInteractively(long, AuthParameters, String, String) - Method in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
Calls MSALRuntime's SignInInteractively API to attempt a sign in by showing a UI to the user
signInSilently(AuthParameters, String) - Method in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
Calls MSALRuntime's SignInSilently API to attempt a sign in without showing a UI to the user
SignOutResult - Class in com.microsoft.azure.javamsalruntime
Contains all of the behavior needed to parse the result of calls to MSALRuntime's SignOut APIs, and to complete an associated AsyncHandler using that parsed result
SignOutResult(SignOutResultHandle) - Constructor for class com.microsoft.azure.javamsalruntime.SignOutResult
 
SignOutResultCallback() - Constructor for class com.microsoft.azure.javamsalruntime.Callbacks.SignOutResultCallback
 
SignOutResultHandle - Class in com.microsoft.azure.javamsalruntime
Represents an MSALRUNTIME_SIGNOUT_RESULT_HANDLE
SignOutResultHandle() - Constructor for class com.microsoft.azure.javamsalruntime.SignOutResultHandle
 
signOutSilently(String, String, Account) - Method in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
Calls MSALRuntime's SignOut API, which will delete cached tokens for a given account and require this account to perform a new sign in
startupMsalRuntime() - Method in class com.microsoft.azure.javamsalruntime.MsalRuntimeInterop
Calls MSALRuntime's startup API

U

unused - Variable in class com.microsoft.azure.javamsalruntime.AuthResult
 
unused - Variable in class com.microsoft.azure.javamsalruntime.ReadAccountResult
 
unused - Variable in class com.microsoft.azure.javamsalruntime.SignOutResult
 

V

valueOf(String) - Static method in enum com.microsoft.azure.javamsalruntime.MsalRuntimeResponseStatus
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.microsoft.azure.javamsalruntime.MsalRuntimeResponseStatus
Returns an array containing the constants of this enum type, in the order they are declared.
A B C E G I L M P R S U V 
Skip navigation links

Copyright © 2023. All rights reserved.