A B C D E F G H I J L M N O P R S T U V W X

A

AbstractFixedPhoneNumberHandler - Class in fr.sii.ogham.sms.message.addressing.translator

Extending this abstract class provides an easy way to define the different handlers of a CompositePhoneNumberTranslator.

AbstractFixedPhoneNumberHandler(TypeOfNumber, NumberingPlanIndicator) - Constructor for class fr.sii.ogham.sms.message.addressing.translator.AbstractFixedPhoneNumberHandler

Initializes the translator with the given number, TON and NPI.

AbstractFreeMarkerTemplateLoaderOptionsAdapter - Class in fr.sii.ogham.template.freemarker.adapter

Abstract class to handle options configuration for the adapted TemplateLoader.

AbstractFreeMarkerTemplateLoaderOptionsAdapter() - Constructor for class fr.sii.ogham.template.freemarker.adapter.AbstractFreeMarkerTemplateLoaderOptionsAdapter

AbstractPrefixedLookupPathResolver - Class in fr.sii.ogham.core.resource.resolver

ResourceResolver using a list of supported lookups to compute a simple ResourcePath where resolved path is simply the given path without the lookup.

AbstractPrefixedLookupPathResolver(String...) - Constructor for class fr.sii.ogham.core.resource.resolver.AbstractPrefixedLookupPathResolver

AbstractSpecializedSender<M> - Class in fr.sii.ogham.core.sender

Base class for handling particular message implementation.

AbstractSpecializedSender() - Constructor for class fr.sii.ogham.core.sender.AbstractSpecializedSender

AbstractTemplateResolverOptionsAdapter - Class in fr.sii.ogham.template.thymeleaf.adapter

Abstract class to handle options configuration for the adapted TemplateResolver.

AbstractTemplateResolverOptionsAdapter() - Constructor for class fr.sii.ogham.template.thymeleaf.adapter.AbstractTemplateResolverOptionsAdapter

accept(T) - Method in class fr.sii.ogham.core.condition.AndCondition

accept(T) - Method in interface fr.sii.ogham.core.condition.Condition

Check if the object is accepted or not.

accept(T) - Method in class fr.sii.ogham.core.condition.FixedCondition

accept(T) - Method in class fr.sii.ogham.core.condition.OrCondition

accept(T) - Method in class fr.sii.ogham.core.condition.RequiredClassCondition

accept(T) - Method in class fr.sii.ogham.core.condition.RequiredPropertyCondition

ACCOUNT_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.OvhConstants

The key for OVH account (format sms-nic-X)

adapt(ResourceResolver) - Method in class fr.sii.ogham.template.freemarker.adapter.ClassPathResolverAdapter

adapt(ResourceResolver) - Method in class fr.sii.ogham.template.freemarker.adapter.FileResolverAdapter

adapt(ResourceResolver) - Method in class fr.sii.ogham.template.freemarker.adapter.FirstSupportingResolverAdapter

adapt(ResourceResolver) - Method in class fr.sii.ogham.template.freemarker.adapter.StringResolverAdapter

adapt(ResourceResolver) - Method in interface fr.sii.ogham.template.freemarker.adapter.TemplateLoaderAdapter

Adapts the general template resolver into the specific template loader.

adapt(ResourceResolver) - Method in class fr.sii.ogham.template.thymeleaf.adapter.ClassPathResolverAdapter

adapt(ResourceResolver) - Method in class fr.sii.ogham.template.thymeleaf.adapter.FileResolverAdapter

adapt(ResourceResolver) - Method in class fr.sii.ogham.template.thymeleaf.adapter.FirstSupportingResolverAdapter

adapt(ResourceResolver) - Method in class fr.sii.ogham.template.thymeleaf.adapter.StringResolverAdapter

adapt(ResourceResolver) - Method in interface fr.sii.ogham.template.thymeleaf.adapter.TemplateResolverAdapter

Adapts the general template resolver into the Thymeleaf specific resolver.

add(T) - Method in class fr.sii.ogham.core.builder.MimetypeProviderBuilder

add(PhoneNumberHandler) - Method in class fr.sii.ogham.sms.message.addressing.translator.CompositePhoneNumberTranslator

addAdapter(TemplateLoaderAdapter) - Method in class fr.sii.ogham.template.freemarker.adapter.FirstSupportingResolverAdapter

Register a new adapter.

addAdapter(TemplateResolverAdapter) - Method in class fr.sii.ogham.template.thymeleaf.adapter.FirstSupportingResolverAdapter

Register a new adapter.

addAttachments(List<Attachment>) - Method in class fr.sii.ogham.email.message.content.ContentWithAttachments

addAttachments(List<Attachment>) - Method in class fr.sii.ogham.html.inliner.ContentWithImages

addCharset(String, String) - Method in class fr.sii.ogham.sms.sender.impl.cloudhopper.MapCloudhopperCharsetHandler

Add a charset mapping.

addCharset(String, Charset) - Method in class fr.sii.ogham.sms.sender.impl.cloudhopper.MapCloudhopperCharsetHandler

Add a charset mapping.

addContent(Content) - Method in class fr.sii.ogham.core.message.content.MultiContent

Add a sub content to the list of sub contents.

addContentHandler(Class<? extends Content>, JavaMailContentHandler) - Method in class fr.sii.ogham.email.sender.impl.javamail.MapContentHandler

Register a new content handler.

addDetector(TemplateEngineDetector) - Method in class fr.sii.ogham.core.template.detector.CompositeTemplateDetector

Register a new template engine detector.

addImplementation(Condition<Message>, MessageSender) - Method in class fr.sii.ogham.core.sender.MultiImplementationSender

Register a new possible implementation with the associated condition.

addProvider(MimeTypeProvider) - Method in class fr.sii.ogham.core.mimetype.FallbackMimeTypeProvider

Register a new Mime Type detection implementation.

addProvider(SubjectProvider) - Method in class fr.sii.ogham.core.subject.provider.FirstSupportingSubjectProvider

Register a new provider.

addResolver(ResourceResolver) - Method in class fr.sii.ogham.core.resource.resolver.FirstSupportingResourceResolver

Register a new resolver.

addResourceHandler(Class<? extends NamedResource>, JavaMailAttachmentResourceHandler) - Method in class fr.sii.ogham.email.sender.impl.javamail.MapAttachmentResourceHandler

Register a new attachment resource handler.

AddressedPhoneNumber - Class in fr.sii.ogham.sms.message.addressing

A phone number plus its addressing information (as described in GSM 03.40).

AddressedPhoneNumber(String, TypeOfNumber, NumberingPlanIndicator) - Constructor for class fr.sii.ogham.sms.message.addressing.AddressedPhoneNumber

Initializes the phone number with the given number, TON and NPI.

Addressee - Interface in fr.sii.ogham.core.message.recipient

Base interface for recipients.

AddressingException - Exception in fr.sii.ogham.sms.exception.message

Sending Message Exception relative to any addressing policy issue (TON / NPI).

AddressingException(String, Throwable) - Constructor for exception fr.sii.ogham.sms.exception.message.AddressingException

AddressingException(String) - Constructor for exception fr.sii.ogham.sms.exception.message.AddressingException

AddressingException(Throwable) - Constructor for exception fr.sii.ogham.sms.exception.message.AddressingException

addSender(MessageSender) - Method in class fr.sii.ogham.core.sender.FallbackSender

Register a new sender to try.

addSender(ConditionalSender) - Method in class fr.sii.ogham.core.service.EverySupportingMessagingService

Register a new sender.

addTranslator(ContentTranslator) - Method in class fr.sii.ogham.core.translator.content.EveryContentTranslator

Register a new translator.

addTranslator(AttachmentResourceTranslator) - Method in class fr.sii.ogham.core.translator.resource.EveryResourceTranslator

Register a new translator.

addValue(String, Object) - Method in class fr.sii.ogham.core.template.context.SimpleContext

Add a new variable entry.

AlphanumericCodeNumberFormatHandler - Class in fr.sii.ogham.sms.message.addressing.translator

If the sender address is alphanumeric (contains both letters and numbers) or non-numeric, TON is set to 5 and NPI to 0.

AlphanumericCodeNumberFormatHandler() - Constructor for class fr.sii.ogham.sms.message.addressing.translator.AlphanumericCodeNumberFormatHandler

AndCondition<T> - Class in fr.sii.ogham.core.condition

Condition that provides a logical AND operation on manipulated conditions.

AndCondition(Condition<T>...) - Constructor for class fr.sii.ogham.core.condition.AndCondition

AndCondition(List<Condition<T>>) - Constructor for class fr.sii.ogham.core.condition.AndCondition

ApacheCommonsSender - Class in fr.sii.ogham.email.sender.impl

ApacheCommonsSender() - Constructor for class fr.sii.ogham.email.sender.impl.ApacheCommonsSender

API_KEY - Static variable in class fr.sii.ogham.email.EmailConstants.SendGridConstants

The property key for SendGrid API key

append(Object, Object) - Method in class fr.sii.ogham.core.util.EqualsBuilder

Test if two Objects are equal using their equals method.

append(Object) - Method in class fr.sii.ogham.core.util.HashCodeBuilder

Append a hashCode for an Object.

append(Object...) - Method in class fr.sii.ogham.core.util.HashCodeBuilder

Append a hashCode for an Object.

appendFields(String...) - Method in class fr.sii.ogham.core.util.EqualsBuilder

Test if the two previously registered objects have the same value for each provided field name.

appendSuper(boolean) - Method in class fr.sii.ogham.core.util.EqualsBuilder

Adds the result of super.equals() to this builder.

appendSuper(int) - Method in class fr.sii.ogham.core.util.HashCodeBuilder

Adds the result of super.hashCode() to this builder.

apply(Statement, Description) - Method in class fr.sii.ogham.helper.rule.LoggingTestRule

apply(Statement, Description) - Method in class fr.sii.ogham.helper.sms.rule.SmppServerRule

applyOptions(TemplateResolver) - Method in class fr.sii.ogham.template.thymeleaf.adapter.AbstractTemplateResolverOptionsAdapter

Applies the options to the given TemplateResolver

ArrayUtils - Class in fr.sii.ogham.core.util

Utility class for manipulating arrays.

AssertAttachment - Class in fr.sii.ogham.helper.email

Utility class for checking the attachment of the received email is as expected.

AssertEmail - Class in fr.sii.ogham.helper.email

Utility class for checking if the received email content is as expected.

assertEquals(ExpectedAttachment, Message[]) - Static method in class fr.sii.ogham.helper.email.AssertAttachment

Shortcut for use with GreenMail.

assertEquals(ExpectedAttachment, Message) - Static method in class fr.sii.ogham.helper.email.AssertAttachment

Checks if the received email contains the expected attachment.

assertEquals(ExpectedAttachment, BodyPart) - Static method in class fr.sii.ogham.helper.email.AssertAttachment

It ensures that the values of the received attachment are respected by checking: The mimetype of the attachment The description of the attachment The disposition of the attachment The content of the attachment

assertEquals(ExpectedMultiPartEmail, Message) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Assert that the fields of the received email are equal to the expected values.

assertEquals(ExpectedMultiPartEmail, Message[]) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Shortcut to simplify unit testing with GreenMail.

assertEquals(ExpectedMultiPartEmail[], Message[]) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Assert that each received email content respects the expected one.

assertEquals(ExpectedEmail, Message[]) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Shortcut to simplify unit testing with GreenMail.

assertEquals(ExpectedEmail[], Message[]) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Assert that each received email content respects the expected one.

assertEquals(ExpectedEmail, Message) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Assert that the fields of the received email are equal to the expected values.

assertEquals(ExpectedMultiPartEmail, Message, boolean) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Assert that the fields of the received email are equal to the expected values.

assertEquals(ExpectedEmail, Message, boolean) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Assert that the fields of the received email are equal to the expected values.

assertEquals(ExpectedSms, SubmitSm) - Static method in class fr.sii.ogham.helper.sms.AssertSms

Assert that the fields of the received SMS using SMPP protocol are equal to the expected values.

assertEquals(ExpectedSms, List<SubmitSm>) - Static method in class fr.sii.ogham.helper.sms.AssertSms

Assert that the fields of the received SMS using SMPP protocol are equal to the expected values.

assertEquals(List<ExpectedSms>, List<SubmitSm>) - Static method in class fr.sii.ogham.helper.sms.AssertSms

Assert that the fields of each received SMS using SMPP protocol are equal to values of each expected message.

assertEquals(SplitSms, List<SubmitSm>) - Static method in class fr.sii.ogham.helper.sms.AssertSms

When message is too long, the SMS is split into several parts.

assertEquals(String, Object, boolean) - Static method in class fr.sii.ogham.helper.template.AssertTemplate

Assert that the received content is same as the expected content.

assertEquals(String, String, boolean) - Static method in class fr.sii.ogham.helper.template.AssertTemplate

Assert that the received content is same as the expected content.

AssertHtml - Class in fr.sii.ogham.helper.html

Utility class for checking HTML content.

assertIdentical(String, String) - Static method in class fr.sii.ogham.helper.html.AssertHtml

Check if the HTML is identical to the expected.

assertMimetype(ExpectedContent, Message) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Checks that the received Mime Type for the message is like the expected Mime Type.

assertSimilar(ExpectedMultiPartEmail, Message) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Assert that the fields of the received email are equal to the expected values.

assertSimilar(ExpectedMultiPartEmail, Message[]) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Shortcut to simplify unit testing with GreenMail.

assertSimilar(ExpectedMultiPartEmail[], Message[]) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Assert that each received email content respects the expected one.

assertSimilar(ExpectedEmail, Message[]) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Shortcut to simplify unit testing with GreenMail.

assertSimilar(ExpectedEmail[], Message[]) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Assert that each received email content respects the expected one.

assertSimilar(ExpectedEmail, Message) - Static method in class fr.sii.ogham.helper.email.AssertEmail

Assert that the fields of the received email are equal to the expected values.

assertSimilar(String, String) - Static method in class fr.sii.ogham.helper.html.AssertHtml

Check if the HTML is similar to the expected.

assertSimilar(String, Object) - Static method in class fr.sii.ogham.helper.template.AssertTemplate

Assert that the received content is same as the expected content.

AssertSms - Class in fr.sii.ogham.helper.sms

Utility class for checking if the received SMS content is as expected.

AssertTemplate - Class in fr.sii.ogham.helper.template

Assertion class that simplifies checking template content.

asString() - Method in interface fr.sii.ogham.core.message.content.MayHaveStringContent

Provides the content as String.

asString() - Method in class fr.sii.ogham.core.message.content.StringContent

asString() - Method in class fr.sii.ogham.email.message.content.ContentWithAttachments

attach(List<Attachment>) - Method in class fr.sii.ogham.email.message.Email

Set the whole list of attachments.

attach(Attachment...) - Method in class fr.sii.ogham.email.message.Email

Set the whole list of attachments.

attach(Attachment) - Method in class fr.sii.ogham.email.message.Email

Add an attachment to join to the mail.

Attachment - Class in fr.sii.ogham.email.attachment

Represents a content to attach to the email.

Attachment(NamedResource, String, String, String) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided resource (content and name), the description of the attachment and the disposition (how to include the attachment into the mail).

Attachment(NamedResource, String, String) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided resource (content and name), the description of the attachment and the disposition (how to include the attachment into the mail).

Attachment(NamedResource, String) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided resource (content and name), the description of the attachment.

Attachment(NamedResource) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided resource (content and name).

Attachment(String, String, String) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided path, description of the attachment and disposition (how to include the attachment into the mail).

Attachment(String, String) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided path and description of the attachment.

Attachment(String) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided path.

Attachment(String, InputStream, String, String) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided content, name, description of the attachment and disposition (how to include the attachment into the mail).

Attachment(String, InputStream, String) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided content, name and description of the attachment.

Attachment(String, InputStream) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided content and name.

Attachment(String, byte[], String, String) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided content, name, description of the attachment and disposition (how to include the attachment into the mail).

Attachment(String, byte[], String) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided content, name and description of the attachment.

Attachment(String, byte[]) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided content and name.

Attachment(File, String, String) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided file, description of the attachment and disposition (how to include the attachment into the mail).

Attachment(File, String) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided file and description of the attachment.

Attachment(File) - Constructor for class fr.sii.ogham.email.attachment.Attachment

Initialize the attachment with the provided file.

ATTACHMENT - Static variable in class fr.sii.ogham.email.attachment.ContentDisposition

AttachmentResourceHandlerException - Exception in fr.sii.ogham.email.exception.javamail

AttachmentResourceHandlerException(String, Attachment, Throwable) - Constructor for exception fr.sii.ogham.email.exception.javamail.AttachmentResourceHandlerException

AttachmentResourceHandlerException(String, Attachment) - Constructor for exception fr.sii.ogham.email.exception.javamail.AttachmentResourceHandlerException

AttachmentResourceHandlerException(Throwable, Attachment) - Constructor for exception fr.sii.ogham.email.exception.javamail.AttachmentResourceHandlerException

AttachmentResourceTranslator - Interface in fr.sii.ogham.core.translator.resource

The aim of a resource translator is to transform a resource into a new one.

AttachmentResourceTranslatorBuilder - Class in fr.sii.ogham.email.builder

Builder for constructing a chained translator.

AttachmentResourceTranslatorBuilder() - Constructor for class fr.sii.ogham.email.builder.AttachmentResourceTranslatorBuilder

AttachmentResourceTranslatorSender - Class in fr.sii.ogham.email.sender

Decorator sender that transforms the attachments of the message before really sending it.

AttachmentResourceTranslatorSender(AttachmentResourceTranslator, MessageSender) - Constructor for class fr.sii.ogham.email.sender.AttachmentResourceTranslatorSender

Initialize the sender with the provided translator and decorated sender.

AUTHENTICATOR_PASSWORD_KEY - Static variable in class fr.sii.ogham.email.EmailConstants.SmtpConstants

The key in the properties for password to use in the authenticator

AUTHENTICATOR_PROPERTIES_PREFIX - Static variable in class fr.sii.ogham.email.EmailConstants.SmtpConstants

The prefix for email authenticator properties

AUTHENTICATOR_USERNAME_KEY - Static variable in class fr.sii.ogham.email.EmailConstants.SmtpConstants

The key in the properties for username to use in the authenticator

AutoDetectTemplateParser - Class in fr.sii.ogham.core.template.parser

Decorator that automatically detects the template engine parser to use.

AutoDetectTemplateParser(ResourceResolver, Map<TemplateEngineDetector, TemplateParser>) - Constructor for class fr.sii.ogham.core.template.parser.AutoDetectTemplateParser

B

Base64Utils - Class in fr.sii.ogham.core.util

bcc(String) - Method in class fr.sii.ogham.email.message.Email

Add a "bcc" recipient address.

bcc(EmailAddress) - Method in class fr.sii.ogham.email.message.Email

Add a "bcc" recipient address.

bcc - Variable in class fr.sii.ogham.helper.email.ExpectedEmailHeader

The expected list of recipients for the "bcc" field

BeanContext - Class in fr.sii.ogham.core.template.context

Template context that provides variable values using a Java object.

BeanContext(Object) - Constructor for class fr.sii.ogham.core.template.context.BeanContext

Register the bean to use for variable substitutions.

BeanContextException - Exception in fr.sii.ogham.core.exception.template

BeanContextException(String, Object, Throwable) - Constructor for exception fr.sii.ogham.core.exception.template.BeanContextException

BeanContextException(String, Object) - Constructor for exception fr.sii.ogham.core.exception.template.BeanContextException

BeanContextException(Object, Throwable) - Constructor for exception fr.sii.ogham.core.exception.template.BeanContextException

BeanException - Exception in fr.sii.ogham.core.exception.template

BeanException(String, Object, Throwable) - Constructor for exception fr.sii.ogham.core.exception.template.BeanException

BeanException(String, Object) - Constructor for exception fr.sii.ogham.core.exception.template.BeanException

BeanException(Object, Throwable) - Constructor for exception fr.sii.ogham.core.exception.template.BeanException

BeanUtils - Class in fr.sii.ogham.core.util

Helper class for bean management: Converts an object into a map Fills a bean with values provided in a map This work can be done by several libraries.

BeanUtils.Options - Class in fr.sii.ogham.core.util

BIND_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants.TimeoutConstants

The key of property for time to wait for a bind response

build() - Method in interface fr.sii.ogham.core.builder.Builder

Build the object

build() - Method in class fr.sii.ogham.core.builder.ContentTranslatorBuilder

Generate a chain translator that delegates translation of content to all enabled translators.

build() - Method in class fr.sii.ogham.core.builder.FirstSupportingResourceResolverBuilder

build() - Method in class fr.sii.ogham.core.builder.MessageFillerBuilder

build() - Method in class fr.sii.ogham.core.builder.MessagingBuilder

Build the messaging service.

build() - Method in class fr.sii.ogham.core.builder.MimetypeProviderBuilder

build() - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Build the template parser according to options previously enabled.

build() - Method in class fr.sii.ogham.email.builder.AttachmentResourceTranslatorBuilder

Generate a chain translator that delegates translation of resource to all enabled translators.

build() - Method in class fr.sii.ogham.email.builder.EmailBuilder

build() - Method in class fr.sii.ogham.email.builder.JavaMailBuilder

build() - Method in class fr.sii.ogham.email.builder.SendGridBuilder

build() - Method in class fr.sii.ogham.sms.builder.CloudhopperSMPPBuilder

build() - Method in class fr.sii.ogham.sms.builder.DefaultPhoneNumberTranslatorBuilder

build() - Method in class fr.sii.ogham.sms.builder.OvhSmsBuilder

build() - Method in class fr.sii.ogham.sms.builder.RecipientPhoneNumberTranslatorBuilder

build() - Method in class fr.sii.ogham.sms.builder.SenderPhoneNumberTranslatorBuilder

build() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

build() - Method in class fr.sii.ogham.spring.xml.SpringXMLMessagingBuilder

build() - Method in class fr.sii.ogham.template.freemarker.builder.FreeMarkerTemplateParserBuilder

build() - Method in class fr.sii.ogham.template.thymeleaf.builder.ThymeleafTemplateParserBuilder

Builder<T> - Interface in fr.sii.ogham.core.builder

General interface for all builders.

BuilderUtils - Class in fr.sii.ogham.core.util

Helper class for Builder implementations.

BuildException - Exception in fr.sii.ogham.core.exception.builder

BuildException(String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.builder.BuildException

BuildException(String) - Constructor for exception fr.sii.ogham.core.exception.builder.BuildException

BuildException(Throwable) - Constructor for exception fr.sii.ogham.core.exception.builder.BuildException

ByteResource - Class in fr.sii.ogham.core.resource

Basic implementation of a NamedResource that simply stores a reference to the provided bytes.

ByteResource(String, InputStream) - Constructor for class fr.sii.ogham.core.resource.ByteResource

ByteResource(String, byte[]) - Constructor for class fr.sii.ogham.core.resource.ByteResource

Initialize the resource with the provided name and bytes.

C

canParse(String, Context, Resource) - Method in class fr.sii.ogham.core.template.detector.FixedEngineDetector

canParse(String, Context, Resource) - Method in class fr.sii.ogham.core.template.detector.OrTemplateDetector

canParse(String, Context, Resource) - Method in interface fr.sii.ogham.core.template.detector.TemplateEngineDetector

Indicates if the template can be parsed or not.

canParse(String, Context, Resource) - Method in class fr.sii.ogham.template.freemarker.FreeMarkerTemplateDetector

canParse(String, Context, Resource) - Method in class fr.sii.ogham.template.thymeleaf.ThymeleafTemplateDetector

canProvideString() - Method in interface fr.sii.ogham.core.message.content.MayHaveStringContent

Tells if the content is available as String.

canProvideString() - Method in class fr.sii.ogham.core.message.content.StringContent

canProvideString() - Method in class fr.sii.ogham.email.message.content.ContentWithAttachments

cc(String) - Method in class fr.sii.ogham.email.message.Email

Add a "cc" recipient address.

cc(EmailAddress) - Method in class fr.sii.ogham.email.message.Email

Add a "cc" recipient address.

cc - Variable in class fr.sii.ogham.helper.email.ExpectedEmailHeader

The expected list of recipients for the "cc" field

CharsetProvider - Interface in fr.sii.ogham.core.charset

Interface for all charset providers.

ClasspathHelper - Class in fr.sii.ogham.core.util

Helper for classpath management.

ClassPathResolver - Class in fr.sii.ogham.core.resource.resolver

Resource resolver that searches for the resource into the classpath.

ClassPathResolver(String...) - Constructor for class fr.sii.ogham.core.resource.resolver.ClassPathResolver

ClassPathResolverAdapter - Class in fr.sii.ogham.template.freemarker.adapter

Adapter that converts general ClassPathResolver into FreeMarker specific ClassTemplateLoader.

ClassPathResolverAdapter() - Constructor for class fr.sii.ogham.template.freemarker.adapter.ClassPathResolverAdapter

ClassPathResolverAdapter - Class in fr.sii.ogham.template.thymeleaf.adapter

Adapter that converts general ClassPathResolver into Thymeleaf specific ClassLoaderTemplateResolver.

ClassPathResolverAdapter() - Constructor for class fr.sii.ogham.template.thymeleaf.adapter.ClassPathResolverAdapter

closeTemplateSource(Object) - Method in class fr.sii.ogham.template.freemarker.FreeMarkerFirstSupportingTemplateLoader

CLOUDHOPPER_PREFIX - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants.CloudhopperConstants

The prefix for Cloudhopper implementation specific properties

CloudhopperCharsetHandler - Interface in fr.sii.ogham.sms.sender.impl.cloudhopper

Handles charset detection for messages content.

CloudhopperOptions - Class in fr.sii.ogham.sms.sender.impl.cloudhopper

CloudhopperOptions(long, long) - Constructor for class fr.sii.ogham.sms.sender.impl.cloudhopper.CloudhopperOptions

CloudhopperSMPPBuilder - Class in fr.sii.ogham.sms.builder

Builder that helps to construct the Cloudhopper SMPP implementation.

CloudhopperSMPPBuilder() - Constructor for class fr.sii.ogham.sms.builder.CloudhopperSMPPBuilder

CloudhopperSMPPSender - Class in fr.sii.ogham.sms.sender.impl

Implementation based on cloudhopper-smpp library.

CloudhopperSMPPSender(SmppSessionConfiguration, CloudhopperOptions, CloudhopperCharsetHandler) - Constructor for class fr.sii.ogham.sms.sender.impl.CloudhopperSMPPSender

Initializes a CloudhopperSMPPSender with SMPP session configuration, some options and a default phone translator to handle addressing policy.

CloudhopperSMPPSender(SmppSessionConfiguration, CloudhopperOptions, CloudhopperCharsetHandler, PhoneNumberTranslator) - Constructor for class fr.sii.ogham.sms.sender.impl.CloudhopperSMPPSender

Initializes a CloudhopperSMPPSender with SMPP session configuration, some options and a default phone translator to handle addressing policy.

CloudhopperSMPPServer - Class in fr.sii.ogham.helper.sms.cloudhopper

CloudhopperSMPPServer(int, TestSmppServerHandler) - Constructor for class fr.sii.ogham.helper.sms.cloudhopper.CloudhopperSMPPServer

CloudhopperSMPPServer(int, String, String) - Constructor for class fr.sii.ogham.helper.sms.cloudhopper.CloudhopperSMPPServer

CloudhopperSMPPServer(int) - Constructor for class fr.sii.ogham.helper.sms.cloudhopper.CloudhopperSMPPServer

ComparisonException - Exception in fr.sii.ogham.helper.exception

ComparisonException(String, Throwable) - Constructor for exception fr.sii.ogham.helper.exception.ComparisonException

ComparisonException(String) - Constructor for exception fr.sii.ogham.helper.exception.ComparisonException

ComparisonException(Throwable) - Constructor for exception fr.sii.ogham.helper.exception.ComparisonException

CompositeCondition<T> - Class in fr.sii.ogham.core.condition

CompositeCondition(List<Condition<T>>) - Constructor for class fr.sii.ogham.core.condition.CompositeCondition

CompositeCondition(Condition<T>...) - Constructor for class fr.sii.ogham.core.condition.CompositeCondition

CompositePhoneNumberTranslator - Class in fr.sii.ogham.sms.message.addressing.translator

Composite phone number translator, delegating the translation to a list of handlers to try.

CompositePhoneNumberTranslator(PhoneNumberHandler...) - Constructor for class fr.sii.ogham.sms.message.addressing.translator.CompositePhoneNumberTranslator

Initializes the translator with the given handlers.

CompositeTemplateDetector - Class in fr.sii.ogham.core.template.detector

A decorator for template engine detection that relies on other template engine detectors.

CompositeTemplateDetector(TemplateEngineDetector...) - Constructor for class fr.sii.ogham.core.template.detector.CompositeTemplateDetector

Initialize the composite detector with none, one or several detector implementations.

CompositeTemplateDetector(List<TemplateEngineDetector>) - Constructor for class fr.sii.ogham.core.template.detector.CompositeTemplateDetector

Initialize the composite detector with the provided detector implementation list.

computeResourceName(TemplateProcessingParameters) - Method in class fr.sii.ogham.template.thymeleaf.resolver.FixClassLoaderTemplateResolver

concat(T, T[]) - Static method in class fr.sii.ogham.core.util.ArrayUtils

Create an array starting with first element and followed by others.

concat(T[], T[]) - Static method in class fr.sii.ogham.core.util.ArrayUtils

Combine two arrays.

Condition<T> - Interface in fr.sii.ogham.core.condition

Interface that declares a condition.

ConditionalSender - Interface in fr.sii.ogham.core.sender

This specialization of the sender allows to indicate if the implementation is able to handle the message or not.

configure(MessagingBuilder) - Method in class fr.sii.ogham.spring.autoconfigure.NoTemplateEngineConfigurer

configure(MessagingBuilder) - Method in class fr.sii.ogham.spring.config.FreeMarkerConfigurer

configure(MessagingBuilder) - Method in interface fr.sii.ogham.spring.config.MessagingBuilderConfigurer

configure(MessagingBuilder) - Method in class fr.sii.ogham.spring.config.ThymeLeafConfigurer

CONNECTION_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants.TimeoutConstants

The key of property for timeout of TCP/IP connection for SMPP session

Contact - Class in fr.sii.ogham.sms.message

A SMS contact taht contains the following information: The name of the contact (optional) The phone number of the contact

Contact(String) - Constructor for class fr.sii.ogham.sms.message.Contact

Initialize the contact with its phone number as string.

Contact(String, String) - Constructor for class fr.sii.ogham.sms.message.Contact

Initialize the contact with its name and its phone number as string.

Contact(PhoneNumber) - Constructor for class fr.sii.ogham.sms.message.Contact

Initialize the contact with its name and its phone number.

Contact(String, PhoneNumber) - Constructor for class fr.sii.ogham.sms.message.Contact

Initialize the contact with its name and its phone number.

content(Content) - Method in interface fr.sii.ogham.core.message.capability.HasContentFluent

Set the content of the message

content(String) - Method in interface fr.sii.ogham.core.message.capability.HasContentFluent

Set the content of the message

Content - Interface in fr.sii.ogham.core.message.content

Marker interface for message content.

content(Content) - Method in class fr.sii.ogham.email.message.Email

Set the content (body) of the message.

content(String) - Method in class fr.sii.ogham.email.message.Email

Set the content (body) of the message.

content(Content) - Method in class fr.sii.ogham.sms.message.Sms

Set the content of the message.

content(String) - Method in class fr.sii.ogham.sms.message.Sms

Set the content of the message.

ContentDisposition - Class in fr.sii.ogham.email.attachment

ContentHandlerException - Exception in fr.sii.ogham.email.exception.javamail

ContentHandlerException(String, Content, Throwable) - Constructor for exception fr.sii.ogham.email.exception.javamail.ContentHandlerException

ContentHandlerException(String, Content) - Constructor for exception fr.sii.ogham.email.exception.javamail.ContentHandlerException

ContentHandlerException(Throwable, Content) - Constructor for exception fr.sii.ogham.email.exception.javamail.ContentHandlerException

ContentHandlerException - Exception in fr.sii.ogham.email.exception.sendgrid

Exceptions related to errors happening at the content handler level.

ContentHandlerException(String, Throwable) - Constructor for exception fr.sii.ogham.email.exception.sendgrid.ContentHandlerException

Builds a content handler-related exception due to an underlying exception.

ContentHandlerException(String) - Constructor for exception fr.sii.ogham.email.exception.sendgrid.ContentHandlerException

Builds a content handler-related exception with no underlying exception.

ContentTranslator - Interface in fr.sii.ogham.core.translator.content

The aim of a content translator is to transform a content into a new one.

ContentTranslatorBuilder - Class in fr.sii.ogham.core.builder

Builder for constructing a chained translator.

ContentTranslatorBuilder() - Constructor for class fr.sii.ogham.core.builder.ContentTranslatorBuilder

ContentTranslatorException - Exception in fr.sii.ogham.core.exception.handler

ContentTranslatorException(String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.handler.ContentTranslatorException

ContentTranslatorException(String) - Constructor for exception fr.sii.ogham.core.exception.handler.ContentTranslatorException

ContentTranslatorException(Throwable) - Constructor for exception fr.sii.ogham.core.exception.handler.ContentTranslatorException

ContentTranslatorSender - Class in fr.sii.ogham.core.sender

Decorator sender that transforms the content of the message before really sending it.

ContentTranslatorSender(ContentTranslator, MessageSender) - Constructor for class fr.sii.ogham.core.sender.ContentTranslatorSender

Initialize the sender with the provided translator and decorated sender.

ContentWithAttachments - Class in fr.sii.ogham.email.message.content

Decorator that embeds attachments with the decorated content.

ContentWithAttachments(Content, List<Attachment>) - Constructor for class fr.sii.ogham.email.message.content.ContentWithAttachments

ContentWithAttachmentsHandler - Class in fr.sii.ogham.email.sender.impl.javamail

ContentWithAttachmentsHandler(JavaMailContentHandler) - Constructor for class fr.sii.ogham.email.sender.impl.javamail.ContentWithAttachmentsHandler

ContentWithImages - Class in fr.sii.ogham.html.inliner

ContentWithImages(String, Attachment...) - Constructor for class fr.sii.ogham.html.inliner.ContentWithImages

ContentWithImages(String, List<Attachment>) - Constructor for class fr.sii.ogham.html.inliner.ContentWithImages

Context - Interface in fr.sii.ogham.core.template.context

A template contains variables.

ContextException - Exception in fr.sii.ogham.core.exception.template

ContextException(String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.template.ContextException

ContextException(String) - Constructor for exception fr.sii.ogham.core.exception.template.ContextException

ContextException(Throwable) - Constructor for exception fr.sii.ogham.core.exception.template.ContextException

convert(Object) - Static method in class fr.sii.ogham.core.util.BeanUtils

Convert a Java object into a map.

convert(Environment) - Method in class fr.sii.ogham.spring.config.PropertiesBridge

Convert the environment to properties.

convert(Context) - Method in class fr.sii.ogham.template.thymeleaf.SimpleThymeleafContextConverter

convert(Context) - Method in interface fr.sii.ogham.template.thymeleaf.ThymeleafContextConverter

Convert abstraction used for all template engines into a Thymeleaf context.

convertToType(Class<T>, Object) - Method in class fr.sii.ogham.core.util.converter.EmailAddressConverter

convertToType(Class<T>, Object) - Method in class fr.sii.ogham.core.util.converter.SmsSenderConverter

CssInliner - Interface in fr.sii.ogham.html.inliner

D

DecoratorContent - Interface in fr.sii.ogham.core.message.content

Interface for decorator pattern.

DEFAULT_PORT - Static variable in class fr.sii.ogham.helper.sms.rule.SmppServerRule

The default port used by the server if none is specified

DEFAULT_RESPONSE_TIMEOUT - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants.CloudhopperConstants

The default value for response timeout

DEFAULT_UNBIND_TIMEOUT - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants.CloudhopperConstants

The default value for unbind timeout

DefaultContentTranslator - Class in fr.sii.ogham.core.translator.content

Apply no transformation at all.

DefaultContentTranslator() - Constructor for class fr.sii.ogham.core.translator.content.DefaultContentTranslator

defaultFreemarkerConfiguration() - Method in class fr.sii.ogham.spring.autoconfigure.OghamAutoConfiguration.OghamFreemarkerConfiguration

DefaultHandler - Class in fr.sii.ogham.sms.message.addressing.translator

Default handler.

DefaultHandler() - Constructor for class fr.sii.ogham.sms.message.addressing.translator.DefaultHandler

defaultMessagingBuilder(PropertiesBridge, List<MessagingBuilderConfigurer>) - Method in class fr.sii.ogham.spring.autoconfigure.OghamAutoConfiguration

defaultMessagingBuilderConfigurer() - Method in class fr.sii.ogham.spring.autoconfigure.OghamAutoConfiguration.OghamNoTemplateEngineConfiguration

defaultMimetype(String) - Method in class fr.sii.ogham.core.builder.MimetypeProviderBuilder

defaultMimetype() - Method in class fr.sii.ogham.core.builder.MimetypeProviderBuilder

DefaultPhoneNumberTranslatorBuilder - Class in fr.sii.ogham.sms.builder

Builder to construct the PhoneNumberTranslator implementation in charge of default addressing policy (TON / NPI).

DefaultPhoneNumberTranslatorBuilder() - Constructor for class fr.sii.ogham.sms.builder.DefaultPhoneNumberTranslatorBuilder

DefaultResourceResolver - Class in fr.sii.ogham.core.resource.resolver

Decorates an AbstractPrefixedLookupPathResolver to manage a default case (no lookup found).

DefaultResourceResolver(AbstractPrefixedLookupPathResolver) - Constructor for class fr.sii.ogham.core.resource.resolver.DefaultResourceResolver

Initialize the resolver with the mandatory delegate.

DefaultResourceTranslator - Class in fr.sii.ogham.core.translator.resource

Apply no transformation at all.

DefaultResourceTranslator() - Constructor for class fr.sii.ogham.core.translator.resource.DefaultResourceTranslator

DelegateResourceResolver - Interface in fr.sii.ogham.core.resource.resolver

DelegateSendGridClient - Class in fr.sii.ogham.email.sender.impl.sendgrid.client

Facade wrapping the SendGrid object.

DelegateSendGridClient(SendGrid) - Constructor for class fr.sii.ogham.email.sender.impl.sendgrid.client.DelegateSendGridClient

Constructor.

DelegateSendGridClient(String, String) - Constructor for class fr.sii.ogham.email.sender.impl.sendgrid.client.DelegateSendGridClient

DelegateSendGridClient(String) - Constructor for class fr.sii.ogham.email.sender.impl.sendgrid.client.DelegateSendGridClient

detect(InputStream) - Method in class fr.sii.ogham.core.mimetype.FallbackMimeTypeProvider

detect(String) - Method in class fr.sii.ogham.core.mimetype.FallbackMimeTypeProvider

detect(InputStream) - Method in class fr.sii.ogham.core.mimetype.FixedMimeTypeProvider

detect(String) - Method in class fr.sii.ogham.core.mimetype.FixedMimeTypeProvider

detect(InputStream) - Method in class fr.sii.ogham.core.mimetype.JavaActivationProvider

detect(String) - Method in class fr.sii.ogham.core.mimetype.JavaActivationProvider

detect(InputStream) - Method in class fr.sii.ogham.core.mimetype.JavaFilesProvider

detect(String) - Method in class fr.sii.ogham.core.mimetype.JavaFilesProvider

detect(InputStream) - Method in interface fr.sii.ogham.core.mimetype.MimeTypeProvider

Get the Mime Type based on the content.

detect(String) - Method in interface fr.sii.ogham.core.mimetype.MimeTypeProvider

Get the Mime Type based on the content.

detect(InputStream) - Method in class fr.sii.ogham.core.mimetype.TikaProvider

detect(String) - Method in class fr.sii.ogham.core.mimetype.TikaProvider

E

Email - Class in fr.sii.ogham.email.message

Email message that contains the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address The list of recipient addresses with the type (to, cc, bcc) The list of attachments to join to the mail

Email() - Constructor for class fr.sii.ogham.email.message.Email

Default constructor for using fluent API.

Email(String, String, String...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address None, one or several "to" recipient addresses (typical address syntax is of the form "user@host.domain" or "Personal Name <user@host.domain>"), it will create a list of Recipient with RecipientType.TO for you No sender address is specified.

Email(String, Content, Recipient[]) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address Array of recipients No sender address is specified.

Email(String, Content, Recipient, Recipient...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address One or several recipients No sender address is specified.

Email(String, Content, List<Recipient>) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address None, one or several "to" recipient addresses, it will create a list of Recipient with RecipientType.TO for you No sender address is specified.

Email(String, Content, EmailAddress, EmailAddress...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address None, one or several "to" recipient addresses, it will create a list of Recipient with RecipientType.TO for you No attachment is added to the email.

Email(String, Content, String...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address None, one or several "to" recipient addresses, it will create a list of Recipient with RecipientType.TO for you No sender address is specified.

Email(String, String, EmailAddress, String...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address None, one or several "to" recipient addresses (typical address syntax is of the form "user@host.domain" or "Personal Name <user@host.domain>"), it will create a list of Recipient with RecipientType.TO for you No attachment is added to the email.

Email(String, Content, EmailAddress, Recipient[]) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address Array of recipients No attachment is added to the email.

Email(String, Content, EmailAddress, Recipient, Recipient...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address One or several recipients No attachment is added to the email.

Email(String, Content, EmailAddress, List<Recipient>) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address The list of recipients No attachment is added to the email.

Email(String, String, String, Attachment, Attachment...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail as string, it will create a StringContent for you The single address used in to field (typical address syntax is of the form "user@host.domain" or "Personal Name <user@host.domain>"), it will create a Recipient with RecipientType.TO for you One or several attachments to join to the mail No sender address is specified.

Email(String, String, List<String>, Attachment...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail as string, it will create a StringContent for you The list of "to" recipient addresses (typical address syntax is of the form "user@host.domain" or "Personal Name <user@host.domain>"), it will create a list of Recipient with RecipientType.TO type for you None, one or several attachments to join to the mail No sender address is specified.

Email(String, String, EmailAddress, String, Attachment, Attachment...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail as string, it will create a StringContent for you The sender address The single address used in to field (typical address syntax is of the form "user@host.domain" or "Personal Name <user@host.domain>"), it will create a Recipient with RecipientType.TO for you One or several attachments to join to the mail

Email(String, Content, Recipient, Attachment[]) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) A single recipient with its type (to, cc, bcc) Array of attachments to join to the mail No sender address is specified.

Email(String, Content, Recipient, Attachment, Attachment...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) A single recipient with its type (to, cc, bcc) One or several attachments to join to the mail No sender address is specified.

Email(String, Content, List<Recipient>, Attachment...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The list of recipient addresses with the type (to, cc, bcc) None, one or several attachments to join to the mail No sender address is specified.

Email(String, Content, Recipient, List<Attachment>) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) A single recipient with its type (to, cc, bcc) The list of attachments to join to the mail No sender address is specified.

Email(String, Content, List<Recipient>, List<Attachment>) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The list of recipient addresses with the type (to, cc, bcc) The list of attachments to join to the mail No sender address is specified.

Email(String, Content, EmailAddress, String, Attachment, Attachment...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address The single address used in to field (typical address syntax is of the form "user@host.domain" or "Personal Name <user@host.domain>"), it will create a Recipient with RecipientType.TO for you One or several attachments to join to the mail

Email(String, Content, EmailAddress, List<Recipient>, Attachment...) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information The sender address The list of recipient addresses with the type (to, cc, bcc) None, one or several attachments to join to the mail

Email(String, Content, EmailAddress, List<Recipient>, List<Attachment>) - Constructor for class fr.sii.ogham.email.message.Email

Initialize the email with the following information: The subject of the mail The body of the mail (see Content and sub classes for more information) The sender address The list of recipient addresses with the type (to, cc, bcc) The list of attachments to join to the mail

EmailAddress - Class in fr.sii.ogham.email.message

Represents an email address.

EmailAddress(String) - Constructor for class fr.sii.ogham.email.message.EmailAddress

Initialize the address with only the email address part (no personal).

EmailAddress(String, String) - Constructor for class fr.sii.ogham.email.message.EmailAddress

Initialize the address with the email address and the personal parts.

EmailAddressConverter - Class in fr.sii.ogham.core.util.converter

Converts the provided object into an EmailAddress.

EmailAddressConverter() - Constructor for class fr.sii.ogham.core.util.converter.EmailAddressConverter

EmailBuilder - Class in fr.sii.ogham.email.builder

Specialized builder for email sender.

EmailBuilder() - Constructor for class fr.sii.ogham.email.builder.EmailBuilder

EmailConstants - Class in fr.sii.ogham.email

EmailConstants.SendGridConstants - Class in fr.sii.ogham.email

EmailConstants.SmtpConstants - Class in fr.sii.ogham.email

EmailConstants.TemplateConstants - Class in fr.sii.ogham.email

EmailSender - Class in fr.sii.ogham.email.sender

Specialization of MultiImplementationSender for managing emails using several implementations.

EmailSender() - Constructor for class fr.sii.ogham.email.sender.EmailSender

EmailSender(Condition<Message>, MessageSender) - Constructor for class fr.sii.ogham.email.sender.EmailSender

EmailSender(Map<Condition<Message>, MessageSender>) - Constructor for class fr.sii.ogham.email.sender.EmailSender

EmailVariant - Enum in fr.sii.ogham.core.message.content

enableAlphanumericCodeFormat() - Method in class fr.sii.ogham.sms.builder.SenderPhoneNumberTranslatorBuilder

enableEmailTemplateKeys() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Calling this method will enable different location for email templates from default one.

enableInternationalNumberFormat() - Method in class fr.sii.ogham.sms.builder.RecipientPhoneNumberTranslatorBuilder

enableInternationalNumberFormat() - Method in class fr.sii.ogham.sms.builder.SenderPhoneNumberTranslatorBuilder

enableShortCodeFormat() - Method in class fr.sii.ogham.sms.builder.SenderPhoneNumberTranslatorBuilder

enableSmsTemplateKeys() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Calling this method will enable different location for SMS templates from default one.

encode(String) - Method in interface fr.sii.ogham.sms.sender.impl.cloudhopper.CloudhopperCharsetHandler

Encodes the message string content after a charset detection.

encode(String) - Method in class fr.sii.ogham.sms.sender.impl.cloudhopper.MapCloudhopperCharsetHandler

encodeToString(byte[]) - Static method in class fr.sii.ogham.core.util.Base64Utils

EncodingException - Exception in fr.sii.ogham.sms.exception.message

Sending Message Exception relative to any encoding policy issue .

EncodingException(String, Throwable) - Constructor for exception fr.sii.ogham.sms.exception.message.EncodingException

EncodingException(String) - Constructor for exception fr.sii.ogham.sms.exception.message.EncodingException

EncodingException(Throwable) - Constructor for exception fr.sii.ogham.sms.exception.message.EncodingException

EngineDetectionException - Exception in fr.sii.ogham.core.exception.template

EngineDetectionException(String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.template.EngineDetectionException

EngineDetectionException(String) - Constructor for exception fr.sii.ogham.core.exception.template.EngineDetectionException

EngineDetectionException(Throwable) - Constructor for exception fr.sii.ogham.core.exception.template.EngineDetectionException

equals(Object) - Method in class fr.sii.ogham.core.condition.CompositeCondition

equals(Object) - Method in class fr.sii.ogham.core.condition.FixedCondition

equals(Object) - Method in class fr.sii.ogham.core.condition.RequiredClassCondition

equals(Object) - Method in class fr.sii.ogham.core.condition.RequiredPropertyCondition

equals(Object) - Method in class fr.sii.ogham.core.message.content.MultiContent

equals(Object) - Method in class fr.sii.ogham.core.message.content.StringContent

equals(Object) - Method in class fr.sii.ogham.core.message.content.TemplateContent

equals(Object) - Method in class fr.sii.ogham.core.message.content.TemplateVariantContent

equals(Object) - Method in class fr.sii.ogham.core.resource.ByteResource

equals(Object) - Method in class fr.sii.ogham.core.resource.FileResource

equals(Object) - Method in class fr.sii.ogham.core.resource.LookupResource

equals(Object) - Method in class fr.sii.ogham.core.template.context.BeanContext

equals(Object) - Method in class fr.sii.ogham.core.template.context.SimpleContext

equals(Object) - Method in class fr.sii.ogham.core.util.HashCodeBuilder

equals(Object) - Method in class fr.sii.ogham.email.attachment.Attachment

equals(Object) - Method in class fr.sii.ogham.email.message.Email

equals(Object) - Method in class fr.sii.ogham.email.message.EmailAddress

equals(Object) - Method in class fr.sii.ogham.email.message.Recipient

equals(Object) - Method in class fr.sii.ogham.helper.sms.ExpectedAddressedPhoneNumber

equals(Object) - Method in class fr.sii.ogham.mock.context.NestedBean

equals(Object) - Method in class fr.sii.ogham.mock.context.SimpleBean

equals(Object) - Method in class fr.sii.ogham.sms.message.addressing.AddressedPhoneNumber

equals(Object) - Method in class fr.sii.ogham.sms.message.Contact

equals(Object) - Method in class fr.sii.ogham.sms.message.PhoneNumber

equals(Object) - Method in class fr.sii.ogham.sms.message.Sms

EqualsBuilder - Class in fr.sii.ogham.core.util

Assists in implementing Object.equals(Object) methods.

EqualsBuilder() - Constructor for class fr.sii.ogham.core.util.EqualsBuilder

Initialize the builder.

EqualsBuilder(Object, Object) - Constructor for class fr.sii.ogham.core.util.EqualsBuilder

Initialize the builder.

EveryContentTranslator - Class in fr.sii.ogham.core.translator.content

Decorator that loop through all delegate translators to transform the content of the message.

EveryContentTranslator(ContentTranslator...) - Constructor for class fr.sii.ogham.core.translator.content.EveryContentTranslator

Initialize the decorator with none, one or several translator implementations.

EveryContentTranslator(List<ContentTranslator>) - Constructor for class fr.sii.ogham.core.translator.content.EveryContentTranslator

Initialize the decorator with the provided translator implementations.

EveryFillerDecorator - Class in fr.sii.ogham.core.filler

Decorator that calls every decorated filler in order to fill the message.

EveryFillerDecorator(MessageFiller...) - Constructor for class fr.sii.ogham.core.filler.EveryFillerDecorator

EveryFillerDecorator(List<MessageFiller>) - Constructor for class fr.sii.ogham.core.filler.EveryFillerDecorator

EveryImageInliner - Class in fr.sii.ogham.html.inliner

Applies in sequence all provided decorated inliners.

EveryImageInliner(ImageInliner...) - Constructor for class fr.sii.ogham.html.inliner.EveryImageInliner

EveryImageInliner(List<ImageInliner>) - Constructor for class fr.sii.ogham.html.inliner.EveryImageInliner

EveryResourceTranslator - Class in fr.sii.ogham.core.translator.resource

Decorator that loop through all delegate translators to transform the attachment resource of the message.

EveryResourceTranslator(AttachmentResourceTranslator...) - Constructor for class fr.sii.ogham.core.translator.resource.EveryResourceTranslator

Initialize the decorator with none, one or several translator implementations.

EveryResourceTranslator(List<AttachmentResourceTranslator>) - Constructor for class fr.sii.ogham.core.translator.resource.EveryResourceTranslator

Initialize the decorator with the provided translator implementations.

EverySupportingMessagingService - Class in fr.sii.ogham.core.service

Implementation that will ask each sender if it is able to handle the message.

EverySupportingMessagingService(ConditionalSender...) - Constructor for class fr.sii.ogham.core.service.EverySupportingMessagingService

Initialize the service with none, one or several sender implementations.

EverySupportingMessagingService(List<ConditionalSender>) - Constructor for class fr.sii.ogham.core.service.EverySupportingMessagingService

Initialize the service with the provided sender implementations.

exists(String) - Static method in class fr.sii.ogham.core.util.ClasspathHelper

Test if the class name is defined in the classpath.

ExpandCssPropertiesTranslator - Class in fr.sii.ogham.html.translator

Automatically transform CSS shortcuts to the expanded version.

ExpandCssPropertiesTranslator() - Constructor for class fr.sii.ogham.html.translator.ExpandCssPropertiesTranslator

ExpectedAddressedPhoneNumber - Class in fr.sii.ogham.helper.sms

ExpectedAddressedPhoneNumber(String, byte, byte) - Constructor for class fr.sii.ogham.helper.sms.ExpectedAddressedPhoneNumber

Initializes the phone number with the given number, TON and NPI.

ExpectedAttachment - Class in fr.sii.ogham.helper.email

Class used in tests for ensuring that the attachment is respected.

ExpectedAttachment(String, Pattern, byte[], String, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, Pattern, byte[], String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, Pattern, byte[]) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, Pattern, InputStream, String, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, Pattern, InputStream, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, Pattern, InputStream) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, Pattern, String, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, Pattern, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, Pattern) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, String, byte[], String, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, String, byte[], String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, String, byte[]) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, String, InputStream, String, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, String, InputStream, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, String, InputStream) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, String, String, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, String, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedAttachment(String, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedAttachment

ExpectedContent - Class in fr.sii.ogham.helper.email

Class used in tests for ensuring that the content of an email is respected.

ExpectedContent(String, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedContent

Initialize with the expected body and the expected Mime Type (regular expression).

ExpectedContent(String, Pattern) - Constructor for class fr.sii.ogham.helper.email.ExpectedContent

Initialize with the expected body and the expected Mime Type pattern.

ExpectedContent(InputStream, String) - Constructor for class fr.sii.ogham.helper.email.ExpectedContent

Initialize with the expected body and the expected Mime Type pattern.

ExpectedEmail - Class in fr.sii.ogham.helper.email

Class used in tests for ensuring that the email is respected.

ExpectedEmail(String, String, String, String...) - Constructor for class fr.sii.ogham.helper.email.ExpectedEmail

Initialize the expected email with string values.

ExpectedEmail(String, ExpectedContent, String, String...) - Constructor for class fr.sii.ogham.helper.email.ExpectedEmail

Initialize the expected email with provided values.

ExpectedEmailHeader - Class in fr.sii.ogham.helper.email

Class used in tests for ensuring that the email is respected.

ExpectedEmailHeader(String, String, String...) - Constructor for class fr.sii.ogham.helper.email.ExpectedEmailHeader

ExpectedEmailHeader(String, String, List<String>) - Constructor for class fr.sii.ogham.helper.email.ExpectedEmailHeader

ExpectedMultiPartEmail - Class in fr.sii.ogham.helper.email

Class used in tests for ensuring that the email is respected.

ExpectedMultiPartEmail(String, ExpectedContent[], String, String...) - Constructor for class fr.sii.ogham.helper.email.ExpectedMultiPartEmail

Initialize the expected email with provided values.

ExpectedSms - Class in fr.sii.ogham.helper.sms

Class used in tests for ensuring that the SMS is respected.

ExpectedSms(String, ExpectedAddressedPhoneNumber, ExpectedAddressedPhoneNumber) - Constructor for class fr.sii.ogham.helper.sms.ExpectedSms

Initialize the expected SMS with the message, the sender phone number and the receiver phone number.

ExtensionMappingVariantResolver - Class in fr.sii.ogham.template.common.adapter

Simple implementation that maps a variant instance to an extension.

ExtensionMappingVariantResolver() - Constructor for class fr.sii.ogham.template.common.adapter.ExtensionMappingVariantResolver

ExtensionMappingVariantResolver(Map<Variant, String>) - Constructor for class fr.sii.ogham.template.common.adapter.ExtensionMappingVariantResolver

ExternalCss - Class in fr.sii.ogham.html.inliner

ExternalCss(String, String) - Constructor for class fr.sii.ogham.html.inliner.ExternalCss

F

FailIfNotFoundVariantResolver - Class in fr.sii.ogham.template.common.adapter

FailIfNotFoundVariantResolver() - Constructor for class fr.sii.ogham.template.common.adapter.FailIfNotFoundVariantResolver

failOnMissingVariant(boolean) - Method in class fr.sii.ogham.core.builder.ContentTranslatorBuilder

When content is a MultiTemplateContent, you can provide several files with extension or only the file name without extension and variants (html or text) will be automatically detected.

FallbackMimeTypeProvider - Class in fr.sii.ogham.core.mimetype

Implementation that will try several delegate implementations until one is able to provide the Mime Type.

FallbackMimeTypeProvider(MimeTypeProvider...) - Constructor for class fr.sii.ogham.core.mimetype.FallbackMimeTypeProvider

FallbackMimeTypeProvider(List<MimeTypeProvider>) - Constructor for class fr.sii.ogham.core.mimetype.FallbackMimeTypeProvider

FallbackSender - Class in fr.sii.ogham.core.sender

Decorator implementation that will try to send the message until one decorated sender is able to send it.

FallbackSender(MessageSender...) - Constructor for class fr.sii.ogham.core.sender.FallbackSender

Initialize either none, one or several senders to try one by one until one succeeds.

FallbackSender(List<MessageSender>) - Constructor for class fr.sii.ogham.core.sender.FallbackSender

Initialize with the provided list of senders to try one by one until one succeeds.

FieldAccessException - Exception in fr.sii.ogham.core.exception.util

FieldAccessException(String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.util.FieldAccessException

FieldAccessException(String) - Constructor for exception fr.sii.ogham.core.exception.util.FieldAccessException

FieldAccessException(Throwable) - Constructor for exception fr.sii.ogham.core.exception.util.FieldAccessException

FileResolver - Class in fr.sii.ogham.core.resource.resolver

Resource resolver that searches for the resource on the file system.

FileResolver(String...) - Constructor for class fr.sii.ogham.core.resource.resolver.FileResolver

FileResolverAdapter - Class in fr.sii.ogham.template.freemarker.adapter

Adapter that converts general FileResolver into FreeMarker specific FileTemplateLoader.

FileResolverAdapter() - Constructor for class fr.sii.ogham.template.freemarker.adapter.FileResolverAdapter

FileResolverAdapter - Class in fr.sii.ogham.template.thymeleaf.adapter

Adapter that converts general FileResolver into Thymeleaf specific FileTemplateResolver.

FileResolverAdapter() - Constructor for class fr.sii.ogham.template.thymeleaf.adapter.FileResolverAdapter

FileResource - Class in fr.sii.ogham.core.resource

Resource that provide access to a file.

FileResource(File, String) - Constructor for class fr.sii.ogham.core.resource.FileResource

Initialize the resource with the provided file and name.

FileResource(File) - Constructor for class fr.sii.ogham.core.resource.FileResource

Initialize the resource with the provided file.

FileResource(String) - Constructor for class fr.sii.ogham.core.resource.FileResource

Initialize the resource with the provided file.

FileResourceHandler - Class in fr.sii.ogham.email.sender.impl.javamail

FileResourceHandler(MimeTypeProvider) - Constructor for class fr.sii.ogham.email.sender.impl.javamail.FileResourceHandler

fill(Message) - Method in class fr.sii.ogham.core.filler.EveryFillerDecorator

fill(Message) - Method in interface fr.sii.ogham.core.filler.MessageFiller

Add extra information on the message.

fill(Message) - Method in class fr.sii.ogham.core.filler.SimpleFiller

fill(Message) - Method in class fr.sii.ogham.core.filler.SubjectFiller

FILL_PREFIXES - Static variable in class fr.sii.ogham.email.EmailConstants

The prefix for filling email using properties

FILL_PREFIXES - Static variable in class fr.sii.ogham.sms.SmsConstants

The prefix for filling SMS using properties

FillerSender - Class in fr.sii.ogham.core.sender

Decorator sender that adds extra information to the message.

FillerSender(MessageFiller, MessageSender) - Constructor for class fr.sii.ogham.core.sender.FillerSender

Initialize the sender with the filler instance and the decorated sender.

FillMessageException - Exception in fr.sii.ogham.core.exception.filler

FillMessageException(String, Message, Throwable) - Constructor for exception fr.sii.ogham.core.exception.filler.FillMessageException

FillMessageException(String, Message) - Constructor for exception fr.sii.ogham.core.exception.filler.FillMessageException

FillMessageException(Throwable, Message) - Constructor for exception fr.sii.ogham.core.exception.filler.FillMessageException

findTemplateSource(String) - Method in class fr.sii.ogham.template.freemarker.FreeMarkerFirstSupportingTemplateLoader

FirstExistingResourceVariantResolver - Class in fr.sii.ogham.template.common.adapter

Try every possible path for the variant until one path points to an existing resource.

FirstExistingResourceVariantResolver(ResourceResolver, VariantResolver, VariantResolver...) - Constructor for class fr.sii.ogham.template.common.adapter.FirstExistingResourceVariantResolver

FirstExistingResourceVariantResolver(ResourceResolver, VariantResolver, List<VariantResolver>) - Constructor for class fr.sii.ogham.template.common.adapter.FirstExistingResourceVariantResolver

FirstSupportingResolverAdapter - Class in fr.sii.ogham.template.freemarker.adapter

Decorator that will ask each resolver adapter if it is able to handle the template resolver.

FirstSupportingResolverAdapter(TemplateLoaderAdapter...) - Constructor for class fr.sii.ogham.template.freemarker.adapter.FirstSupportingResolverAdapter

Initialize the decorator with none, one or several resolver adapter implementations.

FirstSupportingResolverAdapter(List<TemplateLoaderAdapter>) - Constructor for class fr.sii.ogham.template.freemarker.adapter.FirstSupportingResolverAdapter

Initialize the decorator with the provided resolver adapter implementations.

FirstSupportingResolverAdapter() - Constructor for class fr.sii.ogham.template.freemarker.adapter.FirstSupportingResolverAdapter

FirstSupportingResolverAdapter - Class in fr.sii.ogham.template.thymeleaf.adapter

Decorator that will ask each resolver adapter if it is able to handle the template resolver.

FirstSupportingResolverAdapter(TemplateResolverAdapter...) - Constructor for class fr.sii.ogham.template.thymeleaf.adapter.FirstSupportingResolverAdapter

Initialize the decorator with none, one or several resolver adapter implementations.

FirstSupportingResolverAdapter(List<TemplateResolverAdapter>) - Constructor for class fr.sii.ogham.template.thymeleaf.adapter.FirstSupportingResolverAdapter

Initialize the decorator with the provided resolver adapter implementations.

FirstSupportingResolverAdapter() - Constructor for class fr.sii.ogham.template.thymeleaf.adapter.FirstSupportingResolverAdapter

FirstSupportingResourceResolver - Class in fr.sii.ogham.core.resource.resolver

Decorator that will ask each resource resolver if it is able to handle the lookup.

FirstSupportingResourceResolver(List<ResourceResolver>) - Constructor for class fr.sii.ogham.core.resource.resolver.FirstSupportingResourceResolver

Initialize the decorator with the provided resource resolver implementations.

FirstSupportingResourceResolverBuilder - Class in fr.sii.ogham.core.builder

Builder used to help construct the resource resolution.

FirstSupportingResourceResolverBuilder() - Constructor for class fr.sii.ogham.core.builder.FirstSupportingResourceResolverBuilder

FirstSupportingSubjectProvider - Class in fr.sii.ogham.core.subject.provider

Apply every SubjectProvider in order until one subject can be generated.

FirstSupportingSubjectProvider(SubjectProvider...) - Constructor for class fr.sii.ogham.core.subject.provider.FirstSupportingSubjectProvider

FirstSupportingSubjectProvider(List<SubjectProvider>) - Constructor for class fr.sii.ogham.core.subject.provider.FirstSupportingSubjectProvider

FixClassLoaderTemplateResolver - Class in fr.sii.ogham.template.thymeleaf.resolver

Classpath URL can start with "/" but Thymeleaf implementation can't handle the URLs starting with "/".

FixClassLoaderTemplateResolver() - Constructor for class fr.sii.ogham.template.thymeleaf.resolver.FixClassLoaderTemplateResolver

FixedCharsetProvider - Class in fr.sii.ogham.core.charset

Provider that always gives the same charset.

FixedCharsetProvider() - Constructor for class fr.sii.ogham.core.charset.FixedCharsetProvider

Initialize the provider with the default charset (UTF-8)

FixedCharsetProvider(Charset) - Constructor for class fr.sii.ogham.core.charset.FixedCharsetProvider

Initialize the provider with the given charset.

FixedCondition<T> - Class in fr.sii.ogham.core.condition

Basic condition that always give the same result: the result you provided at construction.

FixedCondition(boolean) - Constructor for class fr.sii.ogham.core.condition.FixedCondition

FixedEngineDetector - Class in fr.sii.ogham.core.template.detector

Most basic detector that always provide the same detection value.

FixedEngineDetector() - Constructor for class fr.sii.ogham.core.template.detector.FixedEngineDetector

Initialize the detector to always say yes to any template.

FixedEngineDetector(boolean) - Constructor for class fr.sii.ogham.core.template.detector.FixedEngineDetector

Initialize the detector to always say yes or no to any template.

FixedMimeTypeProvider - Class in fr.sii.ogham.core.mimetype

This mime type provider always return a fixed Mime Type.

FixedMimeTypeProvider() - Constructor for class fr.sii.ogham.core.mimetype.FixedMimeTypeProvider

Initialize the provider with text/plain Mime Type

FixedMimeTypeProvider(String) - Constructor for class fr.sii.ogham.core.mimetype.FixedMimeTypeProvider

Constructor that uses the provided Mime Type.

FixedMimeTypeProvider(MimeType) - Constructor for class fr.sii.ogham.core.mimetype.FixedMimeTypeProvider

Constructor that uses the provided Mime Type.

FixedPhoneNumberTranslator - Class in fr.sii.ogham.sms.message.addressing.translator

Addressing default strategy : TON and NPI will be fixed by the translator

FixedPhoneNumberTranslator(TypeOfNumber, NumberingPlanIndicator) - Constructor for class fr.sii.ogham.sms.message.addressing.translator.FixedPhoneNumberTranslator

Initializes the translator with the given number, TON and NPI.

fr.sii.ogham.core.builder - package fr.sii.ogham.core.builder

fr.sii.ogham.core.charset - package fr.sii.ogham.core.charset

fr.sii.ogham.core.condition - package fr.sii.ogham.core.condition

fr.sii.ogham.core.exception - package fr.sii.ogham.core.exception

fr.sii.ogham.core.exception.builder - package fr.sii.ogham.core.exception.builder

fr.sii.ogham.core.exception.filler - package fr.sii.ogham.core.exception.filler

fr.sii.ogham.core.exception.handler - package fr.sii.ogham.core.exception.handler

fr.sii.ogham.core.exception.mimetype - package fr.sii.ogham.core.exception.mimetype

fr.sii.ogham.core.exception.resource - package fr.sii.ogham.core.exception.resource

fr.sii.ogham.core.exception.template - package fr.sii.ogham.core.exception.template

fr.sii.ogham.core.exception.util - package fr.sii.ogham.core.exception.util

fr.sii.ogham.core.filler - package fr.sii.ogham.core.filler

fr.sii.ogham.core.id.generator - package fr.sii.ogham.core.id.generator

fr.sii.ogham.core.message - package fr.sii.ogham.core.message

fr.sii.ogham.core.message.capability - package fr.sii.ogham.core.message.capability

fr.sii.ogham.core.message.content - package fr.sii.ogham.core.message.content

fr.sii.ogham.core.message.recipient - package fr.sii.ogham.core.message.recipient

fr.sii.ogham.core.mimetype - package fr.sii.ogham.core.mimetype

fr.sii.ogham.core.resource - package fr.sii.ogham.core.resource

fr.sii.ogham.core.resource.resolver - package fr.sii.ogham.core.resource.resolver

fr.sii.ogham.core.sender - package fr.sii.ogham.core.sender

fr.sii.ogham.core.service - package fr.sii.ogham.core.service

fr.sii.ogham.core.subject.provider - package fr.sii.ogham.core.subject.provider

fr.sii.ogham.core.template.context - package fr.sii.ogham.core.template.context

fr.sii.ogham.core.template.detector - package fr.sii.ogham.core.template.detector

fr.sii.ogham.core.template.parser - package fr.sii.ogham.core.template.parser

fr.sii.ogham.core.translator.content - package fr.sii.ogham.core.translator.content

fr.sii.ogham.core.translator.resource - package fr.sii.ogham.core.translator.resource

fr.sii.ogham.core.util - package fr.sii.ogham.core.util

fr.sii.ogham.core.util.converter - package fr.sii.ogham.core.util.converter

fr.sii.ogham.core.util.http - package fr.sii.ogham.core.util.http

fr.sii.ogham.email - package fr.sii.ogham.email

fr.sii.ogham.email.attachment - package fr.sii.ogham.email.attachment

fr.sii.ogham.email.builder - package fr.sii.ogham.email.builder

fr.sii.ogham.email.exception.attachment.translator - package fr.sii.ogham.email.exception.attachment.translator

fr.sii.ogham.email.exception.javamail - package fr.sii.ogham.email.exception.javamail

fr.sii.ogham.email.exception.sendgrid - package fr.sii.ogham.email.exception.sendgrid

fr.sii.ogham.email.message - package fr.sii.ogham.email.message

fr.sii.ogham.email.message.content - package fr.sii.ogham.email.message.content

fr.sii.ogham.email.sender - package fr.sii.ogham.email.sender

fr.sii.ogham.email.sender.impl - package fr.sii.ogham.email.sender.impl

fr.sii.ogham.email.sender.impl.javamail - package fr.sii.ogham.email.sender.impl.javamail

fr.sii.ogham.email.sender.impl.sendgrid.client - package fr.sii.ogham.email.sender.impl.sendgrid.client

fr.sii.ogham.email.sender.impl.sendgrid.handler - package fr.sii.ogham.email.sender.impl.sendgrid.handler

fr.sii.ogham.helper.email - package fr.sii.ogham.helper.email

fr.sii.ogham.helper.exception - package fr.sii.ogham.helper.exception

fr.sii.ogham.helper.html - package fr.sii.ogham.helper.html

fr.sii.ogham.helper.rule - package fr.sii.ogham.helper.rule

fr.sii.ogham.helper.sms - package fr.sii.ogham.helper.sms

fr.sii.ogham.helper.sms.cloudhopper - package fr.sii.ogham.helper.sms.cloudhopper

fr.sii.ogham.helper.sms.jsmpp - package fr.sii.ogham.helper.sms.jsmpp

fr.sii.ogham.helper.sms.rule - package fr.sii.ogham.helper.sms.rule

fr.sii.ogham.helper.template - package fr.sii.ogham.helper.template

fr.sii.ogham.html.inliner - package fr.sii.ogham.html.inliner

fr.sii.ogham.html.inliner.impl.jsoup - package fr.sii.ogham.html.inliner.impl.jsoup

fr.sii.ogham.html.translator - package fr.sii.ogham.html.translator

fr.sii.ogham.i18n - package fr.sii.ogham.i18n

fr.sii.ogham.mock.context - package fr.sii.ogham.mock.context

fr.sii.ogham.sms - package fr.sii.ogham.sms

fr.sii.ogham.sms.builder - package fr.sii.ogham.sms.builder

fr.sii.ogham.sms.exception.message - package fr.sii.ogham.sms.exception.message

fr.sii.ogham.sms.message - package fr.sii.ogham.sms.message

fr.sii.ogham.sms.message.addressing - package fr.sii.ogham.sms.message.addressing

fr.sii.ogham.sms.message.addressing.translator - package fr.sii.ogham.sms.message.addressing.translator

fr.sii.ogham.sms.sender - package fr.sii.ogham.sms.sender

fr.sii.ogham.sms.sender.impl - package fr.sii.ogham.sms.sender.impl

fr.sii.ogham.sms.sender.impl.cloudhopper - package fr.sii.ogham.sms.sender.impl.cloudhopper

fr.sii.ogham.sms.sender.impl.ovh - package fr.sii.ogham.sms.sender.impl.ovh

fr.sii.ogham.spring.autoconfigure - package fr.sii.ogham.spring.autoconfigure

fr.sii.ogham.spring.config - package fr.sii.ogham.spring.config

fr.sii.ogham.spring.xml - package fr.sii.ogham.spring.xml

fr.sii.ogham.template - package fr.sii.ogham.template

fr.sii.ogham.template.common.adapter - package fr.sii.ogham.template.common.adapter

fr.sii.ogham.template.exception - package fr.sii.ogham.template.exception

fr.sii.ogham.template.freemarker - package fr.sii.ogham.template.freemarker

fr.sii.ogham.template.freemarker.adapter - package fr.sii.ogham.template.freemarker.adapter

fr.sii.ogham.template.freemarker.builder - package fr.sii.ogham.template.freemarker.builder

fr.sii.ogham.template.thymeleaf - package fr.sii.ogham.template.thymeleaf

fr.sii.ogham.template.thymeleaf.adapter - package fr.sii.ogham.template.thymeleaf.adapter

fr.sii.ogham.template.thymeleaf.builder - package fr.sii.ogham.template.thymeleaf.builder

fr.sii.ogham.template.thymeleaf.resolver - package fr.sii.ogham.template.thymeleaf.resolver

freemarkerConfigurer(Configuration) - Method in class fr.sii.ogham.spring.autoconfigure.OghamAutoConfiguration.OghamFreemarkerConfiguration

FreeMarkerConfigurer - Class in fr.sii.ogham.spring.config

FreeMarkerConfigurer(Configuration) - Constructor for class fr.sii.ogham.spring.config.FreeMarkerConfigurer

FreeMarkerFirstSupportingTemplateLoader - Class in fr.sii.ogham.template.freemarker

Decorator resolver that is able to manage ResourcePath.

FreeMarkerFirstSupportingTemplateLoader(FirstSupportingResourceResolver, FirstSupportingResolverAdapter) - Constructor for class fr.sii.ogham.template.freemarker.FreeMarkerFirstSupportingTemplateLoader

FreeMarkerParser - Class in fr.sii.ogham.template.freemarker

Implementation for FreeMarker template engine.

FreeMarkerParser(Configuration) - Constructor for class fr.sii.ogham.template.freemarker.FreeMarkerParser

FreeMarkerTemplateDetector - Class in fr.sii.ogham.template.freemarker

Detector checking template name extension.

FreeMarkerTemplateDetector() - Constructor for class fr.sii.ogham.template.freemarker.FreeMarkerTemplateDetector

FreeMarkerTemplateDetector(String...) - Constructor for class fr.sii.ogham.template.freemarker.FreeMarkerTemplateDetector

FreeMarkerTemplateParserBuilder - Class in fr.sii.ogham.template.freemarker.builder

Specialized builder for FreeMarker template engine.

FreeMarkerTemplateParserBuilder() - Constructor for class fr.sii.ogham.template.freemarker.builder.FreeMarkerTemplateParserBuilder

from(EmailAddress) - Method in class fr.sii.ogham.email.message.Email

Set the sender address.

from(String) - Method in class fr.sii.ogham.email.message.Email

Set the sender address as string (typical address syntax is of the form "user@host.domain" or "Personal Name <user@host.domain>").

from - Variable in class fr.sii.ogham.helper.email.ExpectedEmailHeader

The expected sender address

from(Sender) - Method in class fr.sii.ogham.sms.message.Sms

Set the sender.

from(String) - Method in class fr.sii.ogham.sms.message.Sms

Set the sender using the phone number as string.

from(PhoneNumber) - Method in class fr.sii.ogham.sms.message.Sms

Set the sender using the phone number.

from(String, String) - Method in class fr.sii.ogham.sms.message.Sms

Set the sender using the phone number as string.

from(String, PhoneNumber) - Method in class fr.sii.ogham.sms.message.Sms

Set the sender using the phone number.

G

generate(String) - Method in interface fr.sii.ogham.core.id.generator.IdGenerator

generate(String) - Method in class fr.sii.ogham.core.id.generator.SequentialIdGenerator

generate(String) - Method in class fr.sii.ogham.core.id.generator.UUIDGenerator

generateOptionsFrom(Properties) - Method in class fr.sii.ogham.sms.builder.CloudhopperSMPPBuilder

Generate additional options from properties.

generateSmppSessionConfigurationFrom(Properties) - Method in class fr.sii.ogham.sms.builder.CloudhopperSMPPBuilder

Generate configuration for SMPP session from properties.

get(String, List<Parameter>) - Static method in class fr.sii.ogham.core.util.HttpUtils

Do a GET request on the provided URL and construct the Query String part with the provided list of parameters.

get(String, Parameter...) - Static method in class fr.sii.ogham.core.util.HttpUtils

Do a GET request on the provided URL and construct the Query String part with the provided list of parameters.

get(String, Object...) - Static method in class fr.sii.ogham.core.util.HttpUtils

Do a GET request on the provided URL and construct the Query String part with the provided list of parameters.

get(String, Map<String, Object>) - Static method in class fr.sii.ogham.core.util.HttpUtils

Do a GET request on the provided URL and construct the Query String part with the provided list of parameters.

getAccount() - Method in class fr.sii.ogham.sms.sender.impl.ovh.OvhAuthParams

getActualResourceResolver() - Method in class fr.sii.ogham.core.resource.resolver.DefaultResourceResolver

getActualResourceResolver() - Method in interface fr.sii.ogham.core.resource.resolver.DelegateResourceResolver

Finds the final delegated ResourceResolver by any level of delegation.

getActualResourceResolver() - Method in class fr.sii.ogham.core.resource.resolver.RelativeResolver

getAdapters() - Method in class fr.sii.ogham.template.freemarker.adapter.FirstSupportingResolverAdapter

getAdapters() - Method in class fr.sii.ogham.template.thymeleaf.adapter.FirstSupportingResolverAdapter

getAddress() - Method in class fr.sii.ogham.email.message.EmailAddress

getAddress() - Method in class fr.sii.ogham.email.message.Recipient

getAttachment() - Method in exception fr.sii.ogham.email.exception.javamail.AttachmentResourceHandlerException

getAttachments() - Method in class fr.sii.ogham.email.message.content.ContentWithAttachments

getAttachments() - Method in class fr.sii.ogham.email.message.Email

Get the list of attachments.

getAttachments() - Method in class fr.sii.ogham.html.inliner.ContentWithImages

getBcc() - Method in class fr.sii.ogham.helper.email.ExpectedEmailHeader

getBean() - Method in exception fr.sii.ogham.core.exception.template.BeanContextException

getBean() - Method in exception fr.sii.ogham.core.exception.template.BeanException

getBody() - Method in class fr.sii.ogham.core.util.http.Response

getBody() - Method in class fr.sii.ogham.helper.email.ExpectedContent

getBytes() - Method in class fr.sii.ogham.core.resource.ByteResource

getCc() - Method in class fr.sii.ogham.helper.email.ExpectedEmailHeader

getCharset(String) - Method in interface fr.sii.ogham.core.charset.CharsetProvider

Provide the charset for the input string.

getCharset(String) - Method in class fr.sii.ogham.core.charset.FixedCharsetProvider

getCharset() - Method in class fr.sii.ogham.core.charset.FixedCharsetProvider

getCode() - Method in enum fr.sii.ogham.core.util.http.HttpStatus

getConditions() - Method in class fr.sii.ogham.core.condition.CompositeCondition

getConfiguration() - Method in class fr.sii.ogham.template.freemarker.builder.FreeMarkerTemplateParserBuilder

Give access to the FreeMarker configuration in order to be able to customize it.

getContent() - Method in interface fr.sii.ogham.core.message.content.DecoratorContent

Get the decorated content

getContent() - Method in class fr.sii.ogham.core.message.content.StringContent

Get the content as string.

getContent() - Method in interface fr.sii.ogham.core.message.Message

Get the content of the message.

getContent() - Method in exception fr.sii.ogham.email.exception.javamail.ContentHandlerException

getContent() - Method in class fr.sii.ogham.email.message.content.ContentWithAttachments

getContent() - Method in class fr.sii.ogham.email.message.Email

getContent() - Method in class fr.sii.ogham.helper.email.ExpectedAttachment

getContent() - Method in class fr.sii.ogham.html.inliner.ContentWithImages

getContent() - Method in class fr.sii.ogham.html.inliner.ExternalCss

getContent() - Method in class fr.sii.ogham.html.inliner.ImageResource

getContent() - Method in class fr.sii.ogham.sms.message.Sms

getContentId() - Method in class fr.sii.ogham.email.attachment.Attachment

getContents() - Method in class fr.sii.ogham.core.message.content.MultiContent

getContentTranslatorBuilder() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Get the builder used transform the content of the message.

getContentTranslatorBuilder() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Get the builder used transform the content of the message.

getContext() - Method in exception fr.sii.ogham.core.exception.template.ParseException

getContext() - Method in class fr.sii.ogham.core.message.content.TemplateContent

getDate() - Method in class fr.sii.ogham.mock.context.SimpleBean

getDefaultProperties() - Static method in class fr.sii.ogham.core.util.BuilderUtils

Provide the default properties.

getDefaultType() - Method in class fr.sii.ogham.core.util.converter.EmailAddressConverter

getDefaultType() - Method in class fr.sii.ogham.core.util.converter.SmsSenderConverter

getDelegate() - Method in class fr.sii.ogham.core.template.context.LocaleContext

getDescription() - Method in class fr.sii.ogham.email.attachment.Attachment

getDescription() - Method in class fr.sii.ogham.helper.email.ExpectedAttachment

getDetectors() - Method in class fr.sii.ogham.core.template.detector.CompositeTemplateDetector

getDisposition() - Method in class fr.sii.ogham.email.attachment.Attachment

getDisposition() - Method in class fr.sii.ogham.helper.email.ExpectedAttachment

getDistinctCssUrls(String) - Static method in class fr.sii.ogham.core.util.HtmlUtils

Finds all CSS file inclusions (looks for link tags for stylesheet files).

getDistinctImageUrls(String) - Static method in class fr.sii.ogham.core.util.HtmlUtils

Finds all image inclusions (looks for img tags).

getEmailBuilder() - Method in class fr.sii.ogham.core.builder.MessagingBuilder

Get access to the email specialized builder.

getEngine() - Method in class fr.sii.ogham.template.thymeleaf.builder.ThymeleafTemplateParserBuilder

Give access to the Thymeleaf template engine in order to be able to customize it.

getExpectedContent() - Method in class fr.sii.ogham.helper.email.ExpectedEmail

getExpectedContents() - Method in class fr.sii.ogham.helper.email.ExpectedMultiPartEmail

getExtension() - Method in class fr.sii.ogham.core.resource.resolver.RelativeResolver

getFile() - Method in class fr.sii.ogham.core.resource.FileResource

getFreeMarkerParser() - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Get the reference to the specialized builder for Thymeleaf.

getFrom() - Method in class fr.sii.ogham.email.message.Email

Get the sender address

getFrom() - Method in class fr.sii.ogham.helper.email.ExpectedEmailHeader

getFrom() - Method in class fr.sii.ogham.sms.message.Sms

Get the sender of the SMS

getImplementationBuilder(Class<B>) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Get reference to the specialized builder.

getImplementations() - Method in class fr.sii.ogham.core.sender.MultiImplementationSender

getInputStream() - Method in class fr.sii.ogham.core.resource.ByteResource

getInputStream() - Method in class fr.sii.ogham.core.resource.FileResource

getInputStream() - Method in class fr.sii.ogham.core.resource.LookupResource

getInputStream() - Method in interface fr.sii.ogham.core.resource.Resource

Stream that contains the template content.

getInputStream() - Method in class fr.sii.ogham.core.resource.SimpleResource

getJavaMailBuilder() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Get the reference to the specialized builder for Java Mail API.

getLastModified(Object) - Method in class fr.sii.ogham.template.freemarker.FreeMarkerFirstSupportingTemplateLoader

getLocale() - Method in class fr.sii.ogham.core.template.context.LocaleContext

getLogin() - Method in class fr.sii.ogham.sms.sender.impl.ovh.OvhAuthParams

getLookup(String) - Method in class fr.sii.ogham.core.resource.resolver.AbstractPrefixedLookupPathResolver

getMessage() - Method in class fr.sii.ogham.helper.sms.ExpectedSms

getMessageFillerBuilder() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Get the builder used for filling messages.

getMessageFillerBuilder() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Get the builder used for filling messages.

getMimeType(File) - Method in class fr.sii.ogham.core.mimetype.FallbackMimeTypeProvider

getMimeType(String) - Method in class fr.sii.ogham.core.mimetype.FallbackMimeTypeProvider

getMimeType(File) - Method in class fr.sii.ogham.core.mimetype.FixedMimeTypeProvider

getMimeType(String) - Method in class fr.sii.ogham.core.mimetype.FixedMimeTypeProvider

getMimeType(File) - Method in class fr.sii.ogham.core.mimetype.JavaActivationProvider

getMimeType(String) - Method in class fr.sii.ogham.core.mimetype.JavaActivationProvider

getMimeType(File) - Method in class fr.sii.ogham.core.mimetype.JavaFilesProvider

getMimeType(String) - Method in class fr.sii.ogham.core.mimetype.JavaFilesProvider

getMimeType(File) - Method in interface fr.sii.ogham.core.mimetype.MimeTypeProvider

Get the Mime Type based on the file.

getMimeType(String) - Method in interface fr.sii.ogham.core.mimetype.MimeTypeProvider

Get the Mime Type based on the file.

getMimeType(File) - Method in class fr.sii.ogham.core.mimetype.TikaProvider

getMimeType(String) - Method in class fr.sii.ogham.core.mimetype.TikaProvider

getMimetype() - Method in class fr.sii.ogham.helper.email.ExpectedAttachment

getMimetype() - Method in class fr.sii.ogham.helper.email.ExpectedContent

getMimetype() - Method in class fr.sii.ogham.html.inliner.ImageResource

getName() - Method in class fr.sii.ogham.core.resource.ByteResource

getName() - Method in class fr.sii.ogham.core.resource.FileResource

getName() - Method in class fr.sii.ogham.core.resource.LookupResource

getName() - Method in interface fr.sii.ogham.core.resource.NamedResource

Get the name for the resource.

getName() - Method in class fr.sii.ogham.core.util.http.Parameter

getName() - Method in class fr.sii.ogham.helper.email.ExpectedAttachment

getName() - Method in class fr.sii.ogham.html.inliner.ImageResource

getName() - Method in class fr.sii.ogham.mock.context.SimpleBean

getName() - Method in class fr.sii.ogham.sms.message.Contact

getName() - Method in class fr.sii.ogham.template.thymeleaf.resolver.StringResourceResolver

getName() - Method in class fr.sii.ogham.template.thymeleaf.ThymeLeafFirstSupportingTemplateResolver

getNested() - Method in class fr.sii.ogham.mock.context.NestedBean

getNoStop() - Method in class fr.sii.ogham.sms.sender.impl.ovh.OvhOptions

getNpi() - Method in class fr.sii.ogham.helper.sms.ExpectedAddressedPhoneNumber

getNpi() - Method in class fr.sii.ogham.sms.message.addressing.AddressedPhoneNumber

getNumber() - Method in class fr.sii.ogham.helper.sms.ExpectedAddressedPhoneNumber

getNumber() - Method in class fr.sii.ogham.sms.message.PhoneNumber

getOghamMessage() - Method in exception fr.sii.ogham.core.exception.MessageException

getOptions() - Method in class fr.sii.ogham.template.freemarker.adapter.AbstractFreeMarkerTemplateLoaderOptionsAdapter

getOptions() - Method in class fr.sii.ogham.template.thymeleaf.adapter.AbstractTemplateResolverOptionsAdapter

getOrder() - Method in class fr.sii.ogham.template.thymeleaf.ThymeLeafFirstSupportingTemplateResolver

getParentPath() - Method in class fr.sii.ogham.core.resource.resolver.RelativeResolver

getParserBuilder(Class<B>) - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Get reference to the specialized builder.

getParts() - Method in class fr.sii.ogham.helper.sms.SplitSms

Get the parts of the message.

getPassword() - Method in class fr.sii.ogham.helper.sms.cloudhopper.TestSmppServerHandler

getPassword() - Method in class fr.sii.ogham.sms.sender.impl.ovh.OvhAuthParams

getPasswordAuthentication() - Method in class fr.sii.ogham.email.sender.impl.javamail.UsernamePasswordAuthenticator

getPath() - Method in exception fr.sii.ogham.core.exception.resource.ResourceResolutionException

getPath() - Method in class fr.sii.ogham.core.message.content.TemplateContent

getPath() - Method in class fr.sii.ogham.core.resource.LookupResource

getPath() - Method in class fr.sii.ogham.core.resource.ResourcePath

getPath() - Method in class fr.sii.ogham.html.inliner.ExternalCss

getPath() - Method in class fr.sii.ogham.html.inliner.ImageResource

getPersonal() - Method in class fr.sii.ogham.email.message.EmailAddress

getPhoneNumber() - Method in class fr.sii.ogham.sms.message.Contact

getPort() - Method in class fr.sii.ogham.helper.sms.cloudhopper.CloudhopperSMPPServer

getPort() - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServer

getPort() - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

getPort() - Method in class fr.sii.ogham.helper.sms.rule.SmppServerRule

Get the port used by the server.

getPort() - Method in interface fr.sii.ogham.helper.sms.rule.SmppServerSimulator

getPrefix() - Method in class fr.sii.ogham.core.resource.ResourcePath

getReader(Object, String) - Method in class fr.sii.ogham.template.freemarker.FreeMarkerFirstSupportingTemplateLoader

getRealPath(TemplateContent) - Method in class fr.sii.ogham.template.common.adapter.ExtensionMappingVariantResolver

getRealPath(TemplateContent) - Method in class fr.sii.ogham.template.common.adapter.FailIfNotFoundVariantResolver

getRealPath(TemplateContent) - Method in class fr.sii.ogham.template.common.adapter.FirstExistingResourceVariantResolver

getRealPath(TemplateContent) - Method in class fr.sii.ogham.template.common.adapter.NullVariantResolver

getRealPath(TemplateContent) - Method in interface fr.sii.ogham.template.common.adapter.VariantResolver

Get the real path to the template path

getReason() - Method in enum fr.sii.ogham.core.util.http.HttpStatus

getReceivedMessages() - Method in class fr.sii.ogham.helper.sms.cloudhopper.CloudhopperSMPPServer

getReceivedMessages() - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServer

getReceivedMessages() - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

getReceivedMessages() - Method in class fr.sii.ogham.helper.sms.rule.SmppServerRule

Provide the list of received messages during the execution of the test.

getReceivedMessages() - Method in interface fr.sii.ogham.helper.sms.rule.SmppServerSimulator

getReceiverNumber() - Method in class fr.sii.ogham.helper.sms.ExpectedSms

getRecipientNumberTranslatorBuilder() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Get the builder for transformation of recipient phone numbers.

getRecipients() - Method in interface fr.sii.ogham.core.message.capability.HasRecipients

Get the list of recipients of the message.

getRecipients() - Method in class fr.sii.ogham.email.message.Email

Get the list of recipients of the mail.

getRecipients() - Method in class fr.sii.ogham.sms.message.Sms

Get the recipients (to) of the SMS

getResolvedPath() - Method in class fr.sii.ogham.core.resource.ResourcePath

getResolver() - Method in exception fr.sii.ogham.template.exception.ResolverAdapterException

getResolverBuilder() - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Get the builder used to handle resource resolution.

getResolverBuilder() - Method in class fr.sii.ogham.email.builder.AttachmentResourceTranslatorBuilder

Get the builder used to handle resource resolution.

getResolvers() - Method in class fr.sii.ogham.core.resource.resolver.FirstSupportingResourceResolver

getResource(ResourcePath) - Method in class fr.sii.ogham.core.resource.resolver.AbstractPrefixedLookupPathResolver

Find the resource using the resource path (or its name).

getResource(String) - Method in class fr.sii.ogham.core.resource.resolver.AbstractPrefixedLookupPathResolver

getResource(String) - Method in class fr.sii.ogham.core.resource.resolver.ClassPathResolver

getResource(ResourcePath) - Method in class fr.sii.ogham.core.resource.resolver.ClassPathResolver

getResource(String) - Method in class fr.sii.ogham.core.resource.resolver.DefaultResourceResolver

getResource(ResourcePath) - Method in class fr.sii.ogham.core.resource.resolver.FileResolver

getResource(String) - Method in class fr.sii.ogham.core.resource.resolver.FirstSupportingResourceResolver

getResource(String) - Method in class fr.sii.ogham.core.resource.resolver.RelativeResolver

getResource(String) - Method in interface fr.sii.ogham.core.resource.resolver.ResourceResolver

Find the resource using the resource path (or its name).

getResource(ResourcePath) - Method in class fr.sii.ogham.core.resource.resolver.StringResourceResolver

getResource() - Method in class fr.sii.ogham.email.attachment.Attachment

getResourceAsStream(TemplateProcessingParameters, String) - Method in class fr.sii.ogham.template.thymeleaf.resolver.StringResourceResolver

getResourcePath(String) - Method in class fr.sii.ogham.core.resource.resolver.AbstractPrefixedLookupPathResolver

getResourcePath(String) - Method in class fr.sii.ogham.core.resource.resolver.DefaultResourceResolver

getResourcePath(String) - Method in class fr.sii.ogham.core.resource.resolver.FirstSupportingResourceResolver

getResourcePath(String) - Method in class fr.sii.ogham.core.resource.resolver.RelativeResolver

getResourcePath(String) - Method in interface fr.sii.ogham.core.resource.resolver.ResourceResolver

Transforms a string path in a ResourcePath.

getResourceTranslatorBuilder() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Get the builder used to transform the resources associated to the message.

getResponseTimeout() - Method in class fr.sii.ogham.sms.sender.impl.cloudhopper.CloudhopperOptions

getSender() - Method in class fr.sii.ogham.core.sender.MultiImplementationSender

getSenderNumber() - Method in class fr.sii.ogham.helper.sms.ExpectedSms

getSenderNumberTranslatorBuilder() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Get the builder for transformation of sender phone numbers.

getSendGridBuilder() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Get the reference to the specialized builder for SendGrid.

getSessionHandler() - Method in class fr.sii.ogham.helper.sms.cloudhopper.TestSmppServerHandler

getSessions() - Method in class fr.sii.ogham.helper.sms.cloudhopper.TestSmppServerHandler

getSmsBuilder() - Method in class fr.sii.ogham.core.builder.MessagingBuilder

Get access to the SMS specialized builder.

getSmsCoding() - Method in class fr.sii.ogham.sms.sender.impl.ovh.OvhOptions

getStatus() - Method in class fr.sii.ogham.core.util.http.Response

getSubject() - Method in interface fr.sii.ogham.core.message.capability.HasSubject

Get the subject of the message.

getSubject() - Method in class fr.sii.ogham.email.message.Email

Get the subject of the mail.

getSubject() - Method in class fr.sii.ogham.helper.email.ExpectedEmailHeader

getSupportingResolver(String) - Method in class fr.sii.ogham.core.resource.resolver.FirstSupportingResourceResolver

Find the first supporting resolver.

getSystemId() - Method in class fr.sii.ogham.helper.sms.cloudhopper.TestSmppServerHandler

getTag() - Method in class fr.sii.ogham.sms.sender.impl.ovh.OvhOptions

getTemplateBuilder() - Method in class fr.sii.ogham.core.builder.ContentTranslatorBuilder

Get the builder used to handle template support.

getTemplateBuilder() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Shortcut to directly access template builder for fine tuning templating mechanism.

getTemplateBuilder() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Shortcut to directly access template builder for fine tuning templating mechanism.

getTemplateName() - Method in exception fr.sii.ogham.core.exception.template.ParseException

getThymeleafParser() - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Get the reference to the specialized builder for Thymeleaf.

getTitle(String) - Static method in class fr.sii.ogham.core.util.HtmlUtils

Get the title of the HTML.

getTo() - Method in class fr.sii.ogham.helper.email.ExpectedEmailHeader

getTon() - Method in class fr.sii.ogham.helper.sms.ExpectedAddressedPhoneNumber

getTon() - Method in class fr.sii.ogham.sms.message.addressing.AddressedPhoneNumber

getTranslators() - Method in class fr.sii.ogham.core.translator.content.EveryContentTranslator

Get the registered translators.

getTranslators() - Method in class fr.sii.ogham.core.translator.resource.EveryResourceTranslator

Get the registered translators.

getType() - Method in class fr.sii.ogham.email.message.Recipient

getUnbindTimeout() - Method in class fr.sii.ogham.sms.sender.impl.cloudhopper.CloudhopperOptions

getValue() - Method in class fr.sii.ogham.core.util.http.Parameter

getValue() - Method in class fr.sii.ogham.mock.context.SimpleBean

getValue() - Method in enum fr.sii.ogham.sms.sender.impl.ovh.SmsCoding

getValues() - Method in class fr.sii.ogham.core.filler.SimpleFiller

getVariables() - Method in class fr.sii.ogham.core.template.context.BeanContext

getVariables() - Method in interface fr.sii.ogham.core.template.context.Context

Provide variable substitution values.

getVariables() - Method in class fr.sii.ogham.core.template.context.LocaleContext

getVariables() - Method in class fr.sii.ogham.core.template.context.SimpleContext

getVariant() - Method in interface fr.sii.ogham.core.message.capability.HasVariant

Get the variant

getVariant() - Method in class fr.sii.ogham.core.message.content.TemplateVariantContent

getVariant() - Method in exception fr.sii.ogham.template.exception.VariantResolutionException

H

HasContentFluent<F> - Interface in fr.sii.ogham.core.message.capability

Interface to mark a message that has the content capability using fluent API.

hashCode() - Method in class fr.sii.ogham.core.condition.CompositeCondition

hashCode() - Method in class fr.sii.ogham.core.condition.FixedCondition

hashCode() - Method in class fr.sii.ogham.core.condition.RequiredClassCondition

hashCode() - Method in class fr.sii.ogham.core.condition.RequiredPropertyCondition

hashCode() - Method in class fr.sii.ogham.core.message.content.MultiContent

hashCode() - Method in class fr.sii.ogham.core.message.content.StringContent

hashCode() - Method in class fr.sii.ogham.core.message.content.TemplateContent

hashCode() - Method in class fr.sii.ogham.core.message.content.TemplateVariantContent

hashCode() - Method in class fr.sii.ogham.core.resource.ByteResource

hashCode() - Method in class fr.sii.ogham.core.resource.FileResource

hashCode() - Method in class fr.sii.ogham.core.resource.LookupResource

hashCode() - Method in class fr.sii.ogham.core.template.context.BeanContext

hashCode() - Method in class fr.sii.ogham.core.template.context.SimpleContext

hashCode() - Method in class fr.sii.ogham.core.util.HashCodeBuilder

The generated hash code

hashCode() - Method in class fr.sii.ogham.email.attachment.Attachment

hashCode() - Method in class fr.sii.ogham.email.message.Email

hashCode() - Method in class fr.sii.ogham.email.message.EmailAddress

hashCode() - Method in class fr.sii.ogham.email.message.Recipient

hashCode() - Method in class fr.sii.ogham.helper.sms.ExpectedAddressedPhoneNumber

hashCode() - Method in class fr.sii.ogham.mock.context.NestedBean

hashCode() - Method in class fr.sii.ogham.mock.context.SimpleBean

hashCode() - Method in class fr.sii.ogham.sms.message.addressing.AddressedPhoneNumber

hashCode() - Method in class fr.sii.ogham.sms.message.Contact

hashCode() - Method in class fr.sii.ogham.sms.message.PhoneNumber

hashCode() - Method in class fr.sii.ogham.sms.message.Sms

HashCodeBuilder - Class in fr.sii.ogham.core.util

Assists in implementing Object.hashCode() methods.

HashCodeBuilder(int, int) - Constructor for class fr.sii.ogham.core.util.HashCodeBuilder

Two randomly chosen, odd numbers must be passed in.

HashCodeBuilder() - Constructor for class fr.sii.ogham.core.util.HashCodeBuilder

Uses two hard coded choices for the constants needed to build a hashCode.

HasRecipients<R extends Addressee> - Interface in fr.sii.ogham.core.message.capability

Interface to mark a message that has recipient capability.

HasRecipientsFluent<F,R extends Addressee> - Interface in fr.sii.ogham.core.message.capability

Interface to mark a message that has recipient capability using fluent API.

HasSubject - Interface in fr.sii.ogham.core.message.capability

Interface to mark a message that has the subject capability.

HasSubjectFluent<F> - Interface in fr.sii.ogham.core.message.capability

Interface to mark a message that has the subject capability using fluent API.

HasToFluent<F> - Interface in fr.sii.ogham.core.message.capability

Interface to mark a message that has "to" recipient capability.

HasVariant - Interface in fr.sii.ogham.core.message.capability

Interface to mark a template that has variants.

HOST_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants

The key for SMPP host property

HtmlTitleSubjectProvider - Class in fr.sii.ogham.core.subject.provider

Provider that analyzes the content of the message.

HtmlTitleSubjectProvider() - Constructor for class fr.sii.ogham.core.subject.provider.HtmlTitleSubjectProvider

HtmlUtils - Class in fr.sii.ogham.core.util

Utility class for handling HTML content.

HTTP_API_URL - Static variable in class fr.sii.ogham.sms.SmsConstants.OvhConstants

The URL of the HTTP API for sending SMS through OVH

HttpException - Exception in fr.sii.ogham.core.exception.util

HttpException(String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.util.HttpException

HttpException(String) - Constructor for exception fr.sii.ogham.core.exception.util.HttpException

HttpException(Throwable) - Constructor for exception fr.sii.ogham.core.exception.util.HttpException

HttpStatus - Enum in fr.sii.ogham.core.util.http

Enum that contains all HTTP status.

HttpUtils - Class in fr.sii.ogham.core.util

Utility class that helps to send HTTP requests.

I

IdGenerator - Interface in fr.sii.ogham.core.id.generator

ImageInliner - Interface in fr.sii.ogham.html.inliner

Interface for all image inliners.

ImageInlinerConstants - Class in fr.sii.ogham.html.inliner

Common constants for image inlining.

ImageResource - Class in fr.sii.ogham.html.inliner

A simple object that represents an image to be usable by the InlineImageTranslator.

ImageResource(String, String, byte[], String) - Constructor for class fr.sii.ogham.html.inliner.ImageResource

Initialize the resource with the name of the image, the path of the image found in the HTML, the content of the image as array of bytes and the mimetype of the image.

initialize() - Method in class fr.sii.ogham.template.thymeleaf.ThymeLeafFirstSupportingTemplateResolver

INLINE - Static variable in class fr.sii.ogham.email.attachment.ContentDisposition

inline(String, List<ExternalCss>) - Method in interface fr.sii.ogham.html.inliner.CssInliner

inline(String, List<ImageResource>) - Method in class fr.sii.ogham.html.inliner.EveryImageInliner

inline(String, List<ImageResource>) - Method in interface fr.sii.ogham.html.inliner.ImageInliner

Transform the HTML content in order to inline images.

inline(String, List<ImageResource>) - Method in class fr.sii.ogham.html.inliner.impl.jsoup.JsoupAttachImageInliner

inline(String, List<ImageResource>) - Method in class fr.sii.ogham.html.inliner.impl.jsoup.JsoupBase64ImageInliner

inline(String, List<ExternalCss>) - Method in class fr.sii.ogham.html.inliner.impl.jsoup.JsoupCssInliner

INLINE_MODE_ATTR - Static variable in class fr.sii.ogham.html.inliner.ImageInlinerConstants

The attribute name to indicate which strategy for inlining to apply if the default one is not appropriated.

InlineCssTranslator - Class in fr.sii.ogham.html.translator

Translator that transforms HTML content.

InlineCssTranslator(CssInliner, ResourceResolver) - Constructor for class fr.sii.ogham.html.translator.InlineCssTranslator

InlineImageTranslator - Class in fr.sii.ogham.html.translator

Translator that transforms HTML content.

InlineImageTranslator(ImageInliner, ResourceResolver, MimeTypeProvider) - Constructor for class fr.sii.ogham.html.translator.InlineImageTranslator

intercept(MimeMessage, Email) - Method in interface fr.sii.ogham.email.sender.impl.javamail.JavaMailInterceptor

Add extra operations to handle the message just before sending it.

INTERFACE_VERSION_3_3 - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants

The constant for interface version 3.3

INTERFACE_VERSION_3_4 - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants

The constant for interface version 3.4

INTERFACE_VERSION_5_0 - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants

The constant for interface version 5.0

INTERFACE_VERSION_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants

The key for SMPP window size property

InternationalNumberFormatHandler - Class in fr.sii.ogham.sms.message.addressing.translator

Loose International phone number handler.

InternationalNumberFormatHandler() - Constructor for class fr.sii.ogham.sms.message.addressing.translator.InternationalNumberFormatHandler

IOUtils - Class in fr.sii.ogham.core.util

Helper class for I/O management: Read a stream and provide its content as byte array This work can be done by several libraries.

isClientError() - Method in enum fr.sii.ogham.core.util.http.HttpStatus

Is the HTTP status stand for client error (between 400 inclusive and 500 exclusive)

isEqual() - Method in class fr.sii.ogham.core.util.EqualsBuilder

Returns true if the fields that have been checked are all equal.

isHtml(String) - Static method in class fr.sii.ogham.core.util.HtmlUtils

Indicates if the provided content is HTML or not.

isInformal() - Method in enum fr.sii.ogham.core.util.http.HttpStatus

Is the HTTP status stand for informal (between 100 inclusive and 200 exclusive)

isInlineModeAllowed(Element, String) - Static method in class fr.sii.ogham.html.inliner.impl.jsoup.JsoupUtils

Checks if inlining mode is allowed on the provided element.

isOverride() - Method in class fr.sii.ogham.core.util.BeanUtils.Options

isRedirect() - Method in enum fr.sii.ogham.core.util.http.HttpStatus

Is the HTTP status stand for redirect (between 300 inclusive and 400 exclusive)

isServerError() - Method in enum fr.sii.ogham.core.util.http.HttpStatus

Is the HTTP status stand for server error (between 500 inclusive and 600 exclusive)

isSkipUnknown() - Method in class fr.sii.ogham.core.util.BeanUtils.Options

isSuccess() - Method in enum fr.sii.ogham.core.util.http.HttpStatus

Is the HTTP status stand for success (between 200 inclusive and 300 exclusive)

J

JavaActivationProvider - Class in fr.sii.ogham.core.mimetype

Mime Type detection implementation based on Java MimetypesFileTypeMap.

JavaActivationProvider(MimetypesFileTypeMap) - Constructor for class fr.sii.ogham.core.mimetype.JavaActivationProvider

JavaActivationProvider() - Constructor for class fr.sii.ogham.core.mimetype.JavaActivationProvider

JavaFilesProvider - Class in fr.sii.ogham.core.mimetype

Mime Type detection based on Java 7 features.

JavaFilesProvider() - Constructor for class fr.sii.ogham.core.mimetype.JavaFilesProvider

JavaMailAttachmentResourceHandler - Interface in fr.sii.ogham.email.sender.impl.javamail

JavaMailBuilder - Class in fr.sii.ogham.email.builder

Builder that helps to construct the Java mail API implementation.

JavaMailBuilder() - Constructor for class fr.sii.ogham.email.builder.JavaMailBuilder

JavaMailContentHandler - Interface in fr.sii.ogham.email.sender.impl.javamail

Java mail API implementation delegates the management of the content to a JavaMailContentHandler.

JavaMailInterceptor - Interface in fr.sii.ogham.email.sender.impl.javamail

Extension point used to customize the message before sending it.

JavaMailSender - Class in fr.sii.ogham.email.sender.impl

Java mail API implementation.

JavaMailSender(Properties, JavaMailContentHandler, JavaMailAttachmentResourceHandler, Authenticator) - Constructor for class fr.sii.ogham.email.sender.impl.JavaMailSender

JavaMailSender(Properties, JavaMailContentHandler, JavaMailAttachmentResourceHandler, Authenticator, JavaMailInterceptor) - Constructor for class fr.sii.ogham.email.sender.impl.JavaMailSender

join(Object[], String) - Static method in class fr.sii.ogham.core.util.StringUtils

Joins the elements of the provided array into a single String containing the provided list of elements.

join(Iterable<?>, String) - Static method in class fr.sii.ogham.core.util.StringUtils

Joins the elements of the provided Iterable into a single String containing the provided elements.

JSMPPServer - Class in fr.sii.ogham.helper.sms.jsmpp

The server simulator based on jsmpp samples.

JSMPPServer(int) - Constructor for class fr.sii.ogham.helper.sms.jsmpp.JSMPPServer

JsmppServerRule - Class in fr.sii.ogham.helper.sms.rule

JsmppServerRule(int) - Constructor for class fr.sii.ogham.helper.sms.rule.JsmppServerRule

Initialize the server with the provided port.

JsmppServerRule() - Constructor for class fr.sii.ogham.helper.sms.rule.JsmppServerRule

Initialize the server with the default port.

JSMPPServerSimulator - Class in fr.sii.ogham.helper.sms.jsmpp

JSMPPServerSimulator(int) - Constructor for class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

JsoupAttachImageInliner - Class in fr.sii.ogham.html.inliner.impl.jsoup

Image inliner that loads the image and attaches it to the mail.

JsoupAttachImageInliner(IdGenerator) - Constructor for class fr.sii.ogham.html.inliner.impl.jsoup.JsoupAttachImageInliner

JsoupBase64ImageInliner - Class in fr.sii.ogham.html.inliner.impl.jsoup

Image inliner that reads the image and converts it into a base64 string.

JsoupBase64ImageInliner() - Constructor for class fr.sii.ogham.html.inliner.impl.jsoup.JsoupBase64ImageInliner

JsoupCssInliner - Class in fr.sii.ogham.html.inliner.impl.jsoup

JsoupCssInliner() - Constructor for class fr.sii.ogham.html.inliner.impl.jsoup.JsoupCssInliner

JsoupUtils - Class in fr.sii.ogham.html.inliner.impl.jsoup

Helper class that factorizes code for classes that are using Jsoup inliners.

L

LanguageResolver - Interface in fr.sii.ogham.i18n

leftPad(String, int, char) - Static method in class fr.sii.ogham.core.util.StringUtils

Left pad a String with a specified character.

LocaleContext - Class in fr.sii.ogham.core.template.context

A context that also provides Locale information for internationalization.

LocaleContext(Context, Locale) - Constructor for class fr.sii.ogham.core.template.context.LocaleContext

LocaleContext(Object, Locale) - Constructor for class fr.sii.ogham.core.template.context.LocaleContext

LoggingTestRule - Class in fr.sii.ogham.helper.rule

LoggingTestRule(int) - Constructor for class fr.sii.ogham.helper.rule.LoggingTestRule

LoggingTestRule() - Constructor for class fr.sii.ogham.helper.rule.LoggingTestRule

LOGIN_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.OvhConstants

The key for OVH login

LookupResource - Class in fr.sii.ogham.core.resource

Resource that is able to handle string path prefixed by a lookup string.

LookupResource(String, String) - Constructor for class fr.sii.ogham.core.resource.LookupResource

Initialize the resource with the provided path to the resource content.

LookupResource(String) - Constructor for class fr.sii.ogham.core.resource.LookupResource

Initialize the resource with the provided path to the resource content.

LookupResourceTranslator - Class in fr.sii.ogham.core.translator.resource

Translator that handles LookupResource.

LookupResourceTranslator(FirstSupportingResourceResolver) - Constructor for class fr.sii.ogham.core.translator.resource.LookupResourceTranslator

M

MapAttachmentResourceHandler - Class in fr.sii.ogham.email.sender.impl.javamail

Provides a handler for the attachment resource based on the class of the attachment resource.

MapAttachmentResourceHandler(Map<Class<? extends NamedResource>, JavaMailAttachmentResourceHandler>) - Constructor for class fr.sii.ogham.email.sender.impl.javamail.MapAttachmentResourceHandler

Initialize with the map of attachment resource handlers indexed by the attachment resource class.

MapAttachmentResourceHandler() - Constructor for class fr.sii.ogham.email.sender.impl.javamail.MapAttachmentResourceHandler

Initialize an empty map

MapCloudhopperCharsetHandler - Class in fr.sii.ogham.sms.sender.impl.cloudhopper

Default implementation of a configurable CloudhopperCharsetHandler.

MapCloudhopperCharsetHandler(CharsetProvider) - Constructor for class fr.sii.ogham.sms.sender.impl.cloudhopper.MapCloudhopperCharsetHandler

MapCloudhopperCharsetHandler(CharsetProvider, Map<String, String>) - Constructor for class fr.sii.ogham.sms.sender.impl.cloudhopper.MapCloudhopperCharsetHandler

Initializes with the map of Charset code handlers indexed indexed by the NIO Charset code.

MapContentHandler - Class in fr.sii.ogham.email.sender.impl.javamail

Provides a content handler based on the class of the content.

MapContentHandler(Map<Class<? extends Content>, JavaMailContentHandler>) - Constructor for class fr.sii.ogham.email.sender.impl.javamail.MapContentHandler

Initialize with the map of content handlers indexed by the content class.

MapContentHandler() - Constructor for class fr.sii.ogham.email.sender.impl.javamail.MapContentHandler

Initialize an empty map

MapContentHandler - Class in fr.sii.ogham.email.sender.impl.sendgrid.handler

Implementation of SendGridContentHandler that delegates content handling to specialized instances, if one matching the actual content type has been declared.

MapContentHandler() - Constructor for class fr.sii.ogham.email.sender.impl.sendgrid.handler.MapContentHandler

Constructor.

MayHaveStringContent - Interface in fr.sii.ogham.core.message.content

Marker interface to indicate that the content can be directly available as string.

Message - Interface in fr.sii.ogham.core.message

Base interface for any message.

MessageException - Exception in fr.sii.ogham.core.exception

MessageException(String, Message, Throwable) - Constructor for exception fr.sii.ogham.core.exception.MessageException

MessageException(String, Message) - Constructor for exception fr.sii.ogham.core.exception.MessageException

MessageException(Throwable, Message) - Constructor for exception fr.sii.ogham.core.exception.MessageException

MessageFiller - Interface in fr.sii.ogham.core.filler

Interface that declares a filler for messages.

MessageFillerBuilder - Class in fr.sii.ogham.core.builder

Builder that help construct the message fillers.

MessageFillerBuilder() - Constructor for class fr.sii.ogham.core.builder.MessageFillerBuilder

MessageNotSentException - Exception in fr.sii.ogham.core.exception

MessageNotSentException(String, Message, Throwable) - Constructor for exception fr.sii.ogham.core.exception.MessageNotSentException

MessageNotSentException(String, Message) - Constructor for exception fr.sii.ogham.core.exception.MessageNotSentException

MessageNotSentException(Throwable, Message) - Constructor for exception fr.sii.ogham.core.exception.MessageNotSentException

MessageSender - Interface in fr.sii.ogham.core.sender

Base interface for sender implementations.

MessagingBuilder - Class in fr.sii.ogham.core.builder

Basic implementation of the builder that help to construct the messaging service.

MessagingBuilder() - Constructor for class fr.sii.ogham.core.builder.MessagingBuilder

MessagingBuilderConfigurer - Interface in fr.sii.ogham.spring.config

MessagingException - Exception in fr.sii.ogham.core.exception

MessagingException(String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.MessagingException

MessagingException(String) - Constructor for exception fr.sii.ogham.core.exception.MessagingException

MessagingException(Throwable) - Constructor for exception fr.sii.ogham.core.exception.MessagingException

MessagingSenderBuilder<S extends MessageSender> - Interface in fr.sii.ogham.core.builder

Base interface acting as a marker for builders that help to construct a message sender.

MessagingService - Interface in fr.sii.ogham.core.service

Interface that declares the contract for using the messaging system.

messagingService(MessagingBuilder) - Method in class fr.sii.ogham.spring.autoconfigure.OghamAutoConfiguration

Configures the Messaging service and the TemplateParser.

MessagingServiceBuilder - Interface in fr.sii.ogham.core.builder

Specialized interface acting just as marker for building the messaging service.

MimeTypeDetectionException - Exception in fr.sii.ogham.core.exception.mimetype

MimeTypeDetectionException(String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.mimetype.MimeTypeDetectionException

MimeTypeDetectionException(String) - Constructor for exception fr.sii.ogham.core.exception.mimetype.MimeTypeDetectionException

MimeTypeDetectionException(Throwable) - Constructor for exception fr.sii.ogham.core.exception.mimetype.MimeTypeDetectionException

MimeTypeException - Exception in fr.sii.ogham.core.exception.mimetype

MimeTypeException(String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.mimetype.MimeTypeException

MimeTypeException(String) - Constructor for exception fr.sii.ogham.core.exception.mimetype.MimeTypeException

MimeTypeException(Throwable) - Constructor for exception fr.sii.ogham.core.exception.mimetype.MimeTypeException

MimeTypeProvider - Interface in fr.sii.ogham.core.mimetype

Adapter interface to be able to handle any Mime Type detection implementation.

MimetypeProviderBuilder - Class in fr.sii.ogham.core.builder

General builder used to build a MimeType provider.

MimetypeProviderBuilder() - Constructor for class fr.sii.ogham.core.builder.MimetypeProviderBuilder

MultiContent - Class in fr.sii.ogham.core.message.content

Decorator content that provide ability to handle several sub contents.

MultiContent(String, String...) - Constructor for class fr.sii.ogham.core.message.content.MultiContent

Initialize the content with one or several sub contents directly as strings.

MultiContent(Content...) - Constructor for class fr.sii.ogham.core.message.content.MultiContent

Initialize the content with none, one or several sub contents.

MultiContent(List<Content>) - Constructor for class fr.sii.ogham.core.message.content.MultiContent

Initialize the content with a list of sub contents

MultiContentHandler - Class in fr.sii.ogham.email.sender.impl.javamail

Handle multiple contents.

MultiContentHandler(JavaMailContentHandler) - Constructor for class fr.sii.ogham.email.sender.impl.javamail.MultiContentHandler

MultiContentHandler - Class in fr.sii.ogham.email.sender.impl.sendgrid.handler

Content handler for MultiContent instances.

MultiContentHandler(SendGridContentHandler) - Constructor for class fr.sii.ogham.email.sender.impl.sendgrid.handler.MultiContentHandler

Constructor.

MultiContentSubjectProvider - Class in fr.sii.ogham.core.subject.provider

Subject provider that is able to handle messages with MultiContent.

MultiContentSubjectProvider(SubjectProvider) - Constructor for class fr.sii.ogham.core.subject.provider.MultiContentSubjectProvider

MultiContentTranslator - Class in fr.sii.ogham.core.translator.content

Decorator that is able to handle MultiContent.

MultiContentTranslator(ContentTranslator) - Constructor for class fr.sii.ogham.core.translator.content.MultiContentTranslator

MultiImplementationSender<M extends Message> - Class in fr.sii.ogham.core.sender

Decorator sender that is able to handle a particular type of message.

MultiImplementationSender() - Constructor for class fr.sii.ogham.core.sender.MultiImplementationSender

Initialize with no registered implementation.

MultiImplementationSender(Condition<Message>, MessageSender) - Constructor for class fr.sii.ogham.core.sender.MultiImplementationSender

Initialize with one implementation.

MultiImplementationSender(Map<Condition<Message>, MessageSender>) - Constructor for class fr.sii.ogham.core.sender.MultiImplementationSender

Initialize with several implementations.

MultiTemplateContent - Class in fr.sii.ogham.core.message.content

A shortcut for using several templates with same context.

MultiTemplateContent(String, Context, Variant...) - Constructor for class fr.sii.ogham.core.message.content.MultiTemplateContent

Initialize with the template path (without extension/variant) and the context.

MultiTemplateContent(String, Context) - Constructor for class fr.sii.ogham.core.message.content.MultiTemplateContent

Initialize with the template path (without extension/variant) and the context.

MultiTemplateContent(String, Object, Variant...) - Constructor for class fr.sii.ogham.core.message.content.MultiTemplateContent

Initialize with the template path (without extension/variant) and the context as simple bean.

MultiTemplateContent(String, Object) - Constructor for class fr.sii.ogham.core.message.content.MultiTemplateContent

Initialize with the template path (without extension/variant) and the context as simple bean.

N

NamedResource - Interface in fr.sii.ogham.core.resource

NestedBean - Class in fr.sii.ogham.mock.context

NestedBean(Object) - Constructor for class fr.sii.ogham.mock.context.NestedBean

NO_STOP_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.OvhConstants

The key for OVH option noStop

NoAttachmentResourceHandlerException - Exception in fr.sii.ogham.email.exception.javamail

NoAttachmentResourceHandlerException(String, Attachment) - Constructor for exception fr.sii.ogham.email.exception.javamail.NoAttachmentResourceHandlerException

NoContentHandlerException - Exception in fr.sii.ogham.email.exception.javamail

NoContentHandlerException(String, Content) - Constructor for exception fr.sii.ogham.email.exception.javamail.NoContentHandlerException

NoEngineDetectionException - Exception in fr.sii.ogham.core.exception.template

NoEngineDetectionException(String) - Constructor for exception fr.sii.ogham.core.exception.template.NoEngineDetectionException

NoResolverAdapterException - Exception in fr.sii.ogham.template.exception

NoResolverAdapterException(String, ResourceResolver, Throwable) - Constructor for exception fr.sii.ogham.template.exception.NoResolverAdapterException

NoResolverAdapterException(String, ResourceResolver) - Constructor for exception fr.sii.ogham.template.exception.NoResolverAdapterException

NoResolverAdapterException(ResourceResolver, Throwable) - Constructor for exception fr.sii.ogham.template.exception.NoResolverAdapterException

NoResolverException - Exception in fr.sii.ogham.core.exception.resource

NoResolverException(String, String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.resource.NoResolverException

NoResolverException(String, String) - Constructor for exception fr.sii.ogham.core.exception.resource.NoResolverException

NoResolverException(String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.resource.NoResolverException

NoTemplateEngineConfigurer - Class in fr.sii.ogham.spring.autoconfigure

NoTemplateEngineConfigurer() - Constructor for class fr.sii.ogham.spring.autoconfigure.NoTemplateEngineConfigurer

NullVariantResolver - Class in fr.sii.ogham.template.common.adapter

NullVariantResolver() - Constructor for class fr.sii.ogham.template.common.adapter.NullVariantResolver

NumberingPlanIndicator - Enum in fr.sii.ogham.sms.message.addressing

NPI as described in GSM 03.40.

O

OghamAutoConfiguration - Class in fr.sii.ogham.spring.autoconfigure

Spring Boot auto-configuration module for Ogham messaging library.

OghamAutoConfiguration() - Constructor for class fr.sii.ogham.spring.autoconfigure.OghamAutoConfiguration

OghamAutoConfiguration.OghamFreemarkerConfiguration - Class in fr.sii.ogham.spring.autoconfigure

OghamAutoConfiguration.OghamNoTemplateEngineConfiguration - Class in fr.sii.ogham.spring.autoconfigure

OghamAutoConfiguration.OghamThymeleafConfiguration - Class in fr.sii.ogham.spring.autoconfigure

OghamFreemarkerConfiguration() - Constructor for class fr.sii.ogham.spring.autoconfigure.OghamAutoConfiguration.OghamFreemarkerConfiguration

OghamNoTemplateEngineConfiguration() - Constructor for class fr.sii.ogham.spring.autoconfigure.OghamAutoConfiguration.OghamNoTemplateEngineConfiguration

OghamThymeleafConfiguration() - Constructor for class fr.sii.ogham.spring.autoconfigure.OghamAutoConfiguration.OghamThymeleafConfiguration

onAcceptCancelSm(CancelSm, SMPPServerSession) - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

onAcceptDataSm(DataSm, Session) - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

onAcceptQuerySm(QuerySm, SMPPServerSession) - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

onAcceptReplaceSm(ReplaceSm, SMPPServerSession) - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

onAcceptSubmitMulti(SubmitMulti, SMPPServerSession) - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

onAcceptSubmitSm(SubmitSm, SMPPServerSession) - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

onSubmitSmRespSent(MessageId, SMPPServerSession) - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

Options(boolean, boolean) - Constructor for class fr.sii.ogham.core.util.BeanUtils.Options

OrCondition<T> - Class in fr.sii.ogham.core.condition

Condition that provides a logical OR operation on manipulated conditions.

OrCondition(Condition<T>...) - Constructor for class fr.sii.ogham.core.condition.OrCondition

OrCondition(List<Condition<T>>) - Constructor for class fr.sii.ogham.core.condition.OrCondition

OrTemplateDetector - Class in fr.sii.ogham.core.template.detector

A decorator for template engine detection that relies on other template engine detectors.

OrTemplateDetector(List<TemplateEngineDetector>) - Constructor for class fr.sii.ogham.core.template.detector.OrTemplateDetector

Initialize the composite detector with none, one or several detector implementations.

OrTemplateDetector(TemplateEngineDetector...) - Constructor for class fr.sii.ogham.core.template.detector.OrTemplateDetector

Initialize the composite detector with the provided detector implementation list.

OvhAuthParams - Class in fr.sii.ogham.sms.sender.impl.ovh

Authentication parameters required by OVH.

OvhAuthParams(String, String, String) - Constructor for class fr.sii.ogham.sms.sender.impl.ovh.OvhAuthParams

OvhOptions - Class in fr.sii.ogham.sms.sender.impl.ovh

The optional parameters used to customize OVH SMS: noStop: do not display STOP footer.

OvhOptions() - Constructor for class fr.sii.ogham.sms.sender.impl.ovh.OvhOptions

OvhOptions(boolean, String, SmsCoding) - Constructor for class fr.sii.ogham.sms.sender.impl.ovh.OvhOptions

OvhSmsBuilder - Class in fr.sii.ogham.sms.builder

Builder that helps to construct the OVH web service implementation.

OvhSmsBuilder() - Constructor for class fr.sii.ogham.sms.builder.OvhSmsBuilder

OvhSmsSender - Class in fr.sii.ogham.sms.sender.impl

Implementation that is able to send SMS through OVH web service.

OvhSmsSender(URL, OvhAuthParams, OvhOptions) - Constructor for class fr.sii.ogham.sms.sender.impl.OvhSmsSender

P

Parameter - Class in fr.sii.ogham.core.util.http

Simple abstraction for manipulating parameters that has a name and a value.

Parameter(String, String) - Constructor for class fr.sii.ogham.core.util.http.Parameter

parse(String, Context) - Method in class fr.sii.ogham.core.template.parser.AutoDetectTemplateParser

parse(String, Context) - Method in interface fr.sii.ogham.core.template.parser.TemplateParser

Load the template from its name (or path).

parse(String, Context) - Method in class fr.sii.ogham.template.freemarker.FreeMarkerParser

parse(String, Context) - Method in class fr.sii.ogham.template.thymeleaf.ThymeleafParser

ParseException - Exception in fr.sii.ogham.core.exception.template

ParseException(String, String, Context, Throwable) - Constructor for exception fr.sii.ogham.core.exception.template.ParseException

ParseException(String, String, Context) - Constructor for exception fr.sii.ogham.core.exception.template.ParseException

ParseException(String, Context, Throwable) - Constructor for exception fr.sii.ogham.core.exception.template.ParseException

PASSWORD - Static variable in class fr.sii.ogham.email.EmailConstants.SendGridConstants

The property key for SendGrid user password

PASSWORD_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.OvhConstants

The key for OVH password

PASSWORD_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants

The key for SMPP password property

PhoneNumber - Class in fr.sii.ogham.sms.message

Represents a phone number.

PhoneNumber(String) - Constructor for class fr.sii.ogham.sms.message.PhoneNumber

Initialize the phone number with the provided number.

PhoneNumberException - Exception in fr.sii.ogham.core.exception.util

PhoneNumberException(String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.util.PhoneNumberException

PhoneNumberException(String) - Constructor for exception fr.sii.ogham.core.exception.util.PhoneNumberException

PhoneNumberException(Throwable) - Constructor for exception fr.sii.ogham.core.exception.util.PhoneNumberException

PhoneNumberHandler - Interface in fr.sii.ogham.sms.message.addressing.translator

Dedicated phone number translator exposing its capabilities.

PhoneNumberTranslator - Interface in fr.sii.ogham.sms.message.addressing.translator

Translates a given PhoneNumber to an AddressedPhoneNumber, deducing its TON and NPI.

PhoneNumberTranslatorBuilder - Interface in fr.sii.ogham.sms.builder

Builder that helps to construct the PhoneNumberTranslator implementation.

PhoneNumberTranslatorException - Exception in fr.sii.ogham.sms.exception.message

PhoneNumberTranslatorException(String, Throwable) - Constructor for exception fr.sii.ogham.sms.exception.message.PhoneNumberTranslatorException

PhoneNumberTranslatorException(String) - Constructor for exception fr.sii.ogham.sms.exception.message.PhoneNumberTranslatorException

PhoneNumberTranslatorException(Throwable) - Constructor for exception fr.sii.ogham.sms.exception.message.PhoneNumberTranslatorException

PhoneNumberTranslatorSender - Class in fr.sii.ogham.sms.sender.impl

Decorator sender that transforms the content of the message before really sending it.

PhoneNumberTranslatorSender(PhoneNumberTranslator, PhoneNumberTranslator, MessageSender) - Constructor for class fr.sii.ogham.sms.sender.impl.PhoneNumberTranslatorSender

Initializes the sender with the provided translators and decorated sender.

populate(Object, Map<String, Object>, BeanUtils.Options) - Static method in class fr.sii.ogham.core.util.BeanUtils

Fills a Java object with the provided values.

populate(Object, Map.Entry<String, Object>, BeanUtils.Options) - Static method in class fr.sii.ogham.core.util.BeanUtils

Fills a Java object with the provided value.

populate(Object, Map<String, Object>) - Static method in class fr.sii.ogham.core.util.BeanUtils

Fills a Java object with the provided values.

PORT_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants

The key for SMPP port property

PREFIX_PROPERTY - Static variable in class fr.sii.ogham.email.EmailConstants.TemplateConstants

The property key for the prefix of the template resolution for emails only

PREFIX_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.TemplateConstants

The property key for the prefix of the template resolution for emails only

PREFIX_PROPERTY - Static variable in class fr.sii.ogham.template.TemplateConstants

The property key for the prefix of the template resolution

PROPERTIES_PREFIX - Static variable in class fr.sii.ogham.email.EmailConstants

The prefix for email properties

PROPERTIES_PREFIX - Static variable in class fr.sii.ogham.email.EmailConstants.TemplateConstants

The prefix for properties used by the template engines for emails only

PROPERTIES_PREFIX - Static variable in class fr.sii.ogham.sms.SmsConstants

The prefix for SMS properties

PROPERTIES_PREFIX - Static variable in class fr.sii.ogham.sms.SmsConstants.TemplateConstants

The prefix for properties used by the template engines for emails only

PROPERTIES_PREFIX - Static variable in class fr.sii.ogham.template.TemplateConstants

The prefix for properties used by the template engines

propertiesBridge() - Method in class fr.sii.ogham.spring.autoconfigure.OghamAutoConfiguration

Converter that read environment values to be usable by Ogham

PropertiesBridge - Class in fr.sii.ogham.spring.config

Spring Environment provides access to properties according to the current environment.

PropertiesBridge() - Constructor for class fr.sii.ogham.spring.config.PropertiesBridge

PropertiesFiller - Class in fr.sii.ogham.core.filler

Fill the message using properties.

PropertiesFiller(String) - Constructor for class fr.sii.ogham.core.filler.PropertiesFiller

Initialize the filler with the system properties.

PropertiesFiller(Properties, String) - Constructor for class fr.sii.ogham.core.filler.PropertiesFiller

Initialize the filler with the provided properties.

PropertiesUsernamePasswordAuthenticator - Class in fr.sii.ogham.email.sender.impl.javamail

Shortcut to provide username and password by reading them from provided properties

PropertiesUsernamePasswordAuthenticator(Properties) - Constructor for class fr.sii.ogham.email.sender.impl.javamail.PropertiesUsernamePasswordAuthenticator

PropertiesUsernamePasswordAuthenticator(Properties, String, String) - Constructor for class fr.sii.ogham.email.sender.impl.javamail.PropertiesUsernamePasswordAuthenticator

provide(Message) - Method in class fr.sii.ogham.core.subject.provider.FirstSupportingSubjectProvider

provide(Message) - Method in class fr.sii.ogham.core.subject.provider.HtmlTitleSubjectProvider

provide(Message) - Method in class fr.sii.ogham.core.subject.provider.MultiContentSubjectProvider

provide(Message) - Method in interface fr.sii.ogham.core.subject.provider.SubjectProvider

Generate a subject from the provided message.

provide(Message) - Method in class fr.sii.ogham.core.subject.provider.TextPrefixSubjectProvider

R

recipient(R) - Method in interface fr.sii.ogham.core.message.capability.HasRecipientsFluent

Add a recipient for the message

recipient(Recipient) - Method in class fr.sii.ogham.email.message.Email

Add a recipient of the mail.

recipient(EmailAddress, RecipientType) - Method in class fr.sii.ogham.email.message.Email

Add a recipient specifying its address and the type (to, cc, bcc).

Recipient - Class in fr.sii.ogham.email.message

Represents an email recipient.

Recipient(String) - Constructor for class fr.sii.ogham.email.message.Recipient

Initialize the recipient with the provided address.

Recipient(EmailAddress) - Constructor for class fr.sii.ogham.email.message.Recipient

Initialize the recipient with the provided address.

Recipient(EmailAddress, RecipientType) - Constructor for class fr.sii.ogham.email.message.Recipient

Initialize the recipient with the provided address and for the provided type.

Recipient - Class in fr.sii.ogham.sms.message

Recipient(String, PhoneNumber) - Constructor for class fr.sii.ogham.sms.message.Recipient

Initialize the contact with its name and its phone number.

Recipient(PhoneNumber) - Constructor for class fr.sii.ogham.sms.message.Recipient

Initialize the contact with its name and its phone number.

Recipient(String, String) - Constructor for class fr.sii.ogham.sms.message.Recipient

Initialize the contact with its name and its phone number as string.

Recipient(String) - Constructor for class fr.sii.ogham.sms.message.Recipient

Initialize the contact with its phone number as string.

recipient(Recipient) - Method in class fr.sii.ogham.sms.message.Sms

Add a recipient for the message

RecipientPhoneNumberTranslatorBuilder - Class in fr.sii.ogham.sms.builder

Builder to construct the PhoneNumberTranslator implementation in charge of default addressing policy (TON / NPI).

RecipientPhoneNumberTranslatorBuilder() - Constructor for class fr.sii.ogham.sms.builder.RecipientPhoneNumberTranslatorBuilder

recipients(List<R>) - Method in interface fr.sii.ogham.core.message.capability.HasRecipientsFluent

Set the list of recipients of the message

recipients(List<Recipient>) - Method in class fr.sii.ogham.email.message.Email

Set the whole list of recipients.

recipients(List<Recipient>) - Method in class fr.sii.ogham.sms.message.Sms

Set the list of recipients of the message

RecipientType - Enum in fr.sii.ogham.email.message

The recipient type for indicating which email field to use.

reflectionsEquals(Object, Object, String...) - Static method in class fr.sii.ogham.core.util.EqualsBuilder

This method uses reflection to determine if the two Objects are equal.

reflectionsHashCode(Object, String...) - Static method in class fr.sii.ogham.core.util.HashCodeBuilder

Uses reflection to build a valid hash code from the fields of object.

register(MimeTypeProvider) - Method in class fr.sii.ogham.core.builder.MimetypeProviderBuilder

register(Class<? extends Content>, SendGridContentHandler) - Method in class fr.sii.ogham.email.sender.impl.sendgrid.handler.MapContentHandler

Registers a handler for a given content type.

register(Variant, String) - Method in class fr.sii.ogham.template.common.adapter.ExtensionMappingVariantResolver

registerAttachmentResourceHandler(Class<? extends NamedResource>, JavaMailAttachmentResourceHandler) - Method in class fr.sii.ogham.email.builder.JavaMailBuilder

Register a new handler for a specific attachment resource.

registerContentHandler(Class<? extends Content>, JavaMailContentHandler) - Method in class fr.sii.ogham.email.builder.JavaMailBuilder

Register a new handler for a specific content.

registerContentHandler(Class<? extends Content>, SendGridContentHandler) - Method in class fr.sii.ogham.email.builder.SendGridBuilder

Register a new handler for a specific content.

registerDefaultImplementations() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Register all default implementations: Java mail API implementation Configuration values come from system properties.

registerDefaultImplementations(Properties) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Register all default implementations: Java mail API implementation Configuration values come from provided properties.

registerDefaultImplementations() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Register all default implementations: OVH HTTP API implementation Configuration values come from system properties.

registerDefaultImplementations(Properties) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Register all default implementations: OVH HTTP API implementation smsgloabl REST API implementation Cloudhopper SMPP implementation Configuration values come from provided properties.

registerImplementation(Condition<Message>, MessageSender) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Register a new implementation for sending email.

registerImplementation(Condition<Message>, Builder<? extends MessageSender>) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Register a new implementation for sending email.

registerImplementation(Condition<Message>, MessageSender) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Register a new implementation for sending SMS.

registerImplementation(Condition<Message>, Builder<? extends MessageSender>) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Register a new implementation for sending SMS.

registerMimeTypeProvider(MimeTypeProvider) - Method in class fr.sii.ogham.email.builder.JavaMailBuilder

Register a new Mime Type provider.

registerMimeTypeProvider(MimeTypeProvider) - Method in class fr.sii.ogham.email.builder.SendGridBuilder

Register a new Mime Type provider.

registerResolverAdapter(TemplateLoaderAdapter) - Method in class fr.sii.ogham.template.freemarker.builder.FreeMarkerTemplateParserBuilder

Registers a new template resolver adapter.

registerResolverAdapter(TemplateResolverAdapter) - Method in class fr.sii.ogham.template.thymeleaf.builder.ThymeleafTemplateParserBuilder

Registers a new template resolver adapter.

registerTemplateParser(TemplateParserBuilder) - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Register a specialized builder for a particular template engine.

registerTemplateParser(TemplateParserBuilder, TemplateEngineDetector) - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Register a specialized builder for a particular template engine.

RelativeResolver - Class in fr.sii.ogham.core.resource.resolver

Decorator resource resolver that use parent path and extension for resource resolution.

RelativeResolver(RelativisableResourceResolver, String) - Constructor for class fr.sii.ogham.core.resource.resolver.RelativeResolver

Initialize the resolver with the mandatory delegate and a parent path.

RelativeResolver(RelativisableResourceResolver, String, String) - Constructor for class fr.sii.ogham.core.resource.resolver.RelativeResolver

Initialize the resolver with the mandatory delegate, a parent path and a extension.

RelativisableResourceResolver - Interface in fr.sii.ogham.core.resource.resolver

Indicates that the ResourceResolver can be decorated bu RelativeResolver.

REQUEST_EXPIRY_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants.TimeoutConstants

The key of property for timeout for the amount of time to wait for an endpoint to respond to a request before it expires. -1 to disable

RequiredClassCondition<T> - Class in fr.sii.ogham.core.condition

Condition that checks if the provided class is available in the classpath.

RequiredClassCondition(String) - Constructor for class fr.sii.ogham.core.condition.RequiredClassCondition

Initialize the condition with the class name

RequiredPropertyCondition<T> - Class in fr.sii.ogham.core.condition

Condition that checks if the provided property is defined either in the system property or in the provided properties.

RequiredPropertyCondition(String) - Constructor for class fr.sii.ogham.core.condition.RequiredPropertyCondition

Initialize the condition with the provided key.

RequiredPropertyCondition(String, Properties) - Constructor for class fr.sii.ogham.core.condition.RequiredPropertyCondition

Initialize the condition with the provided key.

reset() - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

ResolverAdapterConfigurationException - Exception in fr.sii.ogham.template.exception

ResolverAdapterConfigurationException(String, ResourceResolver, Throwable) - Constructor for exception fr.sii.ogham.template.exception.ResolverAdapterConfigurationException

ResolverAdapterConfigurationException(String, ResourceResolver) - Constructor for exception fr.sii.ogham.template.exception.ResolverAdapterConfigurationException

ResolverAdapterConfigurationException(ResourceResolver, Throwable) - Constructor for exception fr.sii.ogham.template.exception.ResolverAdapterConfigurationException

ResolverAdapterException - Exception in fr.sii.ogham.template.exception

ResolverAdapterException(String, ResourceResolver, Throwable) - Constructor for exception fr.sii.ogham.template.exception.ResolverAdapterException

ResolverAdapterException(String, ResourceResolver) - Constructor for exception fr.sii.ogham.template.exception.ResolverAdapterException

ResolverAdapterException(ResourceResolver, Throwable) - Constructor for exception fr.sii.ogham.template.exception.ResolverAdapterException

ResolverAdapterNotFoundException - Exception in fr.sii.ogham.template.exception

ResolverAdapterNotFoundException() - Constructor for exception fr.sii.ogham.template.exception.ResolverAdapterNotFoundException

ResolverAdapterNotFoundException(String) - Constructor for exception fr.sii.ogham.template.exception.ResolverAdapterNotFoundException

ResolverAdapterNotFoundException(String, Throwable) - Constructor for exception fr.sii.ogham.template.exception.ResolverAdapterNotFoundException

resolveTemplate(TemplateProcessingParameters) - Method in class fr.sii.ogham.template.thymeleaf.ThymeLeafFirstSupportingTemplateResolver

Resource - Interface in fr.sii.ogham.core.resource

Interface that defines the behavior of a template.

ResourcePath - Class in fr.sii.ogham.core.resource

Provides a link between a resource path, its recognized lookup and its resolved value.

ResourcePath(String, String, String) - Constructor for class fr.sii.ogham.core.resource.ResourcePath

ResourcePath() - Constructor for class fr.sii.ogham.core.resource.ResourcePath

ResourceResolutionException - Exception in fr.sii.ogham.core.exception.resource

ResourceResolutionException(String, String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.resource.ResourceResolutionException

ResourceResolutionException(String, String) - Constructor for exception fr.sii.ogham.core.exception.resource.ResourceResolutionException

ResourceResolutionException(String, Throwable) - Constructor for exception fr.sii.ogham.core.exception.resource.ResourceResolutionException

ResourceResolver - Interface in fr.sii.ogham.core.resource.resolver

Interface for all resource resolvers.

ResourceTranslatorException - Exception in fr.sii.ogham.email.exception.attachment.translator

ResourceTranslatorException(String, Throwable) - Constructor for exception fr.sii.ogham.email.exception.attachment.translator.ResourceTranslatorException

ResourceTranslatorException(String) - Constructor for exception fr.sii.ogham.email.exception.attachment.translator.ResourceTranslatorException

ResourceTranslatorException(Throwable) - Constructor for exception fr.sii.ogham.email.exception.attachment.translator.ResourceTranslatorException

Response - Class in fr.sii.ogham.core.util.http

Simple abstraction of the HTTP response.

Response(int, String) - Constructor for class fr.sii.ogham.core.util.http.Response

Response(HttpStatus, String) - Constructor for class fr.sii.ogham.core.util.http.Response

RESPONSE_TIMEOUT_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants.CloudhopperConstants

The key of property for timeout for response timeout

run() - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

S

send(Message) - Method in class fr.sii.ogham.core.sender.AbstractSpecializedSender

send(M) - Method in class fr.sii.ogham.core.sender.AbstractSpecializedSender

Sends the message.

send(Message) - Method in class fr.sii.ogham.core.sender.ContentTranslatorSender

send(Message) - Method in class fr.sii.ogham.core.sender.FallbackSender

send(Message) - Method in class fr.sii.ogham.core.sender.FillerSender

send(Message) - Method in interface fr.sii.ogham.core.sender.MessageSender

Sends the message.

send(Message) - Method in class fr.sii.ogham.core.sender.MultiImplementationSender

send(Message) - Method in class fr.sii.ogham.core.service.EverySupportingMessagingService

Sends the message.

send(Message) - Method in interface fr.sii.ogham.core.service.MessagingService

Sends the message.

send(Message) - Method in class fr.sii.ogham.core.service.WrapExceptionMessagingService

Sends the message.

send(Message) - Method in class fr.sii.ogham.email.sender.AttachmentResourceTranslatorSender

send(Email) - Method in class fr.sii.ogham.email.sender.impl.JavaMailSender

send(SendGrid.Email) - Method in class fr.sii.ogham.email.sender.impl.sendgrid.client.DelegateSendGridClient

send(SendGrid.Email) - Method in interface fr.sii.ogham.email.sender.impl.sendgrid.client.SendGridClient

Sends the provided email to SendGrid.

send(Email) - Method in class fr.sii.ogham.email.sender.impl.SendGridSender

send(Sms) - Method in class fr.sii.ogham.sms.sender.impl.CloudhopperSMPPSender

send(Sms) - Method in class fr.sii.ogham.sms.sender.impl.OvhSmsSender

send(Message) - Method in class fr.sii.ogham.sms.sender.impl.PhoneNumberTranslatorSender

send(Sms) - Method in class fr.sii.ogham.sms.sender.impl.SmsglobalRestSender

Sender - Class in fr.sii.ogham.sms.message

Specialization of Contact that represents the sender of the SMS.

Sender(String, PhoneNumber) - Constructor for class fr.sii.ogham.sms.message.Sender

Initialize the contact with its name and its phone number.

Sender(PhoneNumber) - Constructor for class fr.sii.ogham.sms.message.Sender

Initialize the contact with its name and its phone number.

Sender(String, String) - Constructor for class fr.sii.ogham.sms.message.Sender

Initialize the contact with its name and its phone number as string.

Sender(String) - Constructor for class fr.sii.ogham.sms.message.Sender

Initialize the contact with its phone number as string.

SenderPhoneNumberTranslatorBuilder - Class in fr.sii.ogham.sms.builder

Builder to construct the PhoneNumberTranslator implementation in charge of default addressing policy (TON / NPI).

SenderPhoneNumberTranslatorBuilder() - Constructor for class fr.sii.ogham.sms.builder.SenderPhoneNumberTranslatorBuilder

SendGridBuilder - Class in fr.sii.ogham.email.builder

Builder for the SendGrid-backed sender.

SendGridBuilder() - Constructor for class fr.sii.ogham.email.builder.SendGridBuilder

Constructor.

SendGridClient - Interface in fr.sii.ogham.email.sender.impl.sendgrid.client

Description of the operations a service backed with SendGrid should expose.

SendGridContentHandler - Interface in fr.sii.ogham.email.sender.impl.sendgrid.handler

Description of the operations a content handler used with emails sent to SendGrid should implement.

SendGridSender - Class in fr.sii.ogham.email.sender.impl

SendGrid-backed implementation of the email sender.

SendGridSender(SendGridClient, SendGridContentHandler) - Constructor for class fr.sii.ogham.email.sender.impl.SendGridSender

Constructor.

SequentialIdGenerator - Class in fr.sii.ogham.core.id.generator

SequentialIdGenerator(int) - Constructor for class fr.sii.ogham.core.id.generator.SequentialIdGenerator

SequentialIdGenerator() - Constructor for class fr.sii.ogham.core.id.generator.SequentialIdGenerator

SESSION_NAME_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants.CloudhopperConstants

The key of property for session name

sessionBindRequested(Long, SmppSessionConfiguration, BaseBind) - Method in class fr.sii.ogham.helper.sms.cloudhopper.TestSmppServerHandler

sessionCreated(Long, SmppServerSession, BaseBindResp) - Method in class fr.sii.ogham.helper.sms.cloudhopper.TestSmppServerHandler

sessionDestroyed(Long, SmppServerSession) - Method in class fr.sii.ogham.helper.sms.cloudhopper.TestSmppServerHandler

setAttachments(List<Attachment>) - Method in class fr.sii.ogham.email.message.content.ContentWithAttachments

setAttachments(List<Attachment>) - Method in class fr.sii.ogham.email.message.Email

Set the whole list of attachments.

setAttachments(List<Attachment>) - Method in class fr.sii.ogham.html.inliner.ContentWithImages

setAuthenticator(Authenticator) - Method in class fr.sii.ogham.email.builder.JavaMailBuilder

Set the authentication mechanism to use for sending email.

setBcc(String...) - Method in class fr.sii.ogham.helper.email.ExpectedEmailHeader

setBuilder(MessagingBuilder) - Method in class fr.sii.ogham.spring.xml.SpringXMLMessagingBuilder

setCc(String...) - Method in class fr.sii.ogham.helper.email.ExpectedEmailHeader

setCharset(Charset) - Method in class fr.sii.ogham.core.charset.FixedCharsetProvider

setContent(Content) - Method in interface fr.sii.ogham.core.message.content.UpdatableDecoratorContent

Set the new decorated content

setContent(Content) - Method in interface fr.sii.ogham.core.message.Message

Set the content of the message.

setContent(Content) - Method in class fr.sii.ogham.email.message.content.ContentWithAttachments

setContent(Content) - Method in class fr.sii.ogham.email.message.Email

setContent(MimePart, Multipart, Email, Content) - Method in class fr.sii.ogham.email.sender.impl.javamail.ContentWithAttachmentsHandler

setContent(MimePart, Multipart, Email, Content) - Method in interface fr.sii.ogham.email.sender.impl.javamail.JavaMailContentHandler

Read the content and add it the message.

setContent(MimePart, Multipart, Email, Content) - Method in class fr.sii.ogham.email.sender.impl.javamail.MapContentHandler

setContent(MimePart, Multipart, Email, Content) - Method in class fr.sii.ogham.email.sender.impl.javamail.MultiContentHandler

setContent(MimePart, Multipart, Email, Content) - Method in class fr.sii.ogham.email.sender.impl.javamail.StringContentHandler

setContent(SendGrid.Email, Content) - Method in class fr.sii.ogham.email.sender.impl.sendgrid.handler.MapContentHandler

setContent(SendGrid.Email, Content) - Method in class fr.sii.ogham.email.sender.impl.sendgrid.handler.MultiContentHandler

Reads the content and adds it into the email.

setContent(SendGrid.Email, Content) - Method in interface fr.sii.ogham.email.sender.impl.sendgrid.handler.SendGridContentHandler

Reads the content and adds it into the email.

setContent(SendGrid.Email, Content) - Method in class fr.sii.ogham.email.sender.impl.sendgrid.handler.StringContentHandler

Reads the content and adds it into the email.

setContent(String) - Method in class fr.sii.ogham.html.inliner.ContentWithImages

setContent(Content) - Method in class fr.sii.ogham.sms.message.Sms

setContentId(String) - Method in class fr.sii.ogham.email.attachment.Attachment

setData(BodyPart, NamedResource, Attachment) - Method in class fr.sii.ogham.email.sender.impl.javamail.FileResourceHandler

setData(BodyPart, NamedResource, Attachment) - Method in interface fr.sii.ogham.email.sender.impl.javamail.JavaMailAttachmentResourceHandler

setData(BodyPart, NamedResource, Attachment) - Method in class fr.sii.ogham.email.sender.impl.javamail.MapAttachmentResourceHandler

setData(BodyPart, NamedResource, Attachment) - Method in class fr.sii.ogham.email.sender.impl.javamail.StreamResourceHandler

setDate(Date) - Method in class fr.sii.ogham.mock.context.SimpleBean

setDescription(String) - Method in class fr.sii.ogham.email.attachment.Attachment

setDisposition(String) - Method in class fr.sii.ogham.email.attachment.Attachment

setEnvironment(Environment) - Method in class fr.sii.ogham.spring.xml.SpringXMLMessagingBuilder

setExtensionKey(String) - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Change the default property key for template resolution extension.

setFrom(EmailAddress) - Method in class fr.sii.ogham.email.message.Email

Set the sender address.

setFrom(String) - Method in class fr.sii.ogham.email.message.Email

Set the sender address as string (typical address syntax is of the form "user@host.domain" or "Personal Name <user@host.domain>").

setFrom(Sender) - Method in class fr.sii.ogham.sms.message.Sms

Set the sender of the SMS

setFrom(String) - Method in class fr.sii.ogham.sms.message.Sms

Set the sender phone number of the SMS as string.

setInterceptor(JavaMailInterceptor) - Method in class fr.sii.ogham.email.builder.JavaMailBuilder

Set an interceptor used to customize the message before sending it.

setLookup(String) - Method in class fr.sii.ogham.core.resource.ResourcePath

setName(String) - Method in class fr.sii.ogham.mock.context.SimpleBean

setNoStop(boolean) - Method in class fr.sii.ogham.sms.sender.impl.ovh.OvhOptions

setNumber(String) - Method in class fr.sii.ogham.sms.message.PhoneNumber

setOptions(TemplateLoaderOptions) - Method in class fr.sii.ogham.template.freemarker.adapter.AbstractFreeMarkerTemplateLoaderOptionsAdapter

setOptions(TemplateLoaderOptions) - Method in class fr.sii.ogham.template.freemarker.adapter.FirstSupportingResolverAdapter

setOptions(TemplateLoaderOptions) - Method in interface fr.sii.ogham.template.freemarker.adapter.TemplateLoaderAdapter

Sets the options for the adapted ITemplateResolver

setOptions(TemplateResolverOptions) - Method in class fr.sii.ogham.template.thymeleaf.adapter.AbstractTemplateResolverOptionsAdapter

setOptions(TemplateResolverOptions) - Method in class fr.sii.ogham.template.thymeleaf.adapter.FirstSupportingResolverAdapter

setOptions(TemplateResolverOptions) - Method in interface fr.sii.ogham.template.thymeleaf.adapter.TemplateResolverAdapter

Sets the options for the adapted ITemplateResolver.

setParentPathKey(String) - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Change the default property key for template resolution parent path.

setPath(String) - Method in class fr.sii.ogham.core.resource.ResourcePath

setPhoneNumber(PhoneNumber) - Method in class fr.sii.ogham.sms.message.Contact

setPropertiesBridge(PropertiesBridge) - Method in class fr.sii.ogham.spring.xml.SpringXMLMessagingBuilder

setRecipients(List<R>) - Method in interface fr.sii.ogham.core.message.capability.HasRecipients

Set the list of recipients of the message

setRecipients(List<Recipient>) - Method in class fr.sii.ogham.email.message.Email

Set the whole list of recipients.

setRecipients(List<Recipient>) - Method in class fr.sii.ogham.sms.message.Sms

Set the recipients (to) of the SMS

setResolvedPath(String) - Method in class fr.sii.ogham.core.resource.ResourcePath

setResource(NamedResource) - Method in class fr.sii.ogham.email.attachment.Attachment

setResponseTimeout(long) - Method in class fr.sii.ogham.sms.sender.impl.cloudhopper.CloudhopperOptions

setSmsCoding(SmsCoding) - Method in class fr.sii.ogham.sms.sender.impl.ovh.OvhOptions

setStringContent(String) - Method in class fr.sii.ogham.core.message.content.StringContent

setStringContent(String) - Method in interface fr.sii.ogham.core.message.content.UpdatableStringContent

Sets the new content directly as string.

setStringContent(String) - Method in class fr.sii.ogham.email.message.content.ContentWithAttachments

setSubject(String) - Method in interface fr.sii.ogham.core.message.capability.HasSubject

Set the subject of the message

setSubject(String) - Method in class fr.sii.ogham.email.message.Email

Set the subject of the mail.

setTag(String) - Method in class fr.sii.ogham.sms.sender.impl.ovh.OvhOptions

setTemplateExtensionKey(String) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Calling this method will enable different location for SMS templates from default one.

setTemplateParentPathKey(String) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Calling this method will enable different location for SMS templates from default one.

setTemplatePrefixKey(String) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Calling this method will enable different location for email templates from default one.

setTemplateSuffixKey(String) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Calling this method will enable different location for email templates from default one.

setUnbindTimeout(long) - Method in class fr.sii.ogham.sms.sender.impl.cloudhopper.CloudhopperOptions

setValue(int) - Method in class fr.sii.ogham.mock.context.SimpleBean

ShortCodeNumberFormatHandler - Class in fr.sii.ogham.sms.message.addressing.translator

Phone number handler for short codes.

ShortCodeNumberFormatHandler() - Constructor for class fr.sii.ogham.sms.message.addressing.translator.ShortCodeNumberFormatHandler

SimpleBean - Class in fr.sii.ogham.mock.context

SimpleBean(String, int, Date) - Constructor for class fr.sii.ogham.mock.context.SimpleBean

SimpleBean(String, int) - Constructor for class fr.sii.ogham.mock.context.SimpleBean

SimpleContext - Class in fr.sii.ogham.core.template.context

Simple context that stores variable substitutions into a map.

SimpleContext(String, Object) - Constructor for class fr.sii.ogham.core.template.context.SimpleContext

Initialize the variables with only one entry.

SimpleContext(Map<String, Object>) - Constructor for class fr.sii.ogham.core.template.context.SimpleContext

Initialize the variables with the provided map.

SimpleFiller - Class in fr.sii.ogham.core.filler

A simple filler that add values on the message.

SimpleFiller(String, Object) - Constructor for class fr.sii.ogham.core.filler.SimpleFiller

Initialize the filler with a single property with the value to set.

SimpleFiller(Map<String, Object>) - Constructor for class fr.sii.ogham.core.filler.SimpleFiller

Initialize the filler with several pairs of property/value to set.

SimpleResource - Class in fr.sii.ogham.core.resource

Basic implementation of a resource that simply stores a reference to the provided bytes.

SimpleResource(InputStream) - Constructor for class fr.sii.ogham.core.resource.SimpleResource

SimpleResource(byte[]) - Constructor for class fr.sii.ogham.core.resource.SimpleResource

Initialize the resource with the provided bytes.

SimpleThymeleafContextConverter - Class in fr.sii.ogham.template.thymeleaf

Simple converter that is able to handle Context and LocaleContext.

SimpleThymeleafContextConverter() - Constructor for class fr.sii.ogham.template.thymeleaf.SimpleThymeleafContextConverter

SKIP_INLINE_ALL_VALUE - Static variable in class fr.sii.ogham.html.inliner.ImageInlinerConstants

Value for skipping all inlining modes.

SKIP_INLINE_ATTR - Static variable in class fr.sii.ogham.html.inliner.ImageInlinerConstants

The attribute name to indicate the modes that are not allowed for inlining.

SMPP_PREFIX - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants

The prefix for SMPP properties

SMPP_TIMEOUT_PREFIX - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants.TimeoutConstants

The prefix for SMPP timeout properties

SmppServerException - Exception in fr.sii.ogham.helper.sms.rule

SmppServerException(String, Throwable) - Constructor for exception fr.sii.ogham.helper.sms.rule.SmppServerException

SmppServerException(String) - Constructor for exception fr.sii.ogham.helper.sms.rule.SmppServerException

SmppServerException(Throwable) - Constructor for exception fr.sii.ogham.helper.sms.rule.SmppServerException

SmppServerRule<M> - Class in fr.sii.ogham.helper.sms.rule

JUnit Rule for starting a local SMPP server for integration tests.

SmppServerRule(SmppServerSimulator<M>) - Constructor for class fr.sii.ogham.helper.sms.rule.SmppServerRule

Initialize the server with the provided port.

SmppServerSimulator<M> - Interface in fr.sii.ogham.helper.sms.rule

Sms - Class in fr.sii.ogham.sms.message

SMS message that contains the following information: The content of the SMS (see Content and sub classes for more information) The sender information (name and phone number).

Sms() - Constructor for class fr.sii.ogham.sms.message.Sms

Default constructor for using fluent API.

Sms(String, String, String...) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS as string, it will create a StringContent for you One or several recipients using only phone numbers No sender is specified.

Sms(String, PhoneNumber, PhoneNumber...) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS as string, it will create a StringContent for you The sender information (name and phone number).

Sms(String, Recipient...) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS as string, it will create a StringContent for you None, one or several recipients (name and phone number).

Sms(String, List<Recipient>) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS as string, it will create a StringContent for you The list of recipients (name and phone number).

Sms(String, Sender, String, String...) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS as string, it will create a StringContent for you The sender information (name and phone number).

Sms(String, Sender, PhoneNumber, PhoneNumber...) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS as string, it will create a StringContent for you The sender information (name and phone number).

Sms(String, Sender, Recipient...) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS as string, it will create a StringContent for you The sender information (name and phone number).

Sms(String, Sender, List<Recipient>) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS as string, it will create a StringContent for you The sender information (name and phone number).

Sms(Content, String, String...) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS (see Content and sub classes for more information) One or several recipients using only phone numbers No sender is specified.

Sms(Content, PhoneNumber, PhoneNumber...) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS (see Content and sub classes for more information) The sender information (name and phone number).

Sms(Content, Recipient...) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS (see Content and sub classes for more information) None, one or several recipients (name and phone number).

Sms(Content, List<Recipient>) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS (see Content and sub classes for more information) The list of recipients (name and phone number).

Sms(Content, Sender, String, String...) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS (see Content and sub classes for more information) The sender information (name and phone number).

Sms(Content, Sender, PhoneNumber, PhoneNumber...) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS (see Content and sub classes for more information) The sender information (name and phone number).

Sms(Content, Sender, Recipient...) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS (see Content and sub classes for more information) The sender information (name and phone number).

Sms(Content, Sender, List<Recipient>) - Constructor for class fr.sii.ogham.sms.message.Sms

Initialize the SMS with the following information: The content of the SMS (see Content and sub classes for more information) The sender information (name and phone number).

SMS_CODING_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.OvhConstants

The key for OVH option smsConding

SmsBuilder - Class in fr.sii.ogham.sms.builder

Specialized builder for SMS sender.

SmsBuilder() - Constructor for class fr.sii.ogham.sms.builder.SmsBuilder

SmsCoding - Enum in fr.sii.ogham.sms.sender.impl.ovh

SmsConstants - Class in fr.sii.ogham.sms

SmsConstants.OvhConstants - Class in fr.sii.ogham.sms

Specialized constants for Ovh REST API

SmsConstants.SmppConstants - Class in fr.sii.ogham.sms

Specialized constants for SMPP protocol

SmsConstants.SmppConstants.CloudhopperConstants - Class in fr.sii.ogham.sms

Specialized constants for Cloudhopper SMPP implementation

SmsConstants.SmppConstants.TimeoutConstants - Class in fr.sii.ogham.sms

SmsConstants.SmsGlobal - Class in fr.sii.ogham.sms

Specialized constants for smsglobal API

SmsConstants.TemplateConstants - Class in fr.sii.ogham.sms

SMSGLOBAL_REST_API_KEY_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmsGlobal

The key for smsglobal REST API key

SmsglobalRestSender - Class in fr.sii.ogham.sms.sender.impl

Implementation that sends a HTTP REST request on the smsglobal REST API .

SmsglobalRestSender() - Constructor for class fr.sii.ogham.sms.sender.impl.SmsglobalRestSender

SmsSender - Class in fr.sii.ogham.sms.sender

Specialization of MultiImplementationSender for managing emails using several implementations.

SmsSender() - Constructor for class fr.sii.ogham.sms.sender.SmsSender

SmsSender(Condition<Message>, MessageSender) - Constructor for class fr.sii.ogham.sms.sender.SmsSender

SmsSender(Map<Condition<Message>, MessageSender>) - Constructor for class fr.sii.ogham.sms.sender.SmsSender

SmsSenderConverter - Class in fr.sii.ogham.core.util.converter

Converts the provided object into an SmsSenderConverter.

SmsSenderConverter() - Constructor for class fr.sii.ogham.core.util.converter.SmsSenderConverter

SNEDGRID_PROPERTIES_PREFIX - Static variable in class fr.sii.ogham.email.EmailConstants.SendGridConstants

The prefix for SendGrid properties

SplitSms - Class in fr.sii.ogham.helper.sms

Represents a SMS that has been split into several parts in order to be sent.

SplitSms(List<ExpectedSms>) - Constructor for class fr.sii.ogham.helper.sms.SplitSms

Initialize with the provided parts.

SplitSms(ExpectedSms...) - Constructor for class fr.sii.ogham.helper.sms.SplitSms

Initialize with the provided parts.

SplitSms(ExpectedAddressedPhoneNumber, ExpectedAddressedPhoneNumber, String...) - Constructor for class fr.sii.ogham.helper.sms.SplitSms

Initialize several parts by reusing the sender and receiver numbers.

SpringMailSender - Class in fr.sii.ogham.email.sender.impl

SpringMailSender() - Constructor for class fr.sii.ogham.email.sender.impl.SpringMailSender

SpringXMLMessagingBuilder - Class in fr.sii.ogham.spring.xml

Decorator builder used for helping integration with Spring.

SpringXMLMessagingBuilder() - Constructor for class fr.sii.ogham.spring.xml.SpringXMLMessagingBuilder

Default constructor to let the user use properties instead of constructor

SpringXMLMessagingBuilder(Environment) - Constructor for class fr.sii.ogham.spring.xml.SpringXMLMessagingBuilder

Constructor with the required environment dependency

SpringXMLMessagingBuilder(Environment, PropertiesBridge) - Constructor for class fr.sii.ogham.spring.xml.SpringXMLMessagingBuilder

Constructor with the required environment dependency

SpringXMLMessagingBuilder(Environment, PropertiesBridge, MessagingBuilder) - Constructor for class fr.sii.ogham.spring.xml.SpringXMLMessagingBuilder

Constructor with the required environment dependency, optional bridge and optional builder.

start() - Method in class fr.sii.ogham.helper.sms.cloudhopper.CloudhopperSMPPServer

start() - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServer

start() - Method in interface fr.sii.ogham.helper.sms.rule.SmppServerSimulator

stop() - Method in class fr.sii.ogham.helper.sms.cloudhopper.CloudhopperSMPPServer

stop() - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServer

stop() - Method in class fr.sii.ogham.helper.sms.jsmpp.JSMPPServerSimulator

stop() - Method in interface fr.sii.ogham.helper.sms.rule.SmppServerSimulator

StreamResourceHandler - Class in fr.sii.ogham.email.sender.impl.javamail

Implementation that is able to handle ByteResource.

StreamResourceHandler(MimeTypeProvider) - Constructor for class fr.sii.ogham.email.sender.impl.javamail.StreamResourceHandler

StringContent - Class in fr.sii.ogham.core.message.content

Represent a string content.

StringContent(String) - Constructor for class fr.sii.ogham.core.message.content.StringContent

Initialize the content with the string.

StringContentHandler - Class in fr.sii.ogham.email.sender.impl.javamail

Content handler that adds string contents (HTML, text, ...).

StringContentHandler(MimeTypeProvider, CharsetProvider) - Constructor for class fr.sii.ogham.email.sender.impl.javamail.StringContentHandler

StringContentHandler - Class in fr.sii.ogham.email.sender.impl.sendgrid.handler

Content handler that puts plain text or HTML content into email to be sent through SendGrid.

StringContentHandler(MimeTypeProvider) - Constructor for class fr.sii.ogham.email.sender.impl.sendgrid.handler.StringContentHandler

Constructor.

StringResolverAdapter - Class in fr.sii.ogham.template.freemarker.adapter

Adapter that converts general StringResourceResolver into FreeMarker specific StringTemplateLoader.

StringResolverAdapter() - Constructor for class fr.sii.ogham.template.freemarker.adapter.StringResolverAdapter

StringResolverAdapter - Class in fr.sii.ogham.template.thymeleaf.adapter

Adapter that converts general StringResourceResolver into Thymeleaf specific StringTemplateResolver.

StringResolverAdapter() - Constructor for class fr.sii.ogham.template.thymeleaf.adapter.StringResolverAdapter

StringResourceResolver - Class in fr.sii.ogham.core.resource.resolver

Resource resolver that just wraps the resource string into a Resource

StringResourceResolver(String...) - Constructor for class fr.sii.ogham.core.resource.resolver.StringResourceResolver

StringResourceResolver - Class in fr.sii.ogham.template.thymeleaf.resolver

StringResourceResolver() - Constructor for class fr.sii.ogham.template.thymeleaf.resolver.StringResourceResolver

StringTemplateContent - Class in fr.sii.ogham.core.message.content

Content that contains a template.

StringTemplateContent(String, Context) - Constructor for class fr.sii.ogham.core.message.content.StringTemplateContent

Initialize the content with the template and the context.

StringTemplateContent(String, Object) - Constructor for class fr.sii.ogham.core.message.content.StringTemplateContent

Shortcut for directly using any object as source for variable substitutions.

StringTemplateResolver - Class in fr.sii.ogham.template.thymeleaf.resolver

Template resolver that provides the template directly using the template string (nothing to load or resolve).

StringTemplateResolver() - Constructor for class fr.sii.ogham.template.thymeleaf.resolver.StringTemplateResolver

StringUtils - Class in fr.sii.ogham.core.util

Helper class for string manipulation: Join an array or list into a string with a delimiter This work can be done by several libraries.

subject(String) - Method in interface fr.sii.ogham.core.message.capability.HasSubjectFluent

Set the subject of the message

subject(String) - Method in class fr.sii.ogham.email.message.Email

Set the subject of the mail.

subject - Variable in class fr.sii.ogham.helper.email.ExpectedEmailHeader

The expected subject

SubjectFiller - Class in fr.sii.ogham.core.filler

Message filler that provides a subject to the message.

SubjectFiller(SubjectProvider) - Constructor for class fr.sii.ogham.core.filler.SubjectFiller

SubjectProvider - Interface in fr.sii.ogham.core.subject.provider

Interface for all subject providers.

SUFFIX_PROPERTY - Static variable in class fr.sii.ogham.email.EmailConstants.TemplateConstants

The property key for the suffix of the template resolution for emails only

SUFFIX_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.TemplateConstants

The property key for the suffix of the template resolution for emails only

SUFFIX_PROPERTY - Static variable in class fr.sii.ogham.template.TemplateConstants

The property key for the suffix of the template resolution

supports(String) - Method in class fr.sii.ogham.core.resource.resolver.AbstractPrefixedLookupPathResolver

supports(String) - Method in class fr.sii.ogham.core.resource.resolver.DefaultResourceResolver

supports(String) - Method in class fr.sii.ogham.core.resource.resolver.FirstSupportingResourceResolver

supports(String) - Method in class fr.sii.ogham.core.resource.resolver.RelativeResolver

supports(String) - Method in interface fr.sii.ogham.core.resource.resolver.ResourceResolver

Indicates if the resource path can be handled by this resource resolver or not.

supports(Message) - Method in interface fr.sii.ogham.core.sender.ConditionalSender

Indicates if the implementation is able to handle the provided message.

supports(Message) - Method in class fr.sii.ogham.core.sender.ContentTranslatorSender

supports(Message) - Method in class fr.sii.ogham.core.sender.FillerSender

supports(Message) - Method in class fr.sii.ogham.core.sender.MultiImplementationSender

supports(Message) - Method in class fr.sii.ogham.email.sender.AttachmentResourceTranslatorSender

supports(PhoneNumber) - Method in class fr.sii.ogham.sms.message.addressing.translator.AlphanumericCodeNumberFormatHandler

supports(PhoneNumber) - Method in class fr.sii.ogham.sms.message.addressing.translator.DefaultHandler

supports(PhoneNumber) - Method in class fr.sii.ogham.sms.message.addressing.translator.InternationalNumberFormatHandler

supports(PhoneNumber) - Method in interface fr.sii.ogham.sms.message.addressing.translator.PhoneNumberHandler

Indicates if the phone number can be handled by the translator.

supports(PhoneNumber) - Method in class fr.sii.ogham.sms.message.addressing.translator.ShortCodeNumberFormatHandler

supports(Message) - Method in class fr.sii.ogham.sms.sender.impl.PhoneNumberTranslatorSender

supports(ResourceResolver) - Method in class fr.sii.ogham.template.freemarker.adapter.ClassPathResolverAdapter

supports(ResourceResolver) - Method in class fr.sii.ogham.template.freemarker.adapter.FileResolverAdapter

supports(ResourceResolver) - Method in class fr.sii.ogham.template.freemarker.adapter.FirstSupportingResolverAdapter

supports(ResourceResolver) - Method in class fr.sii.ogham.template.freemarker.adapter.StringResolverAdapter

supports(ResourceResolver) - Method in interface fr.sii.ogham.template.freemarker.adapter.TemplateLoaderAdapter

Is the adapter able to handle the general resolver.

supports(ResourceResolver) - Method in class fr.sii.ogham.template.thymeleaf.adapter.ClassPathResolverAdapter

supports(ResourceResolver) - Method in class fr.sii.ogham.template.thymeleaf.adapter.FileResolverAdapter

supports(ResourceResolver) - Method in class fr.sii.ogham.template.thymeleaf.adapter.FirstSupportingResolverAdapter

supports(ResourceResolver) - Method in class fr.sii.ogham.template.thymeleaf.adapter.StringResolverAdapter

supports(ResourceResolver) - Method in interface fr.sii.ogham.template.thymeleaf.adapter.TemplateResolverAdapter

Is the adapter can handle the general resolver.

SYSTEMID_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants

The key for SMPP system id property

T

TAG_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.OvhConstants

The key for OVH option tag

TemplateBuilder - Class in fr.sii.ogham.core.builder

A specialized builder for template management.

TemplateBuilder() - Constructor for class fr.sii.ogham.core.builder.TemplateBuilder

TemplateConstants - Class in fr.sii.ogham.template

TemplateContent - Class in fr.sii.ogham.core.message.content

Content that points to a template.

TemplateContent(String, Context) - Constructor for class fr.sii.ogham.core.message.content.TemplateContent

Initialize the content with the path to the template and the context.

TemplateContent(String, Object) - Constructor for class fr.sii.ogham.core.message.content.TemplateContent

Shortcut for directly using any object as source for variable substitutions.

TemplateContentTranslator - Class in fr.sii.ogham.core.translator.content

Translator that handles TemplateContent.

TemplateContentTranslator(TemplateParser, VariantResolver) - Constructor for class fr.sii.ogham.core.translator.content.TemplateContentTranslator

TemplateEngineDetector - Interface in fr.sii.ogham.core.template.detector

Defines the contract for template engine detection.

TemplateLoaderAdapter - Interface in fr.sii.ogham.template.freemarker.adapter

Adapter that provides the FreeMarker specific TemplateLoader from the general ResourceResolver.

TemplateLoaderOptions - Class in fr.sii.ogham.template.freemarker

TemplateLoaderOptions() - Constructor for class fr.sii.ogham.template.freemarker.TemplateLoaderOptions

TemplateParser - Interface in fr.sii.ogham.core.template.parser

Interface that defines the general contract for template parsing.

TemplateParserBuilder - Interface in fr.sii.ogham.core.builder

Define a builder for a template engine implementation.

TemplateResolverAdapter - Interface in fr.sii.ogham.template.thymeleaf.adapter

Adapter that provides the Thymeleaf specific ITemplateResolver from the general ResourceResolver.

TemplateResolverOptions - Class in fr.sii.ogham.template.thymeleaf

TemplateResolverOptions() - Constructor for class fr.sii.ogham.template.thymeleaf.TemplateResolverOptions

TemplateVariantContent - Class in fr.sii.ogham.core.message.content

Content that points to a template variant.

TemplateVariantContent(String, Variant, Context) - Constructor for class fr.sii.ogham.core.message.content.TemplateVariantContent

TemplateVariantContent(String, Variant, Object) - Constructor for class fr.sii.ogham.core.message.content.TemplateVariantContent

TestSmppServerHandler - Class in fr.sii.ogham.helper.sms.cloudhopper

TestSmppServerHandler(String, String) - Constructor for class fr.sii.ogham.helper.sms.cloudhopper.TestSmppServerHandler

TextPrefixSubjectProvider - Class in fr.sii.ogham.core.subject.provider

Provider that analyzes the content of the message.

TextPrefixSubjectProvider() - Constructor for class fr.sii.ogham.core.subject.provider.TextPrefixSubjectProvider

TextPrefixSubjectProvider(String) - Constructor for class fr.sii.ogham.core.subject.provider.TextPrefixSubjectProvider

thymeleafConfigurer(SpringTemplateEngine) - Method in class fr.sii.ogham.spring.autoconfigure.OghamAutoConfiguration.OghamThymeleafConfiguration

ThymeLeafConfigurer - Class in fr.sii.ogham.spring.config

ThymeLeafConfigurer(SpringTemplateEngine) - Constructor for class fr.sii.ogham.spring.config.ThymeLeafConfigurer

ThymeleafContextConverter - Interface in fr.sii.ogham.template.thymeleaf

Convert a Context abstraction used for all template engines into a Context specific to Thymeleaf.

ThymeLeafFirstSupportingTemplateResolver - Class in fr.sii.ogham.template.thymeleaf

Decorator resolver that is able to manage ResourcePath.

ThymeLeafFirstSupportingTemplateResolver(FirstSupportingResourceResolver, FirstSupportingResolverAdapter) - Constructor for class fr.sii.ogham.template.thymeleaf.ThymeLeafFirstSupportingTemplateResolver

ThymeleafParser - Class in fr.sii.ogham.template.thymeleaf

Implementation for Thymeleaf template engine.

ThymeleafParser(TemplateEngine, ThymeleafContextConverter) - Constructor for class fr.sii.ogham.template.thymeleaf.ThymeleafParser

ThymeleafParser(TemplateEngine) - Constructor for class fr.sii.ogham.template.thymeleaf.ThymeleafParser

ThymeleafTemplateDetector - Class in fr.sii.ogham.template.thymeleaf

Detector that reads the content of the template.

ThymeleafTemplateDetector() - Constructor for class fr.sii.ogham.template.thymeleaf.ThymeleafTemplateDetector

ThymeleafTemplateParserBuilder - Class in fr.sii.ogham.template.thymeleaf.builder

Specialized builder for Thymeleaf template engine.

ThymeleafTemplateParserBuilder() - Constructor for class fr.sii.ogham.template.thymeleaf.builder.ThymeleafTemplateParserBuilder

tika() - Method in class fr.sii.ogham.core.builder.MimetypeProviderBuilder

TikaProvider - Class in fr.sii.ogham.core.mimetype

Mime Type detection based on Apache Tika.

TikaProvider() - Constructor for class fr.sii.ogham.core.mimetype.TikaProvider

Initialize the provider with default Tika instance and configuration.

TikaProvider(Tika, boolean) - Constructor for class fr.sii.ogham.core.mimetype.TikaProvider

Initialize the provider with the specified Tika instance.

to(String) - Method in interface fr.sii.ogham.core.message.capability.HasToFluent

Add a recipient for the message

to(String) - Method in class fr.sii.ogham.email.message.Email

Add a "to" recipient address.

to(EmailAddress) - Method in class fr.sii.ogham.email.message.Email

Add a "to" recipient address.

to - Variable in class fr.sii.ogham.helper.email.ExpectedEmailHeader

The expected list of recipients for the "to" field

to(PhoneNumber) - Method in class fr.sii.ogham.sms.message.Sms

Add a recipient specifying the phone number.

to(String) - Method in class fr.sii.ogham.sms.message.Sms

Add a recipient specifying the phone number as string.

to(String, PhoneNumber) - Method in class fr.sii.ogham.sms.message.Sms

Add a recipient specifying the name and the phone number.

to(Recipient) - Method in class fr.sii.ogham.sms.message.Sms

Add a recipient.

toByteArray(InputStream) - Static method in class fr.sii.ogham.core.util.IOUtils

Get the contents of an InputStream as a byte[].

toRecipient(List<String>) - Static method in class fr.sii.ogham.email.message.Email

Converts a list of string to a list of recipients.

toRecipient(EmailAddress[]) - Static method in class fr.sii.ogham.email.message.Email

Converts a list of EmailAddress to a list of recipients.

toRecipient(String[]) - Static method in class fr.sii.ogham.email.message.Email

Converts a list of string to a list of recipients.

toRecipient(PhoneNumber[]) - Static method in class fr.sii.ogham.sms.message.Sms

Converts a list of phone numbers to a list of recipients.

toRecipient(String[]) - Static method in class fr.sii.ogham.sms.message.Sms

Converts a list of string to a list of recipients.

toString() - Method in class fr.sii.ogham.core.condition.CompositeCondition

toString() - Method in class fr.sii.ogham.core.condition.FixedCondition

toString() - Method in class fr.sii.ogham.core.condition.RequiredClassCondition

toString() - Method in class fr.sii.ogham.core.condition.RequiredPropertyCondition

toString() - Method in class fr.sii.ogham.core.filler.PropertiesFiller

toString() - Method in class fr.sii.ogham.core.filler.SimpleFiller

toString() - Method in class fr.sii.ogham.core.message.content.MultiContent

toString() - Method in class fr.sii.ogham.core.message.content.StringContent

toString() - Method in class fr.sii.ogham.core.message.content.TemplateContent

toString() - Method in class fr.sii.ogham.core.message.content.TemplateVariantContent

toString() - Method in class fr.sii.ogham.core.mimetype.TikaProvider

toString() - Method in class fr.sii.ogham.core.resource.ResourcePath

toString() - Method in class fr.sii.ogham.core.sender.ContentTranslatorSender

toString() - Method in class fr.sii.ogham.core.sender.FillerSender

toString() - Method in class fr.sii.ogham.core.template.context.BeanContext

toString() - Method in class fr.sii.ogham.core.translator.content.EveryContentTranslator

toString() - Method in class fr.sii.ogham.core.translator.content.MultiContentTranslator

toString() - Method in class fr.sii.ogham.core.translator.content.TemplateContentTranslator

toString() - Method in class fr.sii.ogham.core.translator.resource.EveryResourceTranslator

toString() - Method in class fr.sii.ogham.core.translator.resource.LookupResourceTranslator

toString(InputStream) - Static method in class fr.sii.ogham.core.util.IOUtils

Get the contents of an InputStream as a String using the default character encoding of the platform.

toString() - Method in class fr.sii.ogham.email.attachment.Attachment

toString() - Method in class fr.sii.ogham.email.message.content.ContentWithAttachments

toString() - Method in class fr.sii.ogham.email.message.Email

toString() - Method in class fr.sii.ogham.email.message.EmailAddress

toString() - Method in class fr.sii.ogham.email.message.Recipient

toString() - Method in class fr.sii.ogham.email.sender.AttachmentResourceTranslatorSender

toString() - Method in class fr.sii.ogham.email.sender.EmailSender

toString() - Method in class fr.sii.ogham.email.sender.impl.JavaMailSender

toString() - Method in class fr.sii.ogham.helper.sms.ExpectedAddressedPhoneNumber

toString() - Method in class fr.sii.ogham.mock.context.NestedBean

toString() - Method in class fr.sii.ogham.mock.context.SimpleBean

toString() - Method in class fr.sii.ogham.sms.message.addressing.AddressedPhoneNumber

toString() - Method in class fr.sii.ogham.sms.message.Contact

toString() - Method in class fr.sii.ogham.sms.message.PhoneNumber

toString() - Method in class fr.sii.ogham.sms.message.Sms

toString() - Method in class fr.sii.ogham.sms.sender.impl.CloudhopperSMPPSender

toString() - Method in class fr.sii.ogham.sms.sender.impl.PhoneNumberTranslatorSender

toString() - Method in class fr.sii.ogham.sms.sender.impl.SmsglobalRestSender

toString() - Method in class fr.sii.ogham.sms.sender.SmsSender

toString() - Method in class fr.sii.ogham.template.freemarker.FreeMarkerParser

toString() - Method in class fr.sii.ogham.template.thymeleaf.ThymeleafParser

translate(Content) - Method in interface fr.sii.ogham.core.translator.content.ContentTranslator

Transform the content into a new one.

translate(Content) - Method in class fr.sii.ogham.core.translator.content.DefaultContentTranslator

translate(Content) - Method in class fr.sii.ogham.core.translator.content.EveryContentTranslator

translate(Content) - Method in class fr.sii.ogham.core.translator.content.MultiContentTranslator

translate(Content) - Method in class fr.sii.ogham.core.translator.content.TemplateContentTranslator

translate(Resource) - Method in interface fr.sii.ogham.core.translator.resource.AttachmentResourceTranslator

Transform the resource into a new one.

translate(Resource) - Method in class fr.sii.ogham.core.translator.resource.DefaultResourceTranslator

translate(Resource) - Method in class fr.sii.ogham.core.translator.resource.EveryResourceTranslator

translate(Resource) - Method in class fr.sii.ogham.core.translator.resource.LookupResourceTranslator

translate(Content) - Method in class fr.sii.ogham.html.translator.ExpandCssPropertiesTranslator

translate(Content) - Method in class fr.sii.ogham.html.translator.InlineCssTranslator

translate(Content) - Method in class fr.sii.ogham.html.translator.InlineImageTranslator

translate(Content) - Method in class fr.sii.ogham.html.translator.XHTMLTranslator

translate(PhoneNumber) - Method in class fr.sii.ogham.sms.message.addressing.translator.AbstractFixedPhoneNumberHandler

translate(PhoneNumber) - Method in class fr.sii.ogham.sms.message.addressing.translator.CompositePhoneNumberTranslator

translate(PhoneNumber) - Method in class fr.sii.ogham.sms.message.addressing.translator.FixedPhoneNumberTranslator

translate(PhoneNumber) - Method in interface fr.sii.ogham.sms.message.addressing.translator.PhoneNumberTranslator

Translates a given PhoneNumber to an AddressedPhoneNumber , deducing its TON and NPI.

TypeOfNumber - Enum in fr.sii.ogham.sms.message.addressing

TON as described in GSM 03.40.

U

UNBIND_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants.TimeoutConstants

The key of property for time to wait for an unbind response

UnknownVariantException - Exception in fr.sii.ogham.template.exception

UnknownVariantException(String, String, Context, Variant) - Constructor for exception fr.sii.ogham.template.exception.UnknownVariantException

UpdatableDecoratorContent - Interface in fr.sii.ogham.core.message.content

Interface that allows to update the decorated content.

UpdatableStringContent - Interface in fr.sii.ogham.core.message.content

Marker interface that allows to update the content.

useAllDefaults() - Method in class fr.sii.ogham.core.builder.MessagingBuilder

Tells the builder to use all default behavior and values.

useAllDefaults(Properties) - Method in class fr.sii.ogham.core.builder.MessagingBuilder

Tells the builder to use all default behavior and values.

useDefaultLookups() - Method in class fr.sii.ogham.email.builder.AttachmentResourceTranslatorBuilder

Tells the builder to use the default lookup mapping: "classpath" for searching attachment into the classpath "file" for searching attachment on the file system "" when no lookup is defined.

useDefaultResolvers() - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Tells the builder to use the default template resolvers: Resolver that is able to handle classpath resolution ( ClassPathResolver).

useDefaults() - Method in class fr.sii.ogham.core.builder.ContentTranslatorBuilder

Tells the builder to use all default behaviors and values.

useDefaults(Properties) - Method in class fr.sii.ogham.core.builder.ContentTranslatorBuilder

Tells the builder to use all default behaviors and values.

useDefaults() - Method in class fr.sii.ogham.core.builder.FirstSupportingResourceResolverBuilder

Tells the builder to use the default template resolvers: Resolver that is able to handle classpath resolution ( ClassPathResolver).

useDefaults(String...) - Method in class fr.sii.ogham.core.builder.MessageFillerBuilder

Tells the builder to use all default behaviors and values: Fill messages with system properties Generate subject from HTML title or first textual line starting with "Subject:" Configuration values come from system properties.

useDefaults(Properties, String...) - Method in class fr.sii.ogham.core.builder.MessageFillerBuilder

Tells the builder to use all default behaviors and values: Fill messages with provided properties Generate subject from HTML title or first textual line starting with "Subject:" Configuration values come from provided properties.

useDefaults() - Method in class fr.sii.ogham.core.builder.MimetypeProviderBuilder

useDefaults() - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Tells the builder to use all default behaviors and values.

useDefaults(Properties) - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Tells the builder to use all default behaviors and values.

useDefaults() - Method in class fr.sii.ogham.email.builder.AttachmentResourceTranslatorBuilder

Tells the builder to use all default behaviors and values.

useDefaults() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Tells the builder to use all default behaviors and values: Uses Java mail default behaviors and values Registers Java mail API implementation Enables automatic filling of message based on configuration properties Enables templating support Enables attachment features (see EmailBuilder.withAttachmentFeatures()) Configuration values come from system properties.

useDefaults(Properties) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Tells the builder to use all default behaviors and values: Uses Java mail default behaviors and values Registers Java mail API implementation Enables automatic filling of message based on configuration properties Enables templating support Enables attachment features (see EmailBuilder.withAttachmentFeatures()) Configuration values come from provided properties.

useDefaults() - Method in class fr.sii.ogham.email.builder.JavaMailBuilder

Tells the builder to use all default behaviors and values: Use the system properties Register Mime Type detection using MimeMagic library Register default Mime Type (text/plain) Handle MultiContent Handle StringContent Handle ByteResource Handle FileResource

useDefaults(Properties) - Method in class fr.sii.ogham.email.builder.JavaMailBuilder

Tells the builder to use all default behaviors and values: Use the provided properties Register Mime Type detection using MimeMagic library Register default Mime Type (text/plain) Handle MultiContent Handle StringContent Handle ByteResource Handle FileResource

useDefaults() - Method in class fr.sii.ogham.email.builder.SendGridBuilder

Tells the builder to use all default behaviors and values: Use the system properties for credentials Register Mime Type detection using MimeMagic library Register default Mime Type (text/plain) Handle MultiContent Handle StringContent

useDefaults(Properties) - Method in class fr.sii.ogham.email.builder.SendGridBuilder

Tells the builder to use all default behaviors and values: Use the provided properties for credentials Register Mime Type detection using MimeMagic library Register default Mime Type (text/plain) Handle MultiContent Handle StringContent

useDefaults() - Method in class fr.sii.ogham.sms.builder.CloudhopperSMPPBuilder

Tells the builder to use all default behaviors and values: Use the system properties Create configuration for SMPP session based on system properties Create Cloudhopper options based on system properties

useDefaults(Properties) - Method in class fr.sii.ogham.sms.builder.CloudhopperSMPPBuilder

Tells the builder to use all default behaviors and values: Use the provided properties Create configuration for SMPP session based on provided properties Create Cloudhopper options based on provided properties

useDefaults() - Method in class fr.sii.ogham.sms.builder.DefaultPhoneNumberTranslatorBuilder

useDefaults(Properties) - Method in class fr.sii.ogham.sms.builder.OvhSmsBuilder

Tells the builder to use all default behaviors and values: Use the provided properties Initialize OVH authentication using provided properties Initialize OVH options using provided properties

useDefaults() - Method in interface fr.sii.ogham.sms.builder.PhoneNumberTranslatorBuilder

Tells the builder to use default values and behaviors.

useDefaults() - Method in class fr.sii.ogham.sms.builder.RecipientPhoneNumberTranslatorBuilder

useDefaults() - Method in class fr.sii.ogham.sms.builder.SenderPhoneNumberTranslatorBuilder

useDefaults() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Tells the builder to use all default behaviors and values: Registers OVH HTTP API implementation Enables automatic filling of message based on configuration properties Enables templating support Configuration values come from system properties.

useDefaults(Properties) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Tells the builder to use all default behaviors and values: Registers OVH HTTP API implementation Enables automatic filling of message based on configuration properties Enables templating support Configuration values come from provided properties.

useEmailDefaults() - Method in class fr.sii.ogham.core.builder.MessagingBuilder

Tells the builder to use default behaviors and values for email sender.

useEmailDefaults(Properties) - Method in class fr.sii.ogham.core.builder.MessagingBuilder

Tells the builder to use the default behaviors and values for email sender.

USERNAME - Static variable in class fr.sii.ogham.email.EmailConstants.SendGridConstants

The property key for SendGrid user name

UsernamePasswordAuthenticator - Class in fr.sii.ogham.email.sender.impl.javamail

Basic authenticator that uses the provided username and password.

UsernamePasswordAuthenticator(String, String) - Constructor for class fr.sii.ogham.email.sender.impl.javamail.UsernamePasswordAuthenticator

useSmsDefaults() - Method in class fr.sii.ogham.core.builder.MessagingBuilder

Tells the builder to use default behaviors and values for SMS sender.

useSmsDefaults(Properties) - Method in class fr.sii.ogham.core.builder.MessagingBuilder

Tells the builder to use the default behaviors and values for SMS sender.

UUIDGenerator - Class in fr.sii.ogham.core.id.generator

UUIDGenerator() - Constructor for class fr.sii.ogham.core.id.generator.UUIDGenerator

V

value() - Method in enum fr.sii.ogham.sms.message.addressing.NumberingPlanIndicator

Get the byte value of the enum constant.

value() - Method in enum fr.sii.ogham.sms.message.addressing.TypeOfNumber

Get the byte value of the enum constant.

valueOf(String) - Static method in enum fr.sii.ogham.core.message.content.EmailVariant

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum fr.sii.ogham.core.util.http.HttpStatus

Returns the enum constant of this type with the specified name.

valueOf(int) - Static method in enum fr.sii.ogham.core.util.http.HttpStatus

valueOf(String) - Static method in enum fr.sii.ogham.email.message.RecipientType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum fr.sii.ogham.sms.message.addressing.NumberingPlanIndicator

Returns the enum constant of this type with the specified name.

valueOf(byte) - Static method in enum fr.sii.ogham.sms.message.addressing.NumberingPlanIndicator

Get the NumberingPlanIdentification based on the specified byte value representation.

valueOf(String) - Static method in enum fr.sii.ogham.sms.message.addressing.TypeOfNumber

Returns the enum constant of this type with the specified name.

valueOf(byte) - Static method in enum fr.sii.ogham.sms.message.addressing.TypeOfNumber

Get the TypeOfNumber based on the specified byte value representation.

valueOf(String) - Static method in enum fr.sii.ogham.sms.sender.impl.ovh.SmsCoding

Returns the enum constant of this type with the specified name.

values() - Static method in enum fr.sii.ogham.core.message.content.EmailVariant

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum fr.sii.ogham.core.util.http.HttpStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum fr.sii.ogham.email.message.RecipientType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum fr.sii.ogham.sms.message.addressing.NumberingPlanIndicator

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum fr.sii.ogham.sms.message.addressing.TypeOfNumber

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum fr.sii.ogham.sms.sender.impl.ovh.SmsCoding

Returns an array containing the constants of this enum type, in the order they are declared.

Variant - Interface in fr.sii.ogham.core.message.content

Just a marker interface

VariantResolutionException - Exception in fr.sii.ogham.template.exception

VariantResolutionException(String, String, Context, Variant) - Constructor for exception fr.sii.ogham.template.exception.VariantResolutionException

VariantResolver - Interface in fr.sii.ogham.template.common.adapter

Converts the general variant concept into the real path to the template file.

W

WINDOW_MONITOR_INTERVAL_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants

The key for SMPP window monitor interval property

WINDOW_SIZE_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants

The key for SMPP window size property

WINDOW_WAIT_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants.TimeoutConstants

The key of property for timeout for

withApiKey(String) - Method in class fr.sii.ogham.email.builder.SendGridBuilder

Configures the builder to create senders that connect to SendGrid using the provided API key.

withAttachmentFeatures() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Enable attachment features like attachment resolution based on lookup mapping.

withAttachmentFeatures(AttachmentResourceTranslatorBuilder) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Enable attachment features using the provided translator builder.

withAuthParams(OvhAuthParams) - Method in class fr.sii.ogham.sms.builder.OvhSmsBuilder

Set the authentication parameters (OVH account, login and password).

withAutoFilling(MessageFillerBuilder) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Enables automatic filling of emails with values that come from multiple sources.

withAutoFilling(Properties, String...) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Enables automatic filling of emails with values that come from multiple sources: Fill email with values that come from provided configuration properties.

withAutoFilling(Properties) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Enables automatic filling of emails with values that come from multiple sources: Fill email with values that come from provided configuration properties.

withAutoFilling() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Enables automatic filling of emails with values that come from multiple sources: Fill email with values that come from system configuration properties.

withAutoFilling(MessageFillerBuilder) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enables automatic filling of SMS with values that come from multiple sources.

withAutoFilling(Properties, String...) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enables filling of SMS with values that comes from provided configuration properties.

withAutoFilling(Properties) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enables filling of SMS with values that comes from provided configuration properties.

withAutoFilling() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enables filling of SMS with values that comes from system configuration properties.

withClient(SendGridClient) - Method in class fr.sii.ogham.email.builder.SendGridBuilder

Sets an alternative SendGridClient instance to be used.

withCloudhopper(Properties) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enable Cloudhoppder SMPP implementation.

withConfiguration(Configuration) - Method in class fr.sii.ogham.template.freemarker.builder.FreeMarkerTemplateParserBuilder

By default the builder uses the a FreeMarkerFirstSupportingTemplateLoader in a default configuration.

withConfigurationFiller(Properties, String...) - Method in class fr.sii.ogham.core.builder.MessageFillerBuilder

Enables filling of messages with values that comes from provided configuration properties.

withConfigurationFiller(String...) - Method in class fr.sii.ogham.core.builder.MessageFillerBuilder

Enables filling of messages with values that comes from system configuration properties.

withCredentials(String, String) - Method in class fr.sii.ogham.email.builder.SendGridBuilder

Configures the builder to create senders that connect to SendGrid using the provided credentials.

withEmail() - Method in class fr.sii.ogham.core.builder.MessagingBuilder

Tells the builder to activate the email sender.

withExtension(String) - Method in class fr.sii.ogham.core.builder.FirstSupportingResourceResolverBuilder

Set the extension for resolution lookup.

withExtension(String) - Method in class fr.sii.ogham.core.builder.TemplateBuilder

withFirstResourceResolver(FirstSupportingResourceResolver) - Method in class fr.sii.ogham.template.freemarker.builder.FreeMarkerTemplateParserBuilder

To link our TemplateLoaderAdapters with our ResourceResolver, we need a FirstSupportingResourceResolver.

withFirstResourceResolver(FirstSupportingResourceResolver) - Method in class fr.sii.ogham.template.thymeleaf.builder.ThymeleafTemplateParserBuilder

To link our TemplateResolverAdapters with our ResourceResolver, we need a FirstSupportingResourceResolver.

withFreeMarker() - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Enable FreeMarker template engine.

withInlining() - Method in class fr.sii.ogham.core.builder.ContentTranslatorBuilder

Enable the management of resource inlining: Inline CSS files into the HTML content Inline image files into the HTML content This method is automatically called when calling ContentTranslatorBuilder.useDefaults().

withJavaMail(Properties) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Enable Java Mail API implementation.

withMultiContentSupport() - Method in class fr.sii.ogham.core.builder.ContentTranslatorBuilder

Enable the management of multi-content messages (like email for example).

withOptions(CloudhopperOptions) - Method in class fr.sii.ogham.sms.builder.CloudhopperSMPPBuilder

Provide your own options.

withOptions(OvhOptions) - Method in class fr.sii.ogham.sms.builder.OvhSmsBuilder

Set the OVH options.

withoutTemplate() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Disable templating support.

withoutTemplate() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Disable templating support.

withOvhHttpApi(Properties) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enable OVH HTTP API implementation.

withParentPath(String) - Method in class fr.sii.ogham.core.builder.FirstSupportingResourceResolverBuilder

Set the parent path for template lookup.

withParentPath(String) - Method in class fr.sii.ogham.core.builder.TemplateBuilder

withPhoneNumberTranslation() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enables Addressing strategy using all default behaviors and values.

withPhoneNumberTranslation(PhoneNumberTranslatorBuilder, PhoneNumberTranslatorBuilder) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enables Addressing strategy using the provided SenderPhoneNumberTranslatorBuilder and RecipientPhoneNumberTranslatorBuilder.

withProperties(Properties) - Method in class fr.sii.ogham.email.builder.JavaMailBuilder

Set the properties to use for Java mail API implementation.

withProperties(Properties) - Method in class fr.sii.ogham.sms.builder.OvhSmsBuilder

Set the properties to use for configuring OVH implementation.

withReceiverPhoneNumberTranslation(PhoneNumberTranslatorBuilder) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enables Addressing strategy using the provided RecipientPhoneNumberTranslatorBuilder.

withResourceResolver(ResourceResolver) - Method in class fr.sii.ogham.core.builder.FirstSupportingResourceResolverBuilder

Register a lookup resolver.

withResourceResolver(ResourceResolver) - Method in class fr.sii.ogham.email.builder.AttachmentResourceTranslatorBuilder

Register a lookup mapping.

withResourceResolverBuilder(FirstSupportingResourceResolverBuilder) - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Tells the builder to use your own builder for template resolution.

withSenderPhoneNumberTranslation(PhoneNumberTranslatorBuilder) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enables Addressing strategy using the provided SenderPhoneNumberTranslatorBuilder.

withSendGrid(Properties) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Enable SendGrid implementation.

withSmppSessionConfiguration(SmppSessionConfiguration) - Method in class fr.sii.ogham.sms.builder.CloudhopperSMPPBuilder

Provide your own configuration for SMPP session.

withSms() - Method in class fr.sii.ogham.core.builder.MessagingBuilder

Tells the builder to activate the sms sender.

withSmsglobalRestApi(Properties) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enable smsglobal REST API implementation.

withSubjectFiller() - Method in class fr.sii.ogham.core.builder.MessageFillerBuilder

Enable the generation of subject of the message.

withTemplate() - Method in class fr.sii.ogham.core.builder.ContentTranslatorBuilder

Enable the management of templates using all default behaviors and values.

withTemplate(Properties) - Method in class fr.sii.ogham.core.builder.ContentTranslatorBuilder

Enable the management of templates using all default behaviors and values.

withTemplate(TemplateBuilder) - Method in class fr.sii.ogham.core.builder.ContentTranslatorBuilder

Enable the management of templates by delegating template engine construction to the specialized builder.

withTemplate() - Method in class fr.sii.ogham.email.builder.EmailBuilder

Enables templating support using all default behaviors and values.

withTemplate(Properties) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Enables templating support using all default behaviors and values.

withTemplate(ContentTranslatorBuilder) - Method in class fr.sii.ogham.email.builder.EmailBuilder

Enables templating support using the provided ContentTranslatorBuilder.

withTemplate() - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enables templating support using all default behaviors and values.

withTemplate(ContentTranslatorBuilder) - Method in class fr.sii.ogham.sms.builder.SmsBuilder

Enables templating support using the provided ContentTranslatorBuilder.

withTemplateEngine(TemplateEngine) - Method in class fr.sii.ogham.template.thymeleaf.builder.ThymeleafTemplateParserBuilder

By default the builder uses the default Thymeleaf template engine as-is.

withThymeleaf() - Method in class fr.sii.ogham.core.builder.TemplateBuilder

Enable Thymeleaf template engine.

withTranslator(AttachmentResourceTranslator) - Method in class fr.sii.ogham.email.builder.AttachmentResourceTranslatorBuilder

Register a new translator.

withUrl(URL) - Method in class fr.sii.ogham.sms.builder.OvhSmsBuilder

Set the URL of the OVH web service.

WrapExceptionMessagingService - Class in fr.sii.ogham.core.service

Decorator that catch all exceptions including RuntimeException.

WrapExceptionMessagingService(MessagingService) - Constructor for class fr.sii.ogham.core.service.WrapExceptionMessagingService

WRITE_TIMEOUT_PROPERTY - Static variable in class fr.sii.ogham.sms.SmsConstants.SmppConstants.CloudhopperConstants

The key of property for timeout for write timeout

X

XHTMLTranslator - Class in fr.sii.ogham.html.translator

Translator that converts any HTML content into its XHTML equivalent.

XHTMLTranslator() - Constructor for class fr.sii.ogham.html.translator.XHTMLTranslator

A B C D E F G H I J L M N O P R S T U V W X