View Javadoc
1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.hc.client5.http.async.methods;
29  
30  import java.net.URI;
31  
32  import org.apache.hc.client5.http.config.Configurable;
33  import org.apache.hc.client5.http.config.RequestConfig;
34  import org.apache.hc.core5.http.HttpHost;
35  import org.apache.hc.core5.http.message.BasicHttpRequest;
36  import org.apache.hc.core5.net.URIAuthority;
37  
38  /**
39   * HTTP request message with a custom configuration.
40   *
41   * @since 5.0
42   */
43  public class ConfigurableHttpRequest extends BasicHttpRequest implements Configurable {
44  
45      private static final long serialVersionUID = 1L;
46      private RequestConfig requestConfig;
47  
48      /**
49       * Constructs a new request message with the given method and request path.
50       *
51       * @param method request method.
52       * @param path request path.
53       */
54      public ConfigurableHttpRequest(final String method, final String path) {
55          super(method, path);
56      }
57  
58      /**
59       * Constructs a new request message with the given method, host, and request path.
60       *
61       * @param method request method.
62       * @param host request host.
63       * @param path request path.
64       */
65      public ConfigurableHttpRequest(final String method, final HttpHost host, final String path) {
66          super(method, host, path);
67      }
68  
69      /**
70       * Constructs a new request message with the given method, scheme, authority, and request path.
71       *
72       * @param method request method.
73       * @param scheme request host.
74       * @param authority request URI authority.
75       * @param path request path.
76       * @since 5.1
77       */
78      public ConfigurableHttpRequest(final String method, final String scheme, final URIAuthority authority, final String path) {
79          super(method, scheme, authority, path);
80      }
81  
82      /**
83       * Constructs a new request message with the given method, and request URI.
84       *
85       * @param method request method.
86       * @param requestUri request URI.
87       * @since 5.1
88       */
89      public ConfigurableHttpRequest(final String method, final URI requestUri) {
90          super(method, requestUri);
91      }
92  
93      @Override
94      public RequestConfig getConfig() {
95          return requestConfig;
96      }
97  
98      /**
99       * Sets the request configuration.
100      *
101      * @param requestConfig the request configuration.
102      */
103     public void setConfig(final RequestConfig requestConfig) {
104         this.requestConfig = requestConfig;
105     }
106 
107 }
108