Class HttpStatusCodeException

Namespace

Cuemon.AspNetCore.Http

Assembly

Cuemon.AspNetCore.dll

Provides a base-class for exceptions based on an HTTP status code.

public abstract class HttpStatusCodeException : Exception, ISerializable

Inheritance

object

Exception

HttpStatusCodeException

Implements

ISerializable

Derived

BadRequestException

ConflictException

ForbiddenException

GoneException

ApiKeyException

UserAgentException

InternalServerErrorException

MethodNotAllowedException

NotAcceptableException

NotFoundException

PayloadTooLargeException

PreconditionFailedException

PreconditionRequiredException

TooManyRequestsException

UnauthorizedException

UnsupportedMediaTypeException

Inherited Members

Exception.GetBaseException()

Exception.GetType()

Exception.Data

Exception.HelpLink

Exception.HResult

Exception.InnerException

Exception.Message

Exception.Source

Exception.StackTrace

Exception.TargetSite

Exception.SerializeObjectState

Constructors

HttpStatusCodeException(int, string, Exception)

Initializes a new instance of the HttpStatusCodeException class.

protected HttpStatusCodeException(int statusCode, string message, Exception innerException = null)

Parameters

statusCode int

The HTTP status code to associate with this exception.

message string

The message that describes the HTTP status code.

innerException Exception

The exception that is the cause of the current exception.

HttpStatusCodeException(int, string, string, Exception)

Initializes a new instance of the HttpStatusCodeException class.

protected HttpStatusCodeException(int statusCode, string reasonPhrase, string message, Exception innerException = null)

Parameters

statusCode int

The HTTP status code to associate with this exception.

reasonPhrase string

The HTTP reason phrase to associate with statusCode and this exception.

message string

The message that describes the HTTP status code.

innerException Exception

The exception that is the cause of the current exception.

Properties

Headers

Gets the collection of HTTP response headers.

public IHeaderDictionary Headers { get; }

Property Value

IHeaderDictionary

The collection of HTTP response headers.

ReasonPhrase

Gets the HTTP reason phrase associated with this exception.

public string ReasonPhrase { get; }

Property Value

string

The HTTP reason phrase associated with this exception.

StatusCode

Gets the HTTP status code associated with this exception.

public int StatusCode { get; }

Property Value

int

The HTTP status code associated with this exception.

Methods

ToString()

Returns a string that represents this instance.

public override string ToString()

Returns

string

A string that represents this instance.

TryParse(int, out HttpStatusCodeException)

Attempts to resolve a suitable httpStatusCodeException from the specified statusCode.

public static bool TryParse(int statusCode, out HttpStatusCodeException httpStatusCodeException)

Parameters

statusCode int

The HTTP status code to associate with this exception.

httpStatusCodeException HttpStatusCodeException

When this method returns, contains the by statusCode resolved HttpStatusCodeException, or null if no matches could be made.

Returns

bool

true if an instance of HttpStatusCodeException could be resolved, false otherwise.

TryParse(int, string, out HttpStatusCodeException)

Attempts to resolve a suitable httpStatusCodeException from the specified statusCode.

public static bool TryParse(int statusCode, string message, out HttpStatusCodeException httpStatusCodeException)

Parameters

statusCode int

The HTTP status code to associate with this exception.

message string

The message that describes the HTTP status code.

httpStatusCodeException HttpStatusCodeException

When this method returns, contains the by statusCode resolved HttpStatusCodeException, or null if no matches could be made.

Returns

bool

true if an instance of HttpStatusCodeException could be resolved, false otherwise.

TryParse(int, string, Exception, out HttpStatusCodeException)

Attempts to resolve a suitable httpStatusCodeException from the specified statusCode.

public static bool TryParse(int statusCode, string message, Exception innerException, out HttpStatusCodeException httpStatusCodeException)

Parameters

statusCode int

The HTTP status code to associate with this exception.

message string

The message that describes the HTTP status code.

innerException Exception

The exception that is the cause of the current exception.

httpStatusCodeException HttpStatusCodeException

When this method returns, contains the by statusCode resolved HttpStatusCodeException, or null if no matches could be made.

Returns

bool

true if an instance of HttpStatusCodeException could be resolved, false otherwise.

See Also

Exception