com.sap.smp.client.httpc

Class CompositeTextBasedResponseDetector

java.lang.Object

com.sap.smp.client.httpc.CompositeTextBasedResponseDetector

All Implemented Interfaces:

ITextBasedResponseDetector

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

Composite detector capable of executing a series of detectors in order and rewinding the response output streams for each. By convention, if an instance of this type is given a detector from this type then the detectors are taken out from it and added to the list, thereby flattening the hierarchy of detectors.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
CompositeTextBasedResponseDetector(ITextBasedResponseDetector... detectors) Creates a new composite detector given the list of detectors to wrap.

Method Summary

Modifier and Type	Method and Description
static void	appendDetector(IHttpConversation conversation, ITextBasedResponseDetector detector) Convenience method to append a detector to a conversation.
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

CompositeTextBasedResponseDetector

public CompositeTextBasedResponseDetector(ITextBasedResponseDetector... detectors)

Creates a new composite detector given the list of detectors to wrap. In case a CompositeTextBasedResponseDetector instance is found, the detectors inside of it get unwrapped and placed into this one.

Parameters:

detectors - the array of detectors to wrap, can be null

Method Detail

appendDetector

public static void appendDetector(IHttpConversation conversation,
                                  ITextBasedResponseDetector detector)

Convenience method to append a detector to a conversation. In case the conversation already has a detector then a CompositeTextBasedResponseDetector is created with that one and the one in the argument and then it gets set for the conversation. Otherwise the detector in the argument gets simply set.

Parameters:

conversation - the conversation to which the specified detector is to be added, must be non-null

detector - the detector to append, must be non-null

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)