View Javadoc
1   package org.apache.maven.wagon.shared.http;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.http.Header;
23  import org.apache.http.HttpHost;
24  import org.apache.http.client.config.RequestConfig;
25  import org.apache.http.message.BasicHeader;
26  import org.apache.maven.wagon.Wagon;
27  
28  import java.net.InetAddress;
29  import java.net.UnknownHostException;
30  import java.util.Arrays;
31  import java.util.Map;
32  import java.util.Properties;
33  import java.util.regex.Matcher;
34  import java.util.regex.Pattern;
35  
36  /**
37   * Configuration helper class
38   */
39  public class ConfigurationUtils
40  {
41  
42      private static final String SO_TIMEOUT                  = "http.socket.timeout";
43      private static final String STALE_CONNECTION_CHECK      = "http.connection.stalecheck";
44      private static final String CONNECTION_TIMEOUT          = "http.connection.timeout";
45      private static final String USE_EXPECT_CONTINUE         = "http.protocol.expect-continue";
46      private static final String DEFAULT_PROXY               = "http.route.default-proxy";
47      private static final String LOCAL_ADDRESS               = "http.route.local-address";
48      private static final String PROXY_AUTH_PREF             = "http.auth.proxy-scheme-pref";
49      private static final String TARGET_AUTH_PREF            = "http.auth.target-scheme-pref";
50      private static final String HANDLE_AUTHENTICATION       = "http.protocol.handle-authentication";
51      private static final String ALLOW_CIRCULAR_REDIRECTS    = "http.protocol.allow-circular-redirects";
52      private static final String CONN_MANAGER_TIMEOUT        = "http.conn-manager.timeout";
53      private static final String COOKIE_POLICY               = "http.protocol.cookie-policy";
54      private static final String MAX_REDIRECTS               = "http.protocol.max-redirects";
55      private static final String HANDLE_REDIRECTS            = "http.protocol.handle-redirects";
56      private static final String REJECT_RELATIVE_REDIRECT    = "http.protocol.reject-relative-redirect";
57      private static final String HANDLE_CONTENT_COMPRESSION  = "http.protocol.handle-content-compression";
58      private static final String HANDLE_URI_NORMALIZATION    = "http.protocol.handle-uri-normalization";
59  
60      private static final String COERCE_PATTERN = "%(\\w+),(.+)";
61  
62      public static void copyConfig( HttpMethodConfiguration config, RequestConfig.Builder builder )
63      {
64          builder.setConnectTimeout( config.getConnectionTimeout() );
65          builder.setSocketTimeout( config.getReadTimeout() );
66  
67          Properties params = config.getParams();
68          if ( params != null )
69          {
70  
71              Pattern coercePattern = Pattern.compile( COERCE_PATTERN );
72              for ( Map.Entry entry : params.entrySet() )
73              {
74                  String key = (String) entry.getKey();
75                  String value = (String) entry.getValue();
76                  Matcher matcher = coercePattern.matcher( value );
77                  if ( matcher.matches() )
78                  {
79                      value = matcher.group( 2 );
80                  }
81  
82                  if ( key.equals( SO_TIMEOUT ) )
83                  {
84                      builder.setSocketTimeout( Integer.parseInt( value ) );
85                  }
86                  else if ( key.equals( STALE_CONNECTION_CHECK ) )
87                  {
88                      builder.setStaleConnectionCheckEnabled( Boolean.valueOf( value ) );
89                  }
90                  else if ( key.equals( CONNECTION_TIMEOUT ) )
91                  {
92                      builder.setConnectTimeout( Integer.parseInt( value ) );
93                  }
94                  else if ( key.equals( USE_EXPECT_CONTINUE ) )
95                  {
96                      builder.setExpectContinueEnabled( Boolean.valueOf( value ) );
97                  }
98                  else if ( key.equals( DEFAULT_PROXY ) )
99                  {
100                     builder.setProxy( HttpHost.create( value ) );
101                 }
102                 else if ( key.equals( LOCAL_ADDRESS ) )
103                 {
104                     try
105                     {
106                         builder.setLocalAddress( InetAddress.getByName( value ) );
107                     }
108                     catch ( UnknownHostException ignore )
109                     {
110                         // ignore
111                     }
112                 }
113                 else if ( key.equals( PROXY_AUTH_PREF ) )
114                 {
115                     builder.setProxyPreferredAuthSchemes( Arrays.asList( value.split( "," ) ) );
116                 }
117                 else if ( key.equals( TARGET_AUTH_PREF ) )
118                 {
119                     builder.setTargetPreferredAuthSchemes( Arrays.asList( value.split( "," ) ) );
120                 }
121                 else if ( key.equals( HANDLE_AUTHENTICATION ) )
122                 {
123                     builder.setAuthenticationEnabled( Boolean.valueOf( value ) );
124                 }
125                 else if ( key.equals( ALLOW_CIRCULAR_REDIRECTS ) )
126                 {
127                     builder.setCircularRedirectsAllowed( Boolean.valueOf( value ) );
128                 }
129                 else if ( key.equals( CONN_MANAGER_TIMEOUT ) )
130                 {
131                     builder.setConnectionRequestTimeout( Integer.parseInt( value ) );
132                 }
133                 else if ( key.equals( COOKIE_POLICY ) )
134                 {
135                     builder.setCookieSpec( value );
136                 }
137                 else if ( key.equals( MAX_REDIRECTS ) )
138                 {
139                     builder.setMaxRedirects( Integer.parseInt( value ) );
140                 }
141                 else if ( key.equals( HANDLE_REDIRECTS ) )
142                 {
143                     builder.setRedirectsEnabled( Boolean.valueOf( value ) );
144                 }
145                 else if ( key.equals( REJECT_RELATIVE_REDIRECT ) )
146                 {
147                     builder.setRelativeRedirectsAllowed( !Boolean.valueOf( value ) );
148                 }
149                 else if ( key.equals ( HANDLE_CONTENT_COMPRESSION ) )
150                 {
151                     builder.setContentCompressionEnabled( Boolean.valueOf( value ) );
152                 }
153                 else if ( key.equals ( HANDLE_URI_NORMALIZATION ) )
154                 {
155                     builder.setNormalizeUri( Boolean.valueOf( value ) );
156                 }
157             }
158         }
159     }
160 
161     public static Header[] asRequestHeaders( HttpMethodConfiguration config )
162     {
163         Properties headers = config.getHeaders();
164         if ( headers == null )
165         {
166             return new Header[0];
167         }
168 
169         Header[] result = new Header[headers.size()];
170 
171         int index = 0;
172         for ( Map.Entry entry : headers.entrySet() )
173         {
174             String key = (String) entry.getKey();
175             String value = (String) entry.getValue();
176 
177             Header header = new BasicHeader( key, value );
178             result[index++] = header;
179         }
180 
181         return result;
182     }
183 
184     public static HttpMethodConfiguration merge( HttpMethodConfiguration defaults, HttpMethodConfiguration base,
185                                             HttpMethodConfiguration local )
186     {
187         HttpMethodConfiguration result = merge( defaults, base );
188         return merge( result, local );
189     }
190 
191     public static HttpMethodConfiguration merge( HttpMethodConfiguration base, HttpMethodConfiguration local )
192     {
193         if ( base == null && local == null )
194         {
195             return null;
196         }
197         else if ( base == null )
198         {
199             return local;
200         }
201         else if ( local == null )
202         {
203             return base;
204         }
205         else
206         {
207             HttpMethodConfiguration result = base.copy();
208 
209             if ( local.getConnectionTimeout() != Wagon.DEFAULT_CONNECTION_TIMEOUT )
210             {
211                 result.setConnectionTimeout( local.getConnectionTimeout() );
212             }
213 
214             if ( local.getReadTimeout() != Wagon.DEFAULT_READ_TIMEOUT )
215             {
216                 result.setReadTimeout( local.getReadTimeout() );
217             }
218 
219             if ( local.getHeaders() != null )
220             {
221                 result.getHeaders().putAll( local.getHeaders() );
222             }
223 
224             if ( local.getParams() != null )
225             {
226                 result.getParams().putAll( local.getParams() );
227             }
228 
229             if ( local.getUseDefaultHeaders() != null )
230             {
231                 result.setUseDefaultHeaders( local.isUseDefaultHeaders() );
232             }
233 
234             return result;
235         }
236     }
237 
238 }