001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hdfs.web.resources;
019
020import java.net.HttpURLConnection;
021
022/** Http GET operation parameter. */
023public class GetOpParam extends HttpOpParam<GetOpParam.Op> {
024  /** Get operations. */
025  public static enum Op implements HttpOpParam.Op {
026    OPEN(true, HttpURLConnection.HTTP_OK),
027
028    GETFILESTATUS(false, HttpURLConnection.HTTP_OK),
029    LISTSTATUS(false, HttpURLConnection.HTTP_OK),
030    GETCONTENTSUMMARY(false, HttpURLConnection.HTTP_OK),
031    GETFILECHECKSUM(true, HttpURLConnection.HTTP_OK),
032
033    GETHOMEDIRECTORY(false, HttpURLConnection.HTTP_OK),
034    GETDELEGATIONTOKEN(false, HttpURLConnection.HTTP_OK, true),
035
036    /** GET_BLOCK_LOCATIONS is a private unstable op. */
037    GET_BLOCK_LOCATIONS(false, HttpURLConnection.HTTP_OK),
038    GETACLSTATUS(false, HttpURLConnection.HTTP_OK),
039    GETXATTRS(false, HttpURLConnection.HTTP_OK),
040    LISTXATTRS(false, HttpURLConnection.HTTP_OK),
041
042    NULL(false, HttpURLConnection.HTTP_NOT_IMPLEMENTED);
043
044    final boolean redirect;
045    final int expectedHttpResponseCode;
046    final boolean requireAuth;
047
048    Op(final boolean redirect, final int expectedHttpResponseCode) {
049      this(redirect, expectedHttpResponseCode, false);
050    }
051    
052    Op(final boolean redirect, final int expectedHttpResponseCode,
053       final boolean requireAuth) {
054      this.redirect = redirect;
055      this.expectedHttpResponseCode = expectedHttpResponseCode;
056      this.requireAuth = requireAuth;
057    }
058
059    @Override
060    public HttpOpParam.Type getType() {
061      return HttpOpParam.Type.GET;
062    }
063    
064    @Override
065    public boolean getRequireAuth() {
066      return requireAuth;
067    }
068
069    @Override
070    public boolean getDoOutput() {
071      return false;
072    }
073
074    @Override
075    public boolean getRedirect() {
076      return redirect;
077    }
078
079    @Override
080    public int getExpectedHttpResponseCode() {
081      return expectedHttpResponseCode;
082    }
083
084    @Override
085    public String toQueryString() {
086      return NAME + "=" + this;
087    }
088  }
089
090  private static final Domain<Op> DOMAIN = new Domain<Op>(NAME, Op.class);
091
092  /**
093   * Constructor.
094   * @param str a string representation of the parameter value.
095   */
096  public GetOpParam(final String str) {
097    super(DOMAIN, DOMAIN.parse(str));
098  }
099
100  @Override
101  public String getName() {
102    return NAME;
103  }
104}