Class IMAPMailboxCommand

java.lang.Object

org.deltava.commands.AbstractCommand

org.deltava.commands.AbstractFormCommand

org.deltava.commands.AbstractAuditFormCommand

org.deltava.commands.mail.IMAPMailboxCommand

All Implemented Interfaces:

Command

public class IMAPMailboxCommand
extends AbstractAuditFormCommand

A Web Site Command to handle IMAP mailbox profiles.

Since:

2.2

Version:

12.4

Author:

Luke

Nested Class Summary

Nested classes/interfaces inherited from interface Command

Command.Scope

Modifier and Type	Interface	Description
static enum	Command.Scope	Scope helper enumeration.

Field Summary

Fields inherited from interface Command

ID, OPERATION, PAGE, REQUEST, SESSION

Modifier and Type	Field	Description
static final int	ID
static final int	OPERATION
static final Command.Scope	PAGE
static final Command.Scope	REQUEST
static final Command.Scope	SESSION

Constructor Summary

Constructors

Constructor	Description
IMAPMailboxCommand()

Method Summary

Modifier and Type	Method	Description
protected void	execEdit(CommandContext ctx)	Callback method called when editing the profile.
protected void	execRead(CommandContext ctx)	Callback method called when reading the profile.
protected void	execSave(CommandContext ctx)	Callback method called when saving the profile.

Methods inherited from class AbstractAuditFormCommand

readAuditLog, writeAuditLog

Modifier and Type	Method	Description
protected static void	readAuditLog(CommandContext ctx, Auditable a)	Loads the audit log for an object.
protected static void	writeAuditLog(CommandContext ctx, AuditLog ae)	Writes an audit log entry for an object.

Methods inherited from class AbstractFormCommand

execute

Modifier and Type	Method	Description
final void	execute(CommandContext ctx)	Executes the command, and based on the operation calls an implementation method for the particular operation.

Methods inherited from class AbstractCommand

forgottenException, getID, getName, getRoles, init, notFoundException, notFoundException, parseDateTime, parseDateTime, securityException, setRoles

Modifier and Type	Method	Description
protected static CommandException	forgottenException()	Helper method to generate a content blocked exception.
final String	getID()	Return the ID of the command.
final String	getName()	Return the name of the command.
final Collection<String>	getRoles()	Return the roles authorized to execute this command.
void	init(String id, String cmdName)	Initialize the Command.
protected static CommandException	notFoundException(String msg, int id)	Helper method to generate an "item not found" exception for a given database ID.
protected static CommandException	notFoundException(String msg, Object id)	Helper method to generate an "item not found" exception for a given ID.
protected static Instant	parseDateTime(CommandContext ctx, String paramHdr)	Parses one or two HTTP request parameters into a date/time value, using the user's format patterns or the default format patterns if the user is not authenticated.
protected static Instant	parseDateTime(CommandContext ctx, String paramHdr, String dfmt, String tfmt)	Parses one or two HTTP request parameters into a date/time value.
protected static CommandException	securityException(String msg)	Helper method to generate a security exception.
final void	setRoles(Collection<String> roles)	Updates the roles authorized to execute this command.

Methods inherited from class Object

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

Constructor Details

IMAPMailboxCommand

public IMAPMailboxCommand()

Method Details

execEdit

protected void execEdit(CommandContext ctx)
                 throws CommandException

Callback method called when editing the profile.

Specified by:

execEdit in class AbstractFormCommand

Parameters:

ctx - the Command context

Throws:

CommandException - if an error occurs

execRead

protected void execRead(CommandContext ctx)
                 throws CommandException

Callback method called when reading the profile.

Specified by:

execRead in class AbstractFormCommand

Parameters:

ctx - the Command context

Throws:

CommandException - if an error occurs

execSave

protected void execSave(CommandContext ctx)
                 throws CommandException

Callback method called when saving the profile.

Specified by:

execSave in class AbstractFormCommand

Parameters:

ctx - the Command context

Throws:

CommandException - if an error occurs