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.SieveContext;
23  import org.apache.jsieve.exception.CommandException;
24  
25  /**
26   * <p>
27   * Abstract class AbstractPrologCommand defines the common state validation
28   * behavior for Prolog Commands. In RFC 3028 the only Prolog Command is
29   * 'requires', however, the specification may evolve.
30   * </p>
31   */
32  public abstract class AbstractPrologCommand extends AbstractCommand {
33  
34      /**
35       * Constructor for AbstractPrologCommand.
36       */
37      public AbstractPrologCommand() {
38          super();
39      }
40  
41      /**
42       * <p>
43       * Method validateState() ensures, via the CommandStateManager, that a
44       * Prolog Command is permissible.
45       * </p>
46       * 
47       * <p>
48       * Also,
49       * </p>
50       * 
51       * @see org.apache.jsieve.commands.AbstractCommand#validateState(SieveContext)
52       */
53      protected void validateState(SieveContext context) throws CommandException {
54          super.validateState(context);
55  
56          if (!(context.getCommandStateManager().isInProlog()))
57              throw context.getCoordinate().commandException(
58                      "Invalid state for a prolog command.");
59      }
60  
61  }