1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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  public interface Method {
36  
37      public static final String COPY = "COPY";
38  
39      public static final String DELETE = "DELETE";
40  
41      public static final String GET = "GET";
42  
43      public static final String HEAD = "HEAD";
44  
45      public static final String LOCK = "LOCK";
46  
47      public static final String MKCOL = "MKCOL";
48  
49      public static final String MOVE = "MOVE";
50  
51      public static final String OPTIONS = "OPTIONS";
52  
53      public static final String PROPFIND = "PROPFIND";
54  
55      public static final String PROPPATCH = "PROPPATCH";
56  
57      public static final String PUT = "PUT";
58  
59      public static final String UNLOCK = "UNLOCK";
60  
61      public static final String[] SUPPORTED_METHODS_ARRAY = {
62          COPY, DELETE, GET, HEAD, LOCK, MKCOL, MOVE, OPTIONS, PROPFIND,
63          PROPPATCH, PUT, UNLOCK
64      };
65  
66      public static final String SUPPORTED_METHODS =
67          StringUtil.merge(SUPPORTED_METHODS_ARRAY);
68  
69      /**
70       * Returns -1 or a supported HTTP status code. If it is -1, then the status
71       * code has already been set. Otherwise, the status code needs to be set by
72       * the caller.
73       *
74       * @return -1 or a supported HTTP status code. If it is -1, then the status
75       *         code has already been set. Otherwise, the status code needs to be
76       *         set by the caller.
77       */
78      public int process(WebDAVRequest webDavRequest) throws WebDAVException;
79  
80  }