Package org.jgrapes.mail

Class MailComponent

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.mail.MailComponent

All Implemented Interfaces:

Iterable<ComponentType>, Channel, ComponentType, Eligible, Manager

Direct Known Subclasses:

MailConnectionManager

public abstract class MailComponent
extends Component

A base class for mail handling components.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

Channel.Default

Field Summary

Fields

Modifier and Type	Field	Description
protected final Properties	mailProps

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
MailComponent()	Creates a new component with its channel set to itself.
MailComponent(Channel componentChannel)	Creates a new component base with its channel set to the given channel.
MailComponent(Channel componentChannel, HandlerDefinition.ChannelReplacements channelReplacements)	Creates a new component base like MailComponent(Channel) but with channel mappings for Handler annotations.

Method Summary

Modifier and Type	Method	Description
protected abstract void	configureComponent(Map<String,String> values)	Configure the component specific values.
void	onConfigUpdate(ConfigurationUpdate event)	Configure the component.
protected Optional<Password>	password()	Return the password.
MailComponent	setMailProperties(Map<String,String> props)	Sets the mail properties.
MailComponent	setPassword(Password password)	Sets the password.
String	toString()	If a name has been set for this component (see Manager.setName(String)), return the name, else return the object name provided by Components.objectName(Object), using ComponentVertex.component() as argument.

Methods inherited from class org.jgrapes.core.Component

channel, component, defaultCriterion, isEligibleFor, setName

Methods inherited from class org.jgrapes.core.internal.ComponentVertex

activeEventPipeline, addHandler, attach, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, unregisterAsGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Field Details

mailProps

protected final Properties mailProps

Constructor Details

MailComponent

public MailComponent()

Creates a new component with its channel set to itself.

MailComponent

public MailComponent(Channel componentChannel)

Creates a new component base with its channel set to the given channel.

As a special case Channel.SELF can be passed to the constructor to make the component use itself as channel. The special value is necessary as you obviously cannot pass an object to be constructed to its constructor.

Parameters:

componentChannel - the channel that the component’s handlers listen on by default and that Manager.fire(Event, Channel...) sends the event to

MailComponent

public MailComponent(Channel componentChannel,
 HandlerDefinition.ChannelReplacements channelReplacements)

Creates a new component base like MailComponent(Channel) but with channel mappings for Handler annotations.

Parameters:

componentChannel - the channel that the component’s handlers listen on by default and that Manager.fire(Event, Channel...) sends the event to

channelReplacements - the channel replacements to apply to the channels elements of the Handler annotations

Method Details

setMailProperties

public MailComponent setMailProperties(Map<String,String> props)

Sets the mail properties.

See the Jakarta Mail documentation for available settings. The given properties are merged with the already existing properties.

Parameters:

props - the props

Returns:

the mail monitor

setPassword

public MailComponent setPassword(Password password)

Sets the password.

Parameters:

password - the new password

password

protected Optional<Password> password()

Return the password.

Returns:

the optional password

onConfigUpdate

@Handler
public void onConfigUpdate(ConfigurationUpdate event)

Configure the component.

Attempts to access all paths specified in the package description in sequence as described in org.jgrapes.mail. For each path, merges the mail properties and invokes configureComponent(java.util.Map<java.lang.String, java.lang.String>) with the available key/value pairs.

Parameters:

event - the event

configureComponent

protected abstract void configureComponent(Map<String,String> values)

Configure the component specific values.

Parameters:

values - the values

toString

public String toString()

Description copied from class: ComponentVertex

If a name has been set for this component (see Manager.setName(String)), return the name, else return the object name provided by Components.objectName(Object), using ComponentVertex.component() as argument.

Overrides:

toString in class ComponentVertex