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 PutOpParam extends HttpOpParam<PutOpParam.Op> {
024  /** Put operations. */
025  public enum Op implements HttpOpParam.Op {
026    CREATE(true, HttpURLConnection.HTTP_CREATED),
027
028    MKDIRS(false, HttpURLConnection.HTTP_OK),
029    CREATESYMLINK(false, HttpURLConnection.HTTP_OK),
030    RENAME(false, HttpURLConnection.HTTP_OK),
031    SETREPLICATION(false, HttpURLConnection.HTTP_OK),
032
033    SETOWNER(false, HttpURLConnection.HTTP_OK),
034    SETPERMISSION(false, HttpURLConnection.HTTP_OK),
035    SETTIMES(false, HttpURLConnection.HTTP_OK),
036
037    RENEWDELEGATIONTOKEN(false, HttpURLConnection.HTTP_OK, true),
038    CANCELDELEGATIONTOKEN(false, HttpURLConnection.HTTP_OK, true),
039
040    MODIFYACLENTRIES(false, HttpURLConnection.HTTP_OK),
041    REMOVEACLENTRIES(false, HttpURLConnection.HTTP_OK),
042    REMOVEDEFAULTACL(false, HttpURLConnection.HTTP_OK),
043    REMOVEACL(false, HttpURLConnection.HTTP_OK),
044    SETACL(false, HttpURLConnection.HTTP_OK),
045
046    SETXATTR(false, HttpURLConnection.HTTP_OK),
047    REMOVEXATTR(false, HttpURLConnection.HTTP_OK),
048
049    ALLOWSNAPSHOT(false, HttpURLConnection.HTTP_OK),
050    DISALLOWSNAPSHOT(false, HttpURLConnection.HTTP_OK),
051    CREATESNAPSHOT(false, HttpURLConnection.HTTP_OK),
052    RENAMESNAPSHOT(false, HttpURLConnection.HTTP_OK),
053    SETSTORAGEPOLICY(false, HttpURLConnection.HTTP_OK),
054
055    NULL(false, HttpURLConnection.HTTP_NOT_IMPLEMENTED);
056
057    final boolean doOutputAndRedirect;
058    final int expectedHttpResponseCode;
059    final boolean requireAuth;
060
061    Op(final boolean doOutputAndRedirect, final int expectedHttpResponseCode) {
062      this(doOutputAndRedirect, expectedHttpResponseCode, false);
063    }
064
065    Op(final boolean doOutputAndRedirect, final int expectedHttpResponseCode,
066        final boolean requireAuth) {
067      this.doOutputAndRedirect = doOutputAndRedirect;
068      this.expectedHttpResponseCode = expectedHttpResponseCode;
069      this.requireAuth = requireAuth;
070    }
071
072    @Override
073    public HttpOpParam.Type getType() {
074      return HttpOpParam.Type.PUT;
075    }
076
077    @Override
078    public boolean getRequireAuth() {
079      return requireAuth;
080    }
081
082    @Override
083    public boolean getDoOutput() {
084      return doOutputAndRedirect;
085    }
086
087    @Override
088    public boolean getRedirect() {
089      return doOutputAndRedirect;
090    }
091
092    @Override
093    public int getExpectedHttpResponseCode() {
094      return expectedHttpResponseCode;
095    }
096
097    @Override
098    public String toQueryString() {
099      return NAME + "=" + this;
100    }
101  }
102
103  private static final Domain<Op> DOMAIN = new Domain<>(NAME, Op.class);
104
105  /**
106   * Constructor.
107   * @param str a string representation of the parameter value.
108   */
109  public PutOpParam(final String str) {
110    super(DOMAIN, DOMAIN.parse(str));
111  }
112
113  @Override
114  public String getName() {
115    return NAME;
116  }
117}