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),
035
036    /** GET_BLOCK_LOCATIONS is a private unstable op. */
037    GET_BLOCK_LOCATIONS(false, HttpURLConnection.HTTP_OK),
038
039    NULL(false, HttpURLConnection.HTTP_NOT_IMPLEMENTED);
040
041    final boolean redirect;
042    final int expectedHttpResponseCode;
043
044    Op(final boolean redirect, final int expectedHttpResponseCode) {
045      this.redirect = redirect;
046      this.expectedHttpResponseCode = expectedHttpResponseCode;
047    }
048
049    @Override
050    public HttpOpParam.Type getType() {
051      return HttpOpParam.Type.GET;
052    }
053
054    @Override
055    public boolean getDoOutput() {
056      return false;
057    }
058
059    @Override
060    public boolean getRedirect() {
061      return redirect;
062    }
063
064    @Override
065    public int getExpectedHttpResponseCode() {
066      return expectedHttpResponseCode;
067    }
068
069    @Override
070    public String toQueryString() {
071      return NAME + "=" + this;
072    }
073  }
074
075  private static final Domain<Op> DOMAIN = new Domain<Op>(NAME, Op.class);
076
077  /**
078   * Constructor.
079   * @param str a string representation of the parameter value.
080   */
081  public GetOpParam(final String str) {
082    super(DOMAIN, DOMAIN.parse(str));
083  }
084
085  @Override
086  public String getName() {
087    return NAME;
088  }
089}