View Javadoc

1   /****************************************************************
2    * Licensed to the Apache Software Foundation (ASF) under one   *
3    * or more contributor license agreements.  See the NOTICE file *
4    * distributed with this work for additional information        *
5    * regarding copyright ownership.  The ASF licenses this file   *
6    * to you under the Apache License, Version 2.0 (the            *
7    * "License"); you may not use this file except in compliance   *
8    * with the License.  You may obtain a copy of the License at   *
9    *                                                              *
10   *   http://www.apache.org/licenses/LICENSE-2.0                 *
11   *                                                              *
12   * Unless required by applicable law or agreed to in writing,   *
13   * software distributed under the License is distributed on an  *
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
15   * KIND, either express or implied.  See the License for the    *
16   * specific language governing permissions and limitations      *
17   * under the License.                                           *
18   ****************************************************************/
19  
20  package org.apache.jsieve.commands;
21  
22  import org.apache.jsieve.Arguments;
23  import org.apache.jsieve.Block;
24  import org.apache.jsieve.SieveContext;
25  import org.apache.jsieve.TestList;
26  import org.apache.jsieve.exception.SieveException;
27  import org.apache.jsieve.mail.MailAdapter;
28  
29  /**
30   * Class Elsif implements the Elsif Command as defined in RFC 3028, section 3.1.
31   */
32  public class Elsif extends AbstractConditionalCommand {
33  
34      /**
35       * Constructor for Elsif.
36       */
37      public Elsif() {
38          super();
39      }
40  
41      /**
42       * <p>
43       * Conditionally eexecute a Block if an Elsif Condition is allowed and
44       * runnable.
45       * </p>
46       * <p>
47       * Also,
48       * 
49       * @see org.apache.jsieve.commands.AbstractCommand#executeBasic(MailAdapter,
50       *      Arguments, Block, SieveContext)
51       *      </p>
52       */
53      protected Object executeBasic(MailAdapter mail, Arguments arguments,
54              Block block, SieveContext context) throws SieveException {
55          // Check Syntax
56          if (!context.getConditionManager().isElsifAllowed())
57              throw context.getCoordinate().commandException(
58                      "Unexpected Command: \"elsif\".");
59  
60          // Check Runnable
61          if (!context.getConditionManager().isElsifRunnable())
62              return Boolean.FALSE;
63  
64          // Run the tests
65          Boolean isTestPassed = (Boolean) arguments.getTestList().execute(mail,
66                  context);
67  
68          // If the tests answered TRUE, execute the Block
69          if (isTestPassed.booleanValue())
70              execute(mail, block, context);
71  
72          // Update the ConditionManager
73          context.getConditionManager().setElsifTestResult(
74                  isTestPassed.booleanValue());
75  
76          // Return the result
77          return isTestPassed;
78      }
79  
80      /**
81       * @see org.apache.jsieve.commands.AbstractCommand#validateArguments(Arguments,
82       *      SieveContext)
83       */
84      protected void validateArguments(Arguments arguments, SieveContext context)
85              throws SieveException {
86          TestList testList = arguments.getTestList();
87          if (null == testList || testList.getTests().isEmpty())
88              throw context.getCoordinate().syntaxException("Expecting a Test");
89      }
90  
91  }