fr.sii.ogham.email.builder

Class AttachmentHandlingBuilder

java.lang.Object

fr.sii.ogham.core.fluent.AbstractParent<EmailBuilder>

fr.sii.ogham.email.builder.AttachmentHandlingBuilder

All Implemented Interfaces:

Builder<AttachmentResourceTranslator>, ResourceResolutionBuilder<AttachmentHandlingBuilder>, Parent<EmailBuilder>

public class AttachmentHandlingBuilder
extends AbstractParent<EmailBuilder>
implements ResourceResolutionBuilder<AttachmentHandlingBuilder>, Builder<AttachmentResourceTranslator>

Configures how Attachments are handled. Attachment resolution consists of finding a file:

• either on filesystem
• or in the classpath
• or anywhere else

Author:

Aurélien Baudet

Field Summary

Fields inherited from class fr.sii.ogham.core.fluent.AbstractParent

parent

Constructor Summary

Constructors

Constructor and Description
AttachmentHandlingBuilder(EmailBuilder parent, BuildContext buildContext) Initializes the builder with a parent builder.

Method Summary

Modifier and Type	Method and Description
AttachmentResourceTranslator	build() Instantiate and configures the instance.
ClassPathResolutionBuilder<AttachmentHandlingBuilder>	classpath() Configure resource resolution based on classpath.
FileResolutionBuilder<AttachmentHandlingBuilder>	file() Configure resource resolution based on filesystem.
AttachmentHandlingBuilder	resolver(ResourceResolver resolver) Register a custom resolver.
StringResolutionBuilder<AttachmentHandlingBuilder>	string() Configure lookup to use for direct string (when you provide directly the content of a file as string).

Methods inherited from class fr.sii.ogham.core.fluent.AbstractParent

and

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachmentHandlingBuilder

public AttachmentHandlingBuilder(EmailBuilder parent,
                                 BuildContext buildContext)

Initializes the builder with a parent builder. The parent builder is used when calling AbstractParent.and() method. The EnvironmentBuilder is used to evaluate properties when build() method is called.

Parameters:

parent - the parent builder

buildContext - for registering instances and property evaluation

Method Detail

classpath

public ClassPathResolutionBuilder<AttachmentHandlingBuilder> classpath()

Description copied from interface: ResourceResolutionBuilder

Configure resource resolution based on classpath.

You can define the lookup (the prefix that indicates that classpath resolution must be used). For example:

 .classpath().lookup("classpath:");
 
 // path prefixed by classpath: matches 
 // then classpath resolver is used
 resourceResolver.getResource("classpath:foo/bar.html");
 // path is not prefixed (or using another prefix) doesn't match 
 // then classpath resolver is not used
 resourceResolver.getResource("foo/bar.html");
 

You can define a path prefix and suffix for finding resources:

 .classpath().lookup("classpath:").pathPrefix("foo/").pathSuffix(".html");
 
 resourceResolver.getResource("classpath:bar");
 

This will use the classpath resolver and the real path is foo/bar.html.

Specified by:

classpath in interface ResourceResolutionBuilder<AttachmentHandlingBuilder>

Returns:

the builder to configure classpath resolution

file

public FileResolutionBuilder<AttachmentHandlingBuilder> file()

Description copied from interface: ResourceResolutionBuilder

Configure resource resolution based on filesystem.

You can define the lookup (the prefix that indicates that filesystem resolution must be used). For example:

 .file().lookup("file:");
 
 // path prefixed by file: matches 
 // then file resolver is used
 resourceResolver.getResource("file:foo/bar.html");
 // path is not prefixed (or using another prefix) doesn't match 
 // then file resolver is not used
 resourceResolver.getResource("foo/bar.html");
 

You can define a path prefix and suffix for finding resources:

 .file().lookup("file:").pathPrefix("foo/").pathSuffix(".html");
 
 resourceResolver.getResource("file:bar");
 

This will use the file resolver and the real path is foo/bar.html.

Specified by:

file in interface ResourceResolutionBuilder<AttachmentHandlingBuilder>

Returns:

the builder to configure file resolution

string

public StringResolutionBuilder<AttachmentHandlingBuilder> string()

Description copied from interface: ResourceResolutionBuilder

Configure lookup to use for direct string (when you provide directly the content of a file as string).

You can define the lookup (the prefix that indicates that direct string must be used). For example:

 .string().lookup("string:", "s:");
 
 // path prefixed by string: matches 
 // then string is used
 resourceResolver.getResource("string:hello world");
 // path is not prefixed (or using another prefix) doesn't match 
 // then string resolver is not used
 resourceResolver.getResource("foo/bar.html");
 

Specified by:

string in interface ResourceResolutionBuilder<AttachmentHandlingBuilder>

Returns:

the builder to configure string resolution

resolver

public AttachmentHandlingBuilder resolver(ResourceResolver resolver)

Description copied from interface: ResourceResolutionBuilder

Register a custom resolver.

This may be useful to use a custom implementation that is able to load file content from anywhere.

The implementation may be aware of the lookup prefix (see AbstractPrefixedLookupPathResolver). The implementation may also use pathPrefix and pathSuffixes (see RelativeResolver and RelativisableResourceResolver).

Specified by:

resolver in interface ResourceResolutionBuilder<AttachmentHandlingBuilder>

Parameters:

resolver - the custom resolver instance

Returns:

this instance for fluent chaining

build

public AttachmentResourceTranslator build()

Description copied from interface: Builder

Instantiate and configures the instance.

Specified by:

build in interface Builder<AttachmentResourceTranslator>

Returns:

The built instance