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.core5.http;
29  
30  /**
31   * Signals that an HTTP exception has occurred.
32   *
33   * @since 4.0
34   */
35  public class HttpException extends Exception {
36  
37      private static final int FIRST_VALID_CHAR = 32;
38      private static final long serialVersionUID = -5437299376222011036L;
39  
40      /**
41       * Converts characters < 32 to hex.
42       *
43       * @param message
44       *            the source string.
45       * @return a converted string.
46       */
47      static String clean(final String message) {
48          final char[] chars = message.toCharArray();
49          int i;
50          // First check to see if need to allocate a new StringBuilder
51          for (i = 0; i < chars.length; i++) {
52              if (chars[i] < FIRST_VALID_CHAR) {
53                  break;
54              }
55          }
56          if (i == chars.length) {
57              return message;
58          }
59          final StringBuilder builder = new StringBuilder(chars.length * 2);
60          for (i = 0; i < chars.length; i++) {
61              final char ch = chars[i];
62              if (ch < FIRST_VALID_CHAR) {
63                  builder.append("[0x");
64                  final String hexString = Integer.toHexString(i);
65                  if (hexString.length() == 1) {
66                      builder.append("0");
67                  }
68                  builder.append(hexString);
69                  builder.append("]");
70              } else {
71                  builder.append(ch);
72              }
73          }
74          return builder.toString();
75      }
76  
77      /**
78       * Creates a new HttpException with a {@code null} detail message.
79       */
80      public HttpException() {
81          super();
82      }
83  
84      /**
85       * Creates a new HttpException with the specified detail message.
86       *
87       * @param message the exception detail message
88       */
89      public HttpException(final String message) {
90          super(clean(message));
91      }
92  
93      /**
94       * Constructs a new HttpException with the specified detail message.
95       *
96       * @param format The exception detail message format; see {@link String#format(String, Object...)}.
97       * @param args The exception detail message arguments; see {@link String#format(String, Object...)}.
98       *
99       * @since 5.0
100      */
101     public HttpException(final String format, final Object... args) {
102         super(HttpException.clean(String.format(format, args)));
103     }
104 
105     /**
106      * Creates a new HttpException with the specified detail message and cause.
107      *
108      * @param message the exception detail message
109      * @param cause the {@code Throwable} that caused this exception, or {@code null}
110      * if the cause is unavailable, unknown, or not a {@code Throwable}
111      */
112     public HttpException(final String message, final Throwable cause) {
113         super(clean(message));
114         initCause(cause);
115     }
116 
117 }