| Method.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 package com.liferay.portal.webdav.methods;
24
25 import com.liferay.portal.kernel.util.StringUtil;
26 import com.liferay.portal.webdav.WebDAVException;
27 import com.liferay.portal.webdav.WebDAVRequest;
28
29 /**
30 * <a href="Method.java.html"><b><i>View Source</i></b></a>
31 *
32 * @author Brian Wing Shun Chan
33 * @author Alexander Chow
34 *
35 */
36 public interface Method {
37
38 public static final String COPY = "COPY";
39
40 public static final String DELETE = "DELETE";
41
42 public static final String GET = "GET";
43
44 public static final String HEAD = "HEAD";
45
46 public static final String LOCK = "LOCK";
47
48 public static final String MKCOL = "MKCOL";
49
50 public static final String MOVE = "MOVE";
51
52 public static final String OPTIONS = "OPTIONS";
53
54 public static final String PROPFIND = "PROPFIND";
55
56 public static final String PROPPATCH = "PROPPATCH";
57
58 public static final String PUT = "PUT";
59
60 public static final String UNLOCK = "UNLOCK";
61
62 public static final String[] SUPPORTED_METHODS_ARRAY = {
63 COPY, DELETE, GET, HEAD, LOCK, MKCOL, MOVE, OPTIONS, PROPFIND,
64 PROPPATCH, PUT, UNLOCK
65 };
66
67 public static final String SUPPORTED_METHODS =
68 StringUtil.merge(SUPPORTED_METHODS_ARRAY);
69
70 /**
71 * Returns -1 or a supported HTTP status code. If it is -1, then the status
72 * code has already been set. Otherwise, the status code needs to be set by
73 * the caller.
74 *
75 * @param webDavRequest the WebDAV request
76 * @return -1 or a supported HTTP status code. If it is -1, then the
77 * status code has already been set. Otherwise, the status code
78 * needs to be set by the caller.
79 * @throws WebDAVException
80 */
81 public int process(WebDAVRequest webDavRequest) throws WebDAVException;
82
83 }