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