Package org.frankframework.filesystem.exchange

Class ExchangeFileSystem

java.lang.Object

org.frankframework.filesystem.AbstractFileSystem<MailItemId>

org.frankframework.filesystem.exchange.ExchangeFileSystem

All Implemented Interfaces:

AutoCloseable, HasApplicationContext, HasPhysicalDestination, IScopeProvider, HasKeystore, HasTruststore, IBasicFileSystem<MailItemId>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ExchangeFileSystem
extends AbstractFileSystem<MailItemId>
implements HasKeystore, HasTruststore, org.springframework.context.ApplicationContextAware

Implementation of a IBasicFileSystem of an Exchange Mailbox.
To make use of oauth authentication:

1. Create an application in Azure AD -> App Registrations. For more information please read how-to-authenticate-an-ews-application-by-using-oauth
2. Request the required API permissions within desired scope https://outlook.office365.com/ in Azure AD -> App Registrations -> MyApp -> API Permissions.
3. Create a secret for your application in Azure AD -> App Registrations -> MyApp -> Certificates and Secrets
4. Configure the clientSecret directly as password or as the password of a JAAS entry referred to by authAlias. Only available upon creation of your secret in the previous step.
5. Configure the clientId directly as username or as the username of a JAAS entry referred to by authAlias which could be retrieved from Azure AD -> App Registrations -> MyApp -> Overview
6. Configure the tenantId which could be retrieved from Azure AD -> App Registrations -> MyApp -> Overview
7. Make sure your application is able to reach https://login.microsoftonline.com. Required for token retrieval.

Constructor Summary

Constructors

Constructor	Description
ExchangeFileSystem()

Method Summary

Modifier and Type	Method	Description
void	close()
void	configure()
MailMessage	copyFile(MailItemId file, String destinationFolder, boolean createFolder)	Copies the file to another folder.
void	createFolder(String folder)
void	deleteFile(MailItemId id)
boolean	exists(MailItemId file)
boolean	folderExists(String folder)
Map<String,Object>	getAdditionalFileProperties(MailItemId f)
String	getCanonicalName(MailItemId file)
long	getFileSize(MailItemId file)
protected MsalClientAdapter.GraphClient	getGraphClient()
Date	getModificationTime(MailItemId file)
String	getName(MailItemId msg)	Get a string representation of an identification of a file.
int	getNumberOfFilesInFolder(String folder)
String	getParentFolder(MailItemId msg)
String	getPhysicalDestinationName()
boolean	isFolder(MailItemId file)
DirectoryStream<MailItemId>	list(String folderName, TypeFilter filter)	Lists files, directories or both, from a 'folder' or in the 'root' of the filesystem (when folder is null).
DirectoryStream<MailItemId>	list(MailItemId folderName, TypeFilter filter)
MailMessage	moveFile(MailItemId file, String destinationFolder, boolean createFolder)	Moves the file to another folder.
void	open()
Message	readFile(MailItemId file, String charset)
void	removeFolder(String folder, boolean removeNonEmptyFolder)
void	setAuthAlias(String authAlias)	Alias used to obtain client ID and secret or username and password for authentication to Exchange mail server.
void	setBaseFolder(String baseFolder)	Folder (subfolder of root or of inbox) to look for mails.
void	setClientId(String clientId)	Client ID that represents a registered application in Azure AD which could be found at Azure AD -> App Registrations -> MyApp -> Overview.
void	setClientSecret(String clientSecret)	Client secret that belongs to registered application in Azure AD which could be found at Azure AD -> App Registrations -> MyApp -> Certificates and Secrets
void	setMailAddress(String mailAddress)	The mail address of the mailbox connected to (also used for auto discovery)
void	setProxyAuthAlias(String proxyAuthAlias)	proxy authAlias
void	setProxyDomain(String proxyDomain)	proxy domain
void	setProxyHost(String proxyHost)	proxy host
void	setProxyPassword(String proxyPassword)	proxy password
void	setProxyPort(int proxyPort)	proxy port
void	setProxyUsername(String proxyUsername)	proxy username
void	setReplyAddressFields(String replyAddressFields)	Comma separated list of fields to try as response address
void	setTenantId(String tenantId)	Tenant ID that represents the tenant in which the registered application exists within Azure AD which could be found at Azure AD -> App Registrations -> MyApp -> Overview.
MailItemId	toFile(String id)	Get a file 'F' representation of an identification of a file.
MailItemId	toFile(String childFolderName, String id)	Creates a reference to a file.

Methods inherited from class org.frankframework.filesystem.AbstractFileSystem

getMaxNumberOfMessagesToList, isOpen, setMaxNumberOfMessagesToList

Methods inherited from class java.lang.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 org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.encryption.HasKeystore

getKeyManagerAlgorithm, getKeystore, getKeystoreAlias, getKeystoreAliasAuthAlias, getKeystoreAliasPassword, getKeystoreAuthAlias, getKeystorePassword, getKeystoreType, setKeyManagerAlgorithm, setKeystore, setKeystoreAlias, setKeystoreAliasAuthAlias, setKeystoreAliasPassword, setKeystoreAuthAlias, setKeystorePassword, setKeystoreType

Methods inherited from interface org.frankframework.encryption.HasTruststore

getTrustManagerAlgorithm, getTruststore, getTruststoreAuthAlias, getTruststorePassword, getTruststoreType, isAllowSelfSignedCertificates, isIgnoreCertificateExpiredException, isVerifyHostname, setAllowSelfSignedCertificates, setIgnoreCertificateExpiredException, setTrustManagerAlgorithm, setTruststore, setTruststoreAuthAlias, setTruststorePassword, setTruststoreType, setVerifyHostname

Methods inherited from interface org.frankframework.filesystem.IBasicFileSystem

getCanonicalNameOrErrorMessage

Constructor Details

ExchangeFileSystem

public ExchangeFileSystem()

Method Details

configure

public void configure()
               throws ConfigurationException

Specified by:

configure in interface IBasicFileSystem<MailItemId>

Throws:

ConfigurationException

getGraphClient

protected MsalClientAdapter.GraphClient getGraphClient()
                                                throws IOException

Throws:

IOException

open

public void open()

Specified by:

open in interface IBasicFileSystem<MailItemId>

Overrides:

open in class AbstractFileSystem<MailItemId>

close

public void close()
           throws FileSystemException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IBasicFileSystem<MailItemId>

Overrides:

close in class AbstractFileSystem<MailItemId>

Throws:

FileSystemException

getNumberOfFilesInFolder

public int getNumberOfFilesInFolder(String folder)
                             throws FileSystemException

Specified by:

getNumberOfFilesInFolder in interface IBasicFileSystem<MailItemId>

Overrides:

getNumberOfFilesInFolder in class AbstractFileSystem<MailItemId>

Throws:

FileSystemException

list

public DirectoryStream<MailItemId> list(MailItemId folderName,
 TypeFilter filter)
                                 throws FileSystemException

Specified by:

list in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

list

public DirectoryStream<MailItemId> list(String folderName,
 TypeFilter filter)
                                 throws FileSystemException

Description copied from interface: IBasicFileSystem

Lists files, directories or both, from a 'folder' or in the 'root' of the filesystem (when folder is null). Only lists the objects as defined by the type filter.
Temporary default method until all implementations use IBasicFileSystem.list(F, TypeFilter) TODO: See Issue 7193

Specified by:

list in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

getName

public String getName(MailItemId msg)

Description copied from interface: IBasicFileSystem

Get a string representation of an identification of a file. Must pair up with the implementation of IBasicFileSystem.toFile(String). Can reflect name a file has in its folder, is not expected to be unique over folders.

Specified by:

getName in interface IBasicFileSystem<MailItemId>

getParentFolder

public String getParentFolder(MailItemId msg)
                       throws FileSystemException

Specified by:

getParentFolder in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

toFile

public MailItemId toFile(String id)
                  throws FileSystemException

Description copied from interface: IBasicFileSystem

Get a file 'F' representation of an identification of a file. Must pair up with the implementation of IBasicFileSystem.getName(Object).

Specified by:

toFile in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

toFile

public MailItemId toFile(String childFolderName,
 String id)
                  throws FileSystemException

Description copied from interface: IBasicFileSystem

Creates a reference to a file. If filename is not absolute, it will be created in 'defaultFolder'.

Specified by:

toFile in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

exists

public boolean exists(MailItemId file)
               throws FileSystemException

Specified by:

exists in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

isFolder

public boolean isFolder(MailItemId file)
                 throws FileSystemException

Specified by:

isFolder in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

folderExists

public boolean folderExists(String folder)
                     throws FileSystemException

Specified by:

folderExists in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

readFile

public Message readFile(MailItemId file,
 String charset)
                 throws FileSystemException,
IOException

Specified by:

readFile in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

IOException

deleteFile

public void deleteFile(MailItemId id)
                throws FileSystemException

Specified by:

deleteFile in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

moveFile

public MailMessage moveFile(MailItemId file,
 String destinationFolder,
 boolean createFolder)
                     throws FileSystemException

Description copied from interface: IBasicFileSystem

Moves the file to another folder. Does not need to check for existence of the source or non-existence of the destination. Returns the moved file, or null if no file was moved or there is no reference to the moved file.

Specified by:

moveFile in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

copyFile

public MailMessage copyFile(MailItemId file,
 String destinationFolder,
 boolean createFolder)
                     throws FileSystemException

Description copied from interface: IBasicFileSystem

Copies the file to another folder. Does not need to check for existence of the source or non-existence of the destination. Returns the copied file, or null if no file was copied or there is no reference to the copied file.

Specified by:

copyFile in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

createFolder

public void createFolder(String folder)
                  throws FileSystemException

Specified by:

createFolder in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

removeFolder

public void removeFolder(String folder,
 boolean removeNonEmptyFolder)
                  throws FileSystemException

Specified by:

removeFolder in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

getFileSize

public long getFileSize(MailItemId file)
                 throws FileSystemException

Specified by:

getFileSize in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

getCanonicalName

public String getCanonicalName(MailItemId file)
                        throws FileSystemException

Specified by:

getCanonicalName in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

getModificationTime

public Date getModificationTime(MailItemId file)
                         throws FileSystemException

Specified by:

getModificationTime in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

getAdditionalFileProperties

public Map<String,Object> getAdditionalFileProperties(MailItemId f)
                                               throws FileSystemException

Specified by:

getAdditionalFileProperties in interface IBasicFileSystem<MailItemId>

Throws:

FileSystemException

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setMailAddress

public void setMailAddress(String mailAddress)

The mail address of the mailbox connected to (also used for auto discovery)

setBaseFolder

public void setBaseFolder(String baseFolder)

Folder (subfolder of root or of inbox) to look for mails. If empty, the inbox folder is used

setClientId

public void setClientId(String clientId)

Client ID that represents a registered application in Azure AD which could be found at Azure AD -> App Registrations -> MyApp -> Overview.

setClientSecret

public void setClientSecret(String clientSecret)

Client secret that belongs to registered application in Azure AD which could be found at Azure AD -> App Registrations -> MyApp -> Certificates and Secrets

setTenantId

public void setTenantId(String tenantId)

Tenant ID that represents the tenant in which the registered application exists within Azure AD which could be found at Azure AD -> App Registrations -> MyApp -> Overview.

setAuthAlias

public void setAuthAlias(String authAlias)

Alias used to obtain client ID and secret or username and password for authentication to Exchange mail server. If the attribute tenantId is empty, the deprecated Basic Authentication method is used. If the attribute tenantId is not empty, the username and password are treated as the client ID and secret.

setProxyHost

public void setProxyHost(String proxyHost)

proxy host

setProxyPort

public void setProxyPort(int proxyPort)

proxy port

Default value

8080

setProxyUsername

public void setProxyUsername(String proxyUsername)

proxy username

setProxyPassword

public void setProxyPassword(String proxyPassword)

proxy password

setProxyAuthAlias

public void setProxyAuthAlias(String proxyAuthAlias)

proxy authAlias

setProxyDomain

public void setProxyDomain(String proxyDomain)

proxy domain

setReplyAddressFields

public void setReplyAddressFields(String replyAddressFields)

Comma separated list of fields to try as response address

Default value

"replyTo,from,sender,Return-Path"<M,A>