Package com.onshape.api.types

Class InputStreamWithHeaders

java.lang.Object

com.onshape.api.types.InputStreamWithHeaders

public class InputStreamWithHeaders
extends Object

Captures the InputStream from a response, together with the response headers

Author:

Peter Harman peter.harman@cae.tech

Constructor Summary

Constructors

Constructor	Description
InputStreamWithHeaders(InputStream inputStream, javax.ws.rs.core.MultivaluedMap<String,Object> headers)

Method Summary

Modifier and Type	Method	Description
String	getContentEncoding()	Get the Content-Encoding of the returned InputStream
String	getContentType()	Get the Content-Type of the returned InputStream
InputStream	getDecompressedInputStream()	Returns an InputStream, decompressing the raw InputStream if it had been gzip compressed.
javax.ws.rs.core.MultivaluedMap<String,Object>	getHeaders()	Get the headers returned from Onshape
String	getHeaderString(String header)	Get the value of a particular header
InputStream	getInputStream()	Returns the InputStream as received, which may or may not be gzip compressed.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputStreamWithHeaders

public InputStreamWithHeaders(InputStream inputStream,
                              javax.ws.rs.core.MultivaluedMap<String,Object> headers)

Method Detail

getInputStream

public InputStream getInputStream()

Returns the InputStream as received, which may or may not be gzip compressed.

Returns:

InputStream matching the Content-Type and Content-Encoding

getDecompressedInputStream

public InputStream getDecompressedInputStream()
                                       throws IOException

Returns an InputStream, decompressing the raw InputStream if it had been gzip compressed.

Returns:

InputStream matching the Content-Type

Throws:

IOException - On error during decompression

getHeaders

public javax.ws.rs.core.MultivaluedMap<String,Object> getHeaders()

Get the headers returned from Onshape

Returns:

MultivaluedMap of headers

getHeaderString

public String getHeaderString(String header)

Get the value of a particular header

Parameters:

header - The name of the header of interest

Returns:

null if the header is not defined, an empty String if it is empty, or a String joining each header value with ','

getContentType

public String getContentType()

Get the Content-Type of the returned InputStream

Returns:

A String of the Content-Type, or null if it is not defined

getContentEncoding

public String getContentEncoding()

Get the Content-Encoding of the returned InputStream

Returns:

A String of the Content-Encoding, or null if it is not defined