Class MsalClientAdapter

java.lang.Object

org.frankframework.http.AbstractHttpSession

org.frankframework.http.AbstractHttpSender

org.frankframework.filesystem.MsalClientAdapter

All Implemented Interfaces:

com.microsoft.aad.msal4j.IHttpClient, CanUseSharedResource<HttpSession>, FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, HasKeystore, HasTruststore, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

@Protected
public class MsalClientAdapter
extends AbstractHttpSender
implements com.microsoft.aad.msal4j.IHttpClient

This class ensures that Microsoft Authentication Library (MSAL) requests are sent through the configured proxy and the correct SSLSocketFactory.

See Also:

• ExchangeFileSystem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MsalClientAdapter.GraphClient	Silly wrapper to create a clean SDK

Nested classes/interfaces inherited from class AbstractHttpSender

AbstractHttpSender.HttpMethod

Nested classes/interfaces inherited from class AbstractHttpSession

AbstractHttpSession.OauthAuthenticationMethod

Field Summary

Fields inherited from class AbstractHttpSender

CORRELATION_ID_HEADER, headerParamsSet, MESSAGE_ID_HEADER, parametersToSkipWhenEmptySet, paramList, requestOrBodyParamsSet, staticUri, urlParameter

Fields inherited from class AbstractHttpSession

AUTHENTICATION_METHOD_KEY, log

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
MsalClientAdapter()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure this component.
MsalClientAdapter.GraphClient	createGraphClient(String tenantId, CredentialFactory credentials)
protected Message	extractResult(HttpResponseHandler responseHandler, PipeLineSession session)	Custom implementation to extract the response and format it to a String result.
protected String	getAuthenticationToken()
protected org.apache.http.client.methods.HttpRequestBase	getMethod(URI uri, Message message, @NonNull ParameterValueList parameters, PipeLineSession session)	Custom implementation to create a HttpRequest object.
com.microsoft.aad.msal4j.IHttpResponse	send(com.microsoft.aad.msal4j.HttpRequest httpRequest)
void	stop()	Stop/close the sender and deallocate resources.

Methods inherited from class AbstractHttpSender

addParameter, appendParameters, getCredentials, getLogPrefix, getOauthAuthenticationMethod, getObjectType, getParameterList, getPhysicalDestinationName, getTokenEndpoint, sendMessage, setCharSet, setContentType, setHeadersParams, setMethodType, setParametersToSkipWhenEmpty, setResultStatusCodeSessionKey, setStyleSheetName, setUrl, setUrlParam, setXhtml, start, validateResponseCode

Methods inherited from class AbstractHttpSession

areCookiesDisabled, execute, getDomainAwareCredentials, getSSLConnectionSocketFactory, getURI, isRunning, setAllowSelfSignedCertificates, setAuthAlias, setAuthDomain, setAuthenticatedTokenRequest, setClientAlias, setClientId, setClientSecret, setConnectionIdleTimeout, setConnectionTimeToLive, setDisableCookies, setFollowRedirects, setHttpClient, setHttpContext, setIgnoreCertificateExpiredException, setIgnoreRedirects, setKeyManagerAlgorithm, setKeystore, setKeystoreAlias, setKeystoreAliasAuthAlias, setKeystoreAliasPassword, setKeystoreAuthAlias, setKeystorePassword, setKeystoreType, setMaxConnections, setMaxExecuteRetries, setOauthAuthenticationMethod, setPassword, setPrefillProxyAuthCache, setProtocol, setProxyAuthAlias, setProxyHost, setProxyPassword, setProxyPort, setProxyRealm, setProxyUsername, setSamlAssertionExpiry, setSamlAudience, setSamlIssuer, setSamlNameId, setScope, setStaleChecking, setStaleTimeout, setSupportedCipherSuites, setTimeout, setTokenEndpoint, setTokenExpiry, setTrustManagerAlgorithm, setTruststore, setTruststoreAuthAlias, setTruststorePassword, setTruststoreType, setUsername, setVerifyHostname

Methods inherited from class Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface CanUseSharedResource

getSharedResource, setSharedResourceRef

Methods inherited from interface ConfigurableLifecycle

getPhase, isAutoStartup, isConfigured

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasKeystore

getKeyManagerAlgorithm, getKeystore, getKeystoreAlias, getKeystoreAliasAuthAlias, getKeystoreAliasPassword, getKeystoreAuthAlias, getKeystorePassword, getKeystoreType

Methods inherited from interface HasName

getName

Methods inherited from interface HasTruststore

getTrustManagerAlgorithm, getTruststore, getTruststoreAuthAlias, getTruststorePassword, getTruststoreType, isAllowSelfSignedCertificates, isIgnoreCertificateExpiredException, isVerifyHostname

Methods inherited from interface ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface ISenderWithParameters

consumesSessionVariable

Methods inherited from interface org.springframework.context.Lifecycle

isRunning

Methods inherited from interface NameAware

setName

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable, stop

Constructor Details

MsalClientAdapter

public MsalClientAdapter()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractHttpSender

Throws:

ConfigurationException - in case it was not able to configure the component.

stop

public void stop()

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

stop in interface ISender

Specified by:

stop in interface org.springframework.context.Lifecycle

Overrides:

stop in class AbstractHttpSender

createGraphClient

public MsalClientAdapter.GraphClient createGraphClient(String tenantId,
 CredentialFactory credentials)
                                                throws IOException

Throws:

IOException

getAuthenticationToken

protected String getAuthenticationToken()
                                 throws IOException

Throws:

IOException

send

public com.microsoft.aad.msal4j.IHttpResponse send(com.microsoft.aad.msal4j.HttpRequest httpRequest)
                                            throws Exception

Specified by:

send in interface com.microsoft.aad.msal4j.IHttpClient

Throws:

Exception

getMethod

protected org.apache.http.client.methods.HttpRequestBase getMethod(URI uri,
 Message message,
 @NonNull ParameterValueList parameters,
 PipeLineSession session)
                                                            throws SenderException

Description copied from class: AbstractHttpSender

Custom implementation to create a HttpRequest object.

Specified by:

getMethod in class AbstractHttpSender

Parameters:

uri - endpoint to send the message to

message - to be sent

parameters - ParameterValueList that contains all the senders parameters

session - PipeLineSession to retrieve or store data from, or NULL when not set

Returns:

a HttpRequest object

Throws:

SenderException

extractResult

protected Message extractResult(HttpResponseHandler responseHandler,
 PipeLineSession session)

Description copied from class: AbstractHttpSender

Custom implementation to extract the response and format it to a String result.
It is important that the response will be read or will be closed.

Specified by:

extractResult in class AbstractHttpSender

Parameters:

responseHandler - HttpResponseHandler that contains the response information

session - PipeLineSession which may be null

Returns:

a string that will be passed to the pipeline