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