View Javadoc

1   /*
2    * Wallace IMAP Server
3    * Copyright (C) 2004  Robert Newson
4    *
5    * This program is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU General Public License
7    * as published by the Free Software Foundation; either version 2
8    * of the License, or (at your option) any later version.
9    *
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   * GNU General Public License for more details.
14   *
15   * You should have received a copy of the GNU General Public License
16   * along with this program; if not, write to the Free Software
17   * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18   */
19  package net.sf.wallace;
20  
21  import javax.mail.MessagingException;
22  
23  /***
24   * A command, applying an IMAP message to a session.
25   * 
26   * @author rnewson
27   */
28  public interface Command {
29  
30      /***
31       * Execute this command against the given session using data from the
32       * supplied message.
33       * @param wallaceSession
34       *            the session to apply the message to.
35       * 
36       * @throws InvalidStateException
37       *             if the session is not in an appropriate state for this
38       *             command (SELECT before LOGIN, for example).
39       */
40      void execute(final WallaceSession wallaceSession) throws InvalidStateException,
41              MessagingException;
42  
43  }