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 GET operation parameter. */
023    public class GetOpParam extends HttpOpParam<GetOpParam.Op> {
024      /** Get operations. */
025      public static enum Op implements HttpOpParam.Op {
026        OPEN(true, HttpURLConnection.HTTP_OK),
027    
028        GETFILESTATUS(false, HttpURLConnection.HTTP_OK),
029        LISTSTATUS(false, HttpURLConnection.HTTP_OK),
030        GETCONTENTSUMMARY(false, HttpURLConnection.HTTP_OK),
031        GETFILECHECKSUM(true, HttpURLConnection.HTTP_OK),
032    
033        GETHOMEDIRECTORY(false, HttpURLConnection.HTTP_OK),
034        GETDELEGATIONTOKEN(false, HttpURLConnection.HTTP_OK, true),
035    
036        /** GET_BLOCK_LOCATIONS is a private unstable op. */
037        GET_BLOCK_LOCATIONS(false, HttpURLConnection.HTTP_OK),
038    
039        NULL(false, HttpURLConnection.HTTP_NOT_IMPLEMENTED);
040    
041        final boolean redirect;
042        final int expectedHttpResponseCode;
043        final boolean requireAuth;
044    
045        Op(final boolean redirect, final int expectedHttpResponseCode) {
046          this(redirect, expectedHttpResponseCode, false);
047        }
048        
049        Op(final boolean redirect, final int expectedHttpResponseCode,
050           final boolean requireAuth) {
051          this.redirect = redirect;
052          this.expectedHttpResponseCode = expectedHttpResponseCode;
053          this.requireAuth = requireAuth;
054        }
055    
056        @Override
057        public HttpOpParam.Type getType() {
058          return HttpOpParam.Type.GET;
059        }
060        
061        @Override
062        public boolean getRequireAuth() {
063          return requireAuth;
064        }
065    
066        @Override
067        public boolean getDoOutput() {
068          return false;
069        }
070    
071        @Override
072        public boolean getRedirect() {
073          return redirect;
074        }
075    
076        @Override
077        public int getExpectedHttpResponseCode() {
078          return expectedHttpResponseCode;
079        }
080    
081        @Override
082        public String toQueryString() {
083          return NAME + "=" + this;
084        }
085      }
086    
087      private static final Domain<Op> DOMAIN = new Domain<Op>(NAME, Op.class);
088    
089      /**
090       * Constructor.
091       * @param str a string representation of the parameter value.
092       */
093      public GetOpParam(final String str) {
094        super(DOMAIN, DOMAIN.parse(str));
095      }
096    
097      @Override
098      public String getName() {
099        return NAME;
100      }
101    }