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        GETACLSTATUS(false, HttpURLConnection.HTTP_OK),
039    
040        NULL(false, HttpURLConnection.HTTP_NOT_IMPLEMENTED);
041    
042        final boolean redirect;
043        final int expectedHttpResponseCode;
044        final boolean requireAuth;
045    
046        Op(final boolean redirect, final int expectedHttpResponseCode) {
047          this(redirect, expectedHttpResponseCode, false);
048        }
049        
050        Op(final boolean redirect, final int expectedHttpResponseCode,
051           final boolean requireAuth) {
052          this.redirect = redirect;
053          this.expectedHttpResponseCode = expectedHttpResponseCode;
054          this.requireAuth = requireAuth;
055        }
056    
057        @Override
058        public HttpOpParam.Type getType() {
059          return HttpOpParam.Type.GET;
060        }
061        
062        @Override
063        public boolean getRequireAuth() {
064          return requireAuth;
065        }
066    
067        @Override
068        public boolean getDoOutput() {
069          return false;
070        }
071    
072        @Override
073        public boolean getRedirect() {
074          return redirect;
075        }
076    
077        @Override
078        public int getExpectedHttpResponseCode() {
079          return expectedHttpResponseCode;
080        }
081    
082        @Override
083        public String toQueryString() {
084          return NAME + "=" + this;
085        }
086      }
087    
088      private static final Domain<Op> DOMAIN = new Domain<Op>(NAME, Op.class);
089    
090      /**
091       * Constructor.
092       * @param str a string representation of the parameter value.
093       */
094      public GetOpParam(final String str) {
095        super(DOMAIN, DOMAIN.parse(str));
096      }
097    
098      @Override
099      public String getName() {
100        return NAME;
101      }
102    }