org.restlet.ext.javamail

Class TriggerResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.restlet.ext.javamail.TriggerResource

public class TriggerResource
extends ServerResource

Resource that handles requests to target resources according to parameters located in mails.

Author:

Jerome Louvel

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_MAILBOX_CHALLENGE_SCHEME
static String	ATTRIBUTE_MAILBOX_LOGIN
static String	ATTRIBUTE_MAILBOX_PASSWORD
static String	ATTRIBUTE_MAILBOX_URI

Constructor Summary

Constructors

Constructor and Description
TriggerResource()

Method Summary

Modifier and Type	Method and Description
void	acceptMails(Representation entity) Handles POST requests.
protected void	callTarget(Resolver<String> resolver) Requests the target resource.
protected void	deleteMail(String mailIdentifier) Deletes a mail after it has been processed.
protected void	doInit() Set-up method that can be overridden in order to initialize the state of the resource.
protected Representation	getMail(String identifier) Get the mail representation according to its identifier.
ChallengeScheme	getMailboxChallengeScheme() Returns the scheme of the mailbox challenge.
String	getMailboxLogin() Returns the login for the mailbox.
String	getMailboxPassword() Returns the password for the mailbox.
String	getMailboxUri() Returns the URI of the mailbox.
protected List<String>	getMailIdentifiers() Returns the list of identifiers for the mails in the inbox
protected Reference	getMailRef(String identifier) Returns the reference of a mail according to its identifier.
String	getMailUriTemplate() Returns the template of the mail's URI.
MailResolver	getResolver() Returns the resolver based on a mail.
protected MailResolver	getResolver(String mailIdentifier, Representation email) Returns a new resolver based on a mail.
protected Representation	getResponseRepresentation(List<String> mailsSuccessful, Map<String,String> mailsUnsuccessful) Returns the response's representation according to the list of successfull and unsuccessfull mails.
protected Status	getResponseStatus(List<String> mailsSuccessful, Map<String,String> mailsUnsuccessful) Returns the response's status according to the list of successfull and unsuccessfull mails.
protected ChallengeResponse	getTargetChallengeResponse(Resolver<String> resolver) Returns the authentication data sent by client to the target according to the a list of properties.
protected Representation	getTargetEntity(Resolver<String> resolver) Returns the entity sent to the target.
Method	getTargetMethod() Returns the default target method.
protected Method	getTargetMethod(Resolver<String> resolver) Returns the target method according to a list of properties.
protected Reference	getTargetRef(Resolver<String> resolver) Returns the reference of the target according to the a list of properties.
String	getTargetUri() Returns the target URI template.
boolean	isTargetEntityEnabled() Indicate whether or not the target supports entity in the request.
void	setMailboxChallengeScheme(ChallengeScheme mailboxChallengeScheme) Sets the scheme of the mailbox challenge.
void	setMailboxLogin(String mailboxLogin) Sets the login for the mailbox access.
void	setMailboxPassword(String mailboxPassword) Sets the password for the mailbox access.
void	setMailboxUri(String mailboxUri) Sets the URI of the mailbox.
void	setMailUriTemplate(String mailUriTemplate) Sets the URI template for the target.
void	setTargetEntityEnabled(boolean targetEntityEnabled) Indicate whether or not the target supports entity in the request.
void	setTargetMethod(Method targetMethod) Sets the default target method.
void	setTargetUri(String targetUri) Sets the target URI template.

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doCatch, doConditionalHandle, doError, doHandle, doHandle, doNegotiatedHandle, get, get, getAttribute, getDescription, getInfo, getInfo, getName, getOnSent, getPreferredVariant, getRole, getVariants, getVariants, handle, hasAnnotations, head, head, isAnnotated, isAutoCommitting, isCommitted, isConditional, isExisting, isInRole, isNegotiated, options, options, patch, patch, post, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setAttribute, setAutoCommitting, setChallengeRequests, setCommitted, setConditional, setCookieSettings, setDescription, setDimensions, setExisting, setLocationRef, setLocationRef, setName, setNegotiated, setOnSent, setProxyChallengeRequests, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.Resource

doError, doRelease, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getConnegService, getContext, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMatrixValue, getMaxForwards, getMetadataService, getMethod, getOriginalRef, getProtocol, getProxyChallengeRequests, getProxyChallengeResponse, getQuery, getQueryValue, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestCacheDirectives, getRequestEntity, getResponse, getResponseAttributes, getResponseCacheDirectives, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, isLoggable, release, setApplication, setQueryValue, setRequest, setResponse, toBoolean, toByte, toDouble, toFloat, toInteger, toLong, toObject, toRepresentation, toRepresentation, toRepresentation, toShort, toString

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_MAILBOX_CHALLENGE_SCHEME

public static final String ATTRIBUTE_MAILBOX_CHALLENGE_SCHEME

See Also:

Constant Field Values

ATTRIBUTE_MAILBOX_LOGIN

public static final String ATTRIBUTE_MAILBOX_LOGIN

See Also:

Constant Field Values

ATTRIBUTE_MAILBOX_PASSWORD

public static final String ATTRIBUTE_MAILBOX_PASSWORD

See Also:

Constant Field Values

ATTRIBUTE_MAILBOX_URI

public static final String ATTRIBUTE_MAILBOX_URI

See Also:

Constant Field Values

Constructor Detail

TriggerResource

public TriggerResource()

Method Detail

acceptMails

@Post
public void acceptMails(Representation entity)
                       throws ResourceException

Handles POST requests. It retrieves a list of mails and generate requests to target resources.

Parameters:

entity - The representation of the mails list.

Throws:

ResourceException

callTarget

protected void callTarget(Resolver<String> resolver)
                   throws ResourceException

Requests the target resource.

Parameters:

resolver - The data model that provides parameters value.

Throws:

ResourceException

deleteMail

protected void deleteMail(String mailIdentifier)
                   throws ResourceException

Deletes a mail after it has been processed.

Parameters:

mailIdentifier - The identifier of the mail

Throws:

ResourceException

doInit

protected void doInit()
               throws ResourceException

Description copied from class: Resource

Set-up method that can be overridden in order to initialize the state of the resource. By default it does nothing.

Overrides:

doInit in class Resource

Throws:

ResourceException

See Also:

Resource.init(Context, Request, Response)

getMail

protected Representation getMail(String identifier)
                          throws ResourceException

Get the mail representation according to its identifier.

Parameters:

identifier - the mail identifier.

Throws:

ResourceException

getMailboxChallengeScheme

public ChallengeScheme getMailboxChallengeScheme()

Returns the scheme of the mailbox challenge.

Returns:

The scheme of the mailbox challenge.

getMailboxLogin

public String getMailboxLogin()

Returns the login for the mailbox.

Returns:

The login for the mailbox.

getMailboxPassword

public String getMailboxPassword()

Returns the password for the mailbox.

Returns:

The password for the mailbox.

getMailboxUri

public String getMailboxUri()

Returns the URI of the mailbox.

Returns:

The URI of the mailbox.

getMailIdentifiers

protected List<String> getMailIdentifiers()
                                   throws ResourceException

Returns the list of identifiers for the mails in the inbox

Returns:

The list of identifiers.

Throws:

ResourceException

getMailRef

protected Reference getMailRef(String identifier)
                        throws ResourceException

Returns the reference of a mail according to its identifier.

Parameters:

identifier - The identifier of a mail.

Returns:

The URI of the mail.

Throws:

ResourceException

getMailUriTemplate

public String getMailUriTemplate()

Returns the template of the mail's URI.

Returns:

the template of the mail's URI.

getResolver

public MailResolver getResolver()

Returns the resolver based on a mail.

Returns:

The resolver.

getResolver

protected MailResolver getResolver(String mailIdentifier,
                                   Representation email)

Returns a new resolver based on a mail.

Parameters:

mailIdentifier - Identifier of the mail.

email - The mail.

Returns:

A resolver.

getResponseRepresentation

protected Representation getResponseRepresentation(List<String> mailsSuccessful,
                                                   Map<String,String> mailsUnsuccessful)

Returns the response's representation according to the list of successfull and unsuccessfull mails.

Parameters:

mailsSuccessful - The list of successfull mails.

mailsUnsuccessful - The list of successfull mails and related error message.

Returns:

The response's representation.

getResponseStatus

protected Status getResponseStatus(List<String> mailsSuccessful,
                                   Map<String,String> mailsUnsuccessful)

Returns the response's status according to the list of successfull and unsuccessfull mails.

Parameters:

mailsSuccessful - The list of successfull mails.

mailsUnsuccessful - The list of successfull mails and related error message.

Returns:

The response's status.

getTargetChallengeResponse

protected ChallengeResponse getTargetChallengeResponse(Resolver<String> resolver)
                                                throws ResourceException

Returns the authentication data sent by client to the target according to the a list of properties. By default, this method returns checks the variable "challengeScheme", "login", "password" in order to build the ChallengeResponse object. It can be overriden.

Parameters:

resolver - The resolver.

Returns:

The target challengeResponse object.

Throws:

ResourceException

getTargetEntity

protected Representation getTargetEntity(Resolver<String> resolver)

Returns the entity sent to the target. By default, it sends the mail message.

Parameters:

resolver - the resolver.

Returns:

The entity to be sent to the target.

getTargetMethod

public Method getTargetMethod()

Returns the default target method.

Returns:

The default target method.

getTargetMethod

protected Method getTargetMethod(Resolver<String> resolver)

Returns the target method according to a list of properties.

Parameters:

resolver - The resolver.

Returns:

The target method.

getTargetRef

protected Reference getTargetRef(Resolver<String> resolver)
                          throws ResourceException

Returns the reference of the target according to the a list of properties.

Parameters:

resolver - The resolver.

Returns:

The target reference.

Throws:

ResourceException

getTargetUri

public String getTargetUri()

Returns the target URI template.

Returns:

The template that represents a target URI.

isTargetEntityEnabled

public boolean isTargetEntityEnabled()

Indicate whether or not the target supports entity in the request.

Returns:

True if the target supports entity in the request, false, otherwise.

setMailboxChallengeScheme

public void setMailboxChallengeScheme(ChallengeScheme mailboxChallengeScheme)

Sets the scheme of the mailbox challenge.

Parameters:

mailboxChallengeScheme - The scheme of the mailbox challenge.

setMailboxLogin

public void setMailboxLogin(String mailboxLogin)

Sets the login for the mailbox access.

Parameters:

mailboxLogin - The login for the mailbox access.

setMailboxPassword

public void setMailboxPassword(String mailboxPassword)

Sets the password for the mailbox access.

Parameters:

mailboxPassword - The password for the mailbox access.

setMailboxUri

public void setMailboxUri(String mailboxUri)

Sets the URI of the mailbox.

Parameters:

mailboxUri - the URI of the mailbox.

setMailUriTemplate

public void setMailUriTemplate(String mailUriTemplate)

Sets the URI template for the target.

Parameters:

mailUriTemplate - the URI template for the target.

setTargetEntityEnabled

public void setTargetEntityEnabled(boolean targetEntityEnabled)

Indicate whether or not the target supports entity in the request.

Parameters:

targetEntityEnabled - True if the target supports entity in the request, false, otherwise.

setTargetMethod

public void setTargetMethod(Method targetMethod)

Sets the default target method.

Parameters:

targetMethod - The default target method.

setTargetUri

public void setTargetUri(String targetUri)

Sets the target URI template.

Parameters:

targetUri - The target URI template.