Package org.apache.commons.httpclient

Class HttpException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.apache.commons.httpclient.HttpException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HttpContentTooLargeException, HttpRecoverableException, ProtocolException, URIException

@Deprecated
public class HttpException
extends IOException

Deprecated.

Jakarta Commons HttpClient 3.x is deprecated in the Jenkins project. It is not recommended to use it in any new code. Instead, use HTTP client API plugins as a dependency in your code. E.g. Apache HttpComponents Client API 4.x Plugin or Async HTTP Client Plugin.

Signals that an HTTP or HttpClient exception has occurred.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
HttpException()	Deprecated. Creates a new HttpException with a null detail message.
HttpException(String message)	Deprecated. Creates a new HttpException with the specified detail message.
HttpException(String message, Throwable cause)	Deprecated. Creates a new HttpException with the specified detail message and cause.

Method Summary

Modifier and Type	Method	Description
Throwable	getCause()	Deprecated. Return the Throwable that caused this exception, or null if the cause is unavailable, unknown, or not a Throwable.
String	getReason()	Deprecated. HttpClient no longer uses this for itself.
int	getReasonCode()	Deprecated. HttpClient no longer uses this for itself.
void	printStackTrace()	Deprecated. Print this HttpException and its stack trace to the standard error stream.
void	printStackTrace(PrintStream s)	Deprecated. Print this HttpException and its stack trace to the specified print stream.
void	printStackTrace(PrintWriter s)	Deprecated. Print this HttpException and its stack trace to the specified print writer.
void	setReason(String reason)	Deprecated. HttpClient no longer uses this for itself.
void	setReasonCode(int code)	Deprecated. HttpClient no longer uses this for itself.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

HttpException

public HttpException()

Deprecated.

Creates a new HttpException with a null detail message.

HttpException

public HttpException(String message)

Deprecated.

Creates a new HttpException with the specified detail message.

Parameters:

message - the exception detail message

HttpException

public HttpException(String message,
 Throwable cause)

Deprecated.

Creates a new HttpException with the specified detail message and cause.

Parameters:

message - the exception detail message

cause - the Throwable that caused this exception, or null if the cause is unavailable, unknown, or not a Throwable

Since:

3.0

Method Details

getCause

public Throwable getCause()

Deprecated.

Return the Throwable that caused this exception, or null if the cause is unavailable, unknown, or not a Throwable.

Overrides:

getCause in class Throwable

Returns:

the Throwable that caused this exception, or null if the cause is unavailable, unknown, or not a Throwable

Since:

3.0

printStackTrace

public void printStackTrace()

Deprecated.

Print this HttpException and its stack trace to the standard error stream.

Overrides:

printStackTrace in class Throwable

Since:

3.0

printStackTrace

public void printStackTrace(PrintStream s)

Deprecated.

Print this HttpException and its stack trace to the specified print stream.

Overrides:

printStackTrace in class Throwable

Parameters:

s - the PrintStream to which the exception and its stack trace should be written

Since:

3.0

printStackTrace

public void printStackTrace(PrintWriter s)

Deprecated.

Print this HttpException and its stack trace to the specified print writer.

Overrides:

printStackTrace in class Throwable

Parameters:

s - the PrintWriter to which the exception and its stack trace should be written

Since:

3.0

setReason

public void setReason(String reason)

Deprecated.

HttpClient no longer uses this for itself. It is only provided for compatibility with existing clients, and will be removed in a future release.

Sets the text description of the reason for an exception.

Parameters:

reason - The reason for the exception.

getReason

public String getReason()

Deprecated.

HttpClient no longer uses this for itself. It is only provided for compatibility with existing clients, and will be removed in a future release.

Get the text description of the reason for an exception.

setReasonCode

public void setReasonCode(int code)

Deprecated.

HttpClient no longer uses this for itself. It is only provided for compatibility with existing clients, and will be removed in a future release.

Sets the status code description of the reason for an exception.

Parameters:

code - The reason for the exception. This is intended to be an HTTP status code.

getReasonCode

public int getReasonCode()

Deprecated.

HttpClient no longer uses this for itself. It is only provided for compatibility with existing clients, and will be removed in a future release.

Get the status code description of the reason for an exception.