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