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     */
018    package org.apache.hadoop.hdfs.web.resources;
019    
020    import java.net.HttpURLConnection;
021    
022    /** Http POST operation parameter. */
023    public class PutOpParam extends HttpOpParam<PutOpParam.Op> {
024      /** Put operations. */
025      public static 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        CREATESNAPSHOT(false, HttpURLConnection.HTTP_OK),
050        RENAMESNAPSHOT(false, HttpURLConnection.HTTP_OK),
051        
052        NULL(false, HttpURLConnection.HTTP_NOT_IMPLEMENTED);
053    
054        final boolean doOutputAndRedirect;
055        final int expectedHttpResponseCode;
056        final boolean requireAuth;
057    
058        Op(final boolean doOutputAndRedirect, final int expectedHttpResponseCode) {
059          this(doOutputAndRedirect, expectedHttpResponseCode, false);
060        }
061        
062        Op(final boolean doOutputAndRedirect, final int expectedHttpResponseCode,
063           final boolean requireAuth) {
064          this.doOutputAndRedirect = doOutputAndRedirect;
065          this.expectedHttpResponseCode = expectedHttpResponseCode;
066          this.requireAuth = requireAuth;
067        }
068    
069        @Override
070        public HttpOpParam.Type getType() {
071          return HttpOpParam.Type.PUT;
072        }
073        
074        @Override
075        public boolean getRequireAuth() {
076          return requireAuth;
077        }
078    
079        @Override
080        public boolean getDoOutput() {
081          return doOutputAndRedirect;
082        }
083    
084        @Override
085        public boolean getRedirect() {
086          return doOutputAndRedirect;
087        }
088    
089        @Override
090        public int getExpectedHttpResponseCode() {
091          return expectedHttpResponseCode;
092        }
093    
094        @Override
095        public String toQueryString() {
096          return NAME + "=" + this;
097        }
098      }
099    
100      private static final Domain<Op> DOMAIN = new Domain<Op>(NAME, Op.class);
101    
102      /**
103       * Constructor.
104       * @param str a string representation of the parameter value.
105       */
106      public PutOpParam(final String str) {
107        super(DOMAIN, DOMAIN.parse(str));
108      }
109    
110      @Override
111      public String getName() {
112        return NAME;
113      }
114    }