com.vmware.vapi.protocol.client.http

Class SingleHeaderExtractor

java.lang.Object

com.vmware.vapi.protocol.client.http.SingleHeaderExtractor

All Implemented Interfaces:

HttpResponseAccessor

public class SingleHeaderExtractor
extends java.lang.Object
implements HttpResponseAccessor

Extractor which captures particular singleton HTTP header from the raw REST response.

This extractor assumes that the HTTP header occurs only once in the HTTP response. If it occurs multiple times, the value of only one of the instances will be returned.

Constructor Summary

Constructors

Constructor and Description
SingleHeaderExtractor(java.lang.String headerName) Constructor.

Method Summary

Modifier and Type	Method and Description
void	access(HttpResponse response) Processes the raw HTTP response.
java.lang.String	getHeaderValue() Returns the captured HTTP header value.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleHeaderExtractor

public SingleHeaderExtractor(java.lang.String headerName)

Constructor.

Parameters:

headerName - name of the header to be extracted; must not be null.

Method Detail

access

public void access(HttpResponse response)

Description copied from interface: HttpResponseAccessor

Processes the raw HTTP response.

If the implementation of this method throws a RuntimeException it will be logged and ignored, i.e. it cannot fail the response processing.

Specified by:

access in interface HttpResponseAccessor

Parameters:

response - representing the raw REST/HTTP response

getHeaderValue

public java.lang.String getHeaderValue()

Returns the captured HTTP header value.

Returns:

the value of a single isntance of the specified HTTP header