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 POST operation parameter. */
023public class PostOpParam extends HttpOpParam<PostOpParam.Op> {
024  /** Post operations. */
025  public enum Op implements HttpOpParam.Op {
026    APPEND(true, HttpURLConnection.HTTP_OK),
027
028    CONCAT(false, HttpURLConnection.HTTP_OK),
029
030    TRUNCATE(false, HttpURLConnection.HTTP_OK),
031
032    UNSETSTORAGEPOLICY(false, HttpURLConnection.HTTP_OK),
033
034    NULL(false, HttpURLConnection.HTTP_NOT_IMPLEMENTED);
035
036    final boolean doOutputAndRedirect;
037    final int expectedHttpResponseCode;
038
039    Op(final boolean doOutputAndRedirect, final int expectedHttpResponseCode) {
040      this.doOutputAndRedirect = doOutputAndRedirect;
041      this.expectedHttpResponseCode = expectedHttpResponseCode;
042    }
043
044    @Override
045    public Type getType() {
046      return Type.POST;
047    }
048
049    @Override
050    public boolean getRequireAuth() {
051      return false;
052    }
053
054    @Override
055    public boolean getDoOutput() {
056      return doOutputAndRedirect;
057    }
058
059    @Override
060    public boolean getRedirect() {
061      return doOutputAndRedirect;
062    }
063
064    @Override
065    public int getExpectedHttpResponseCode() {
066      return expectedHttpResponseCode;
067    }
068
069    /** @return a URI query string. */
070    @Override
071    public String toQueryString() {
072      return NAME + "=" + this;
073    }
074  }
075
076  private static final Domain<Op> DOMAIN = new Domain<>(NAME, Op.class);
077
078  /**
079   * Constructor.
080   * @param str a string representation of the parameter value.
081   */
082  public PostOpParam(final String str) {
083    super(DOMAIN, DOMAIN.parse(str));
084  }
085
086  @Override
087  public String getName() {
088    return NAME;
089  }
090}