com.sap.smp.client.httpc

Class XmlContentResponseDetector

java.lang.Object

com.sap.smp.client.httpc.XmlContentResponseDetector

All Implemented Interfaces:

ITextBasedResponseDetector

public final class XmlContentResponseDetector
extends java.lang.Object
implements ITextBasedResponseDetector

Convenience class detecting the encoding of XML-based responses. By default, this recognizes content types given via the constructor and returns the charset as defined in the opening XML processing instruction of the response.

Constructor Summary

Constructors

Constructor and Description
XmlContentResponseDetector(java.lang.String... contentTypes) Creates a new detector with the specified array of content types to look for.

Method Summary

Modifier and Type	Method and Description
java.nio.charset.Charset	performDetection(IReceiveEvent event) Performs the detection of the charset of the response described by the event.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlContentResponseDetector

public XmlContentResponseDetector(java.lang.String... contentTypes)

Creates a new detector with the specified array of content types to look for. An actual content type matches in case it starts with one of the entries in the specified array.

Passing null or an empty array makes this detector effectively unnecessary as it will not recognize anything.

Parameters:

contentTypes - the array of content types to treat as XML, can be null

Method Detail

performDetection

public java.nio.charset.Charset performDetection(IReceiveEvent event)
                                          throws java.io.IOException

Description copied from interface: ITextBasedResponseDetector

Performs the detection of the charset of the response described by the event. As the outcome of this method invocation will decide whether the output is textual the specified event's IReceiveEvent.getReader() method is guaranteed to return null.

Just like for response filters, the conversation flow allows this method to sniff into the input stream which will be rewound after the invocation of this method.

Specified by:

performDetection in interface ITextBasedResponseDetector

Parameters:

event - the receive event (containing all information except for the reader), must be non-null

Returns:

the detected charset or null in case this detector couldn't determine whether the input is text-based or not

Throws:

java.io.IOException - in case of any errors during detection (typically resulting from sniffing into the response stream)