View Javadoc

1   /*
2    * This file is part of Domingo
3    * an Open Source Java-API to Lotus Notes/Domino
4    * hosted at http://domingo.sourceforge.net
5    *
6    * Copyright (c) 2003-2007 Beck et al. projects GmbH Munich, Germany (http://www.bea.de)
7    *
8    * This library is free software; you can redistribute it and/or
9    * modify it under the terms of the GNU Lesser General Public
10   * License as published by the Free Software Foundation; either
11   * version 2.1 of the License, or (at your option) any later version.
12   *
13   * This library is distributed in the hope that it will be useful,
14   * but WITHOUT ANY WARRANTY; without even the implied warranty of
15   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16   * Lesser General Public License for more details.
17   *
18   * You should have received a copy of the GNU Lesser General Public
19   * License along with this library; if not, write to the Free Software
20   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21   */
22  
23  package de.bea.domingo.server;
24  
25  import java.io.IOException;
26  import java.io.PrintWriter;
27  import java.util.Map;
28  
29  import de.bea.domingo.DNotesException;
30  import de.bea.domingo.DSession;
31  
32  /***
33   * Base class for implementations of the {@link de.bea.domingo.server.Command Command} interface.
34   *
35   * @author <a href=mailto:kriede@users.sourceforge.net>Kurt Riede</a>
36   */
37  public abstract class BaseCommand implements Command {
38  
39      /***
40       * {@inheritDoc}
41       *
42       * @see de.bea.domingo.server.Command#execute(de.bea.domingo.DSession, java.util.Map, java.io.PrintWriter)
43       */
44      public abstract void execute(final DSession session, final Map parameters, final PrintWriter printWriter)
45          throws DNotesException, IOException;
46  
47      /***
48       * Reads the string value of a named parameter from a parameters map.
49       * The parameters map might contain both plain string values or an array of multiple string values.
50       * In case of an array of values, only the first value is returned.
51       *
52       * @param parameters map of parameters
53       * @param name parameter name
54       * @return parameter value
55       */
56      protected final String getParameterString(final Map parameters, final String name) {
57          Object value = parameters.get("cmd");
58          if (value instanceof String) {
59              return (String) value;
60          }
61          if (value instanceof String[]) {
62              return ((String[]) value)[0];
63          }
64          throw new IllegalArgumentException("Parameter " + name + " has invalid type " + value.getClass().getName());
65      }
66  }