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