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