org.jvoicexml.event.error

Class BadFetchProtocolResponsecodeError

java.lang.Object

java.lang.Throwable

org.jvoicexml.event.JVoiceXMLEvent

org.jvoicexml.event.ErrorEvent

org.jvoicexml.event.error.BadFetchError

org.jvoicexml.event.error.BadFetchProtocolResponsecodeError

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BadFetchHttpResponsecodeError

public class BadFetchProtocolResponsecodeError
extends BadFetchError

In the case of a fetch failure, the interpreter context must use a detailed event type telling which specific HTTP or other protocol-specific response code was encountered. The value of the response code for HTTP is defined in [RFC2616]. This allows applications to differentially treat a missing document from a prohibited document, for instance. The value of the response code for other protocols (such as HTTPS, RTSP, and so on) is dependent upon the protocol.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jvoicexml.event.error.BadFetchError

EVENT_TYPE

Constructor Summary

Constructors

Constructor and Description
BadFetchProtocolResponsecodeError(java.lang.String usedProtocol, int detectedResponseCode) Constructs a new event with the event type as its detail message.
BadFetchProtocolResponsecodeError(java.lang.String usedProtocol, int detectedResponseCode, java.lang.String message) Constructs a new event with the specified detail message. the given detail message is expanded to the form <getEventType()>: <message>.
BadFetchProtocolResponsecodeError(java.lang.String usedProtocol, int detectedResponseCode, java.lang.String message, java.lang.Throwable cause) Constructs a new event with the specified detail message and cause.
BadFetchProtocolResponsecodeError(java.lang.String usedProtocol, int detectedResponseCode, java.lang.Throwable cause) Constructs a new event with the specified cause and a detail message of (cause==null ?

Method Summary

Modifier and Type	Method and Description
protected void	appendSpecificationDetails(java.lang.StringBuilder str) Appends the protocol and response code to the type.
java.lang.String	getProtocol() Retrieve the protocol.
int	getResponseCode() Retrieve the protocol-specific response code.

Methods inherited from class org.jvoicexml.event.error.BadFetchError

getEventType

Methods inherited from class org.jvoicexml.event.JVoiceXMLEvent

getMessage, isType

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BadFetchProtocolResponsecodeError

public BadFetchProtocolResponsecodeError(java.lang.String usedProtocol,
                                         int detectedResponseCode)

Constructs a new event with the event type as its detail message. The cause is not initialized.

The usedProtocol and the detectedResponseCode are used to construct the event type.

Parameters:

usedProtocol - The used protocol.

detectedResponseCode - The protocol-specific response code.

See Also:

BadFetchError.getEventType()

BadFetchProtocolResponsecodeError

public BadFetchProtocolResponsecodeError(java.lang.String usedProtocol,
                                         int detectedResponseCode,
                                         java.lang.String message)

Constructs a new event with the specified detail message. the given detail message is expanded to the form <getEventType()>: <message>. The cause is not initialized.

The usedProtocol and the detectedResponseCode are used to construct the event type.

Parameters:

usedProtocol - The used protocol.

detectedResponseCode - The protocol-specific response code.

message - The detail message.

See Also:

BadFetchError.getEventType()

BadFetchProtocolResponsecodeError

public BadFetchProtocolResponsecodeError(java.lang.String usedProtocol,
                                         int detectedResponseCode,
                                         java.lang.Throwable cause)

Constructs a new event with the specified cause and a detail message of (cause==null ? getEventType() : cause.toString()) (which typically contains the class and detail message of cause).

The usedProtocol and the detectedResponseCode are used to construct the event type.

Parameters:

usedProtocol - The used protocol.

detectedResponseCode - The protocol-specific response code.

cause - The cause.

See Also:

BadFetchError.getEventType()

BadFetchProtocolResponsecodeError

public BadFetchProtocolResponsecodeError(java.lang.String usedProtocol,
                                         int detectedResponseCode,
                                         java.lang.String message,
                                         java.lang.Throwable cause)

Constructs a new event with the specified detail message and cause.

The usedProtocol and the detectedResponseCode are used to construct the event type.

Parameters:

usedProtocol - The used protocol.

detectedResponseCode - The protocol-specific response code.

message - The detail message.

cause - The cause.

See Also:

BadFetchError.getEventType()

Method Detail

getProtocol

public final java.lang.String getProtocol()

Retrieve the protocol.

Returns:

The protocol.

getResponseCode

public final int getResponseCode()

Retrieve the protocol-specific response code.

Returns:

Protocol-specific response code.

See Also:

getProtocol()

appendSpecificationDetails

protected final void appendSpecificationDetails(java.lang.StringBuilder str)

Appends the protocol and response code to the type. The event type has the following form

<BadFetchError.EVENT_TYPE>.<protocol>.<responseCode>

Appends detail information to the type information.

Overrides:

appendSpecificationDetails in class BadFetchError

Parameters:

str - type prefix.