1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portal.webdav.methods;
21  
22  import com.liferay.portal.kernel.util.StringUtil;
23  import com.liferay.portal.webdav.WebDAVException;
24  import com.liferay.portal.webdav.WebDAVRequest;
25  
26  /**
27   * <a href="Method.java.html"><b><i>View Source</i></b></a>
28   *
29   * @author Brian Wing Shun Chan
30   * @author Alexander Chow
31   *
32   */
33  public interface Method {
34  
35      public static final String COPY = "COPY";
36  
37      public static final String DELETE = "DELETE";
38  
39      public static final String GET = "GET";
40  
41      public static final String HEAD = "HEAD";
42  
43      public static final String LOCK = "LOCK";
44  
45      public static final String MKCOL = "MKCOL";
46  
47      public static final String MOVE = "MOVE";
48  
49      public static final String OPTIONS = "OPTIONS";
50  
51      public static final String PROPFIND = "PROPFIND";
52  
53      public static final String PROPPATCH = "PROPPATCH";
54  
55      public static final String PUT = "PUT";
56  
57      public static final String UNLOCK = "UNLOCK";
58  
59      public static final String[] SUPPORTED_METHODS_ARRAY = {
60          COPY, DELETE, GET, HEAD, LOCK, MKCOL, MOVE, OPTIONS, PROPFIND,
61          PROPPATCH, PUT, UNLOCK
62      };
63  
64      public static final String SUPPORTED_METHODS =
65          StringUtil.merge(SUPPORTED_METHODS_ARRAY);
66  
67      /**
68       * Returns -1 or a supported HTTP status code. If it is -1, then the status
69       * code has already been set. Otherwise, the status code needs to be set by
70       * the caller.
71       *
72       * @param       webDavRequest the WebDAV request
73       * @return      -1 or a supported HTTP status code. If it is -1, then the
74       *              status code has already been set. Otherwise, the status code
75       *              needs to be set by the caller.
76       * @throws      WebDAVException
77       */
78      public int process(WebDAVRequest webDavRequest) throws WebDAVException;
79  
80  }