fr.cnes.doi.settings

Class EmailSettings

java.lang.Object

fr.cnes.doi.settings.EmailSettings

@Requirement(reqId="DOI_CONFIG_010",
             reqName="Configuration du serveur central")
public final class EmailSettings
extends Object

Singleton to load and use Email settings.

Author:

Jean-Christophe Malapert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	EmailSettings.EmailSettingsHolder

Field Summary

Fields

Modifier and Type	Field and Description
private String	authPwd Password.
private String	authUser login.
private String	contactAdmin Contact admin uRL.
private boolean	debug debug.
private static boolean	DEFAULT_DEBUG Default debug : false.
private static org.apache.logging.log4j.Logger	LOG Logger.
private String	smtpProtocol SMTP protocol.
private String	smtpUrl SMTP URL.
private String	tlsEnable TLS.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	EmailSettings() Constructor

Method Summary

Modifier and Type	Method and Description
private org.restlet.representation.Representation	createMailRepresentation(String subject, String msg, String to) Creates the email representation.
String	getAuthPwd() Returns the decrypted password.
String	getAuthUser() Returns the decrypted login.
String	getContactAdmin() Returns the administrator's email.
static EmailSettings	getInstance() Access to unique INSTANCE of Settings
String	getSmtpProtocol() Returns the protocol.
String	getSmtpURL() Returns the protocol URL.
String	getTlsEnable() Returns True when TLS is enable otherwise False.
void	init() Init singleton.
private boolean	isAuthenticate() Returns true when sendmail neeed to be authenticated otherwide false.
private boolean	isConfigureForSendingEmail() Returns true when configuration may be enough to send an email.
boolean	isDebug() Returns the debug.
private boolean	processMessage(String subject, String message, String receiverEmail) Process the message.
private boolean	sendMail(org.restlet.data.Protocol protocol, org.restlet.Request request, boolean startTls, String subject, String msg, String to) Sends an email only when "Starter.CONTEXT_MODE" is set to PROD.
boolean	sendMessage(String subject, String msg) Sends a message by email.
boolean	sendMessage(String subject, String msg, String receiverEmail) Sends a message by email to receiver.
void	setDebug(boolean isEnabled) Sets the debug.
private void	setSmtpCredentials(org.restlet.Request request) Sets the SMTP credential when the SMTP needs an authentication.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DEBUG

private static final boolean DEFAULT_DEBUG

Default debug : false.

See Also:

Constant Field Values

LOG

private static final org.apache.logging.log4j.Logger LOG

Logger.

smtpUrl

private String smtpUrl

SMTP URL.

smtpProtocol

private String smtpProtocol

SMTP protocol.

tlsEnable

private String tlsEnable

TLS.

authUser

private String authUser

login.

authPwd

private String authPwd

Password.

contactAdmin

private String contactAdmin

Contact admin uRL.

debug

private boolean debug

debug.

Constructor Detail

EmailSettings

private EmailSettings()

Constructor

Method Detail

getInstance

public static EmailSettings getInstance()

Access to unique INSTANCE of Settings

Returns:

the configuration instance.

init

public void init()

Init singleton.

setDebug

public void setDebug(boolean isEnabled)

Sets the debug.

Parameters:

isEnabled - True if debug is enabled otherwise False

isDebug

public boolean isDebug()

Returns the debug.

Returns:

debug

sendMessage

public boolean sendMessage(String subject,
                           String msg)

Sends a message by email.

Parameters:

subject - Email's subject

msg - Email's message

Returns:

True when the message is sent

sendMessage

public boolean sendMessage(String subject,
                           String msg,
                           String receiverEmail)

Sends a message by email to receiver.

Parameters:

subject - Email's subject

msg - Email's message

receiverEmail - receiver

Returns:

True when the message is sent

processMessage

private boolean processMessage(String subject,
                               String message,
                               String receiverEmail)
                        throws Exception

Process the message. Sends to SMTP server

Parameters:

subject - subject of the email

message - message

receiverEmail - receiver

Returns:

true when the message has been send otherwise false

Throws:

Exception - when an error happens

setSmtpCredentials

private void setSmtpCredentials(org.restlet.Request request)

Sets the SMTP credential when the SMTP needs an authentication.

Parameters:

request - request

isConfigureForSendingEmail

private boolean isConfigureForSendingEmail()

Returns true when configuration may be enough to send an email. Checks the SMTP URL and the SMTP protocol.

Returns:

true when configuration may be enough to send an email

isAuthenticate

private boolean isAuthenticate()

Returns true when sendmail neeed to be authenticated otherwide false.

Returns:

true when sendmail neeed to be authenticated otherwide false

createMailRepresentation

private org.restlet.representation.Representation createMailRepresentation(String subject,
                                                                           String msg,
                                                                           String to)

Creates the email representation.

Parameters:

subject - Email's subject

msg - Email's message

to - receiver

Returns:

the email representation

sendMail

private boolean sendMail(org.restlet.data.Protocol protocol,
                         org.restlet.Request request,
                         boolean startTls,
                         String subject,
                         String msg,
                         String to)
                  throws Exception

Sends an email only when "Starter.CONTEXT_MODE" is set to PROD.

Parameters:

protocol - Protocol (SMTP or SMTPS)

request - request

startTls - startTls

subject - Email's subject

msg - Email's message

to - receiver

Returns:

True when the message is sent

Throws:

Exception - - if an error happens when stopping the request

getSmtpURL

public String getSmtpURL()

Returns the protocol URL.

Returns:

the URL

getSmtpProtocol

public String getSmtpProtocol()

Returns the protocol.

Returns:

the port

getTlsEnable

public String getTlsEnable()

Returns True when TLS is enable otherwise False.

Returns:

the tlsEnable

getAuthUser

public String getAuthUser()

Returns the decrypted login.

Returns:

the authUser

getAuthPwd

public String getAuthPwd()

Returns the decrypted password.

Returns:

the authPwd

getContactAdmin

public String getContactAdmin()

Returns the administrator's email.

Returns:

the contactAdmin