com.yourmediashelf.fedora.client.response

Interface FedoraResponse

All Known Implementing Classes:

AddDatastreamResponse, BatchResponse, DatastreamProfileResponse, DescribeRepositoryResponse, FedoraResponseImpl, FindObjectsResponse, GetDatastreamHistoryResponse, GetDatastreamResponse, GetDatastreamsResponse, GetNextPIDResponse, GetObjectHistoryResponse, GetObjectProfileResponse, IngestResponse, ListDatastreamsResponse, ListMethodsResponse, ModifyDatastreamResponse, ObjectDatastreamsResponse, PurgeDatastreamResponse, RiSearchResponse, UploadResponse, ValidateResponse

public interface FedoraResponse

A wrapper for the HTTP response to a FedoraRequest.

Request-specific FedoraResponse implementations should be generally preferred as they provide convenience methods specific to the kind of response. For example, GetNextPIDResponse provides a convenience method that parses the HTTP response an returns a List of the requested pids.

Note that getEntity(Class) and getEntityInputStream() provide access to the underlying response entity, if desired. However, using these methods and the convenience methods that parse the response entity are mutually exclusive, as either will close the underlying InputStream once accessed.

Implementations of FedoraResponse MUST throw a FedoraClientException if the HTTP status code of the response is >= 400.

Author:

Edwin Shin

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the response.
<T> T	getEntity(Class<T> c) Gets the raw response entity.
InputStream	getEntityInputStream() Gets the raw response entity.
int	getStatus()
String	getType() Get the media type of the response;

Method Detail

getStatus

int getStatus()

Returns:

the HTTP Status Code of the response.

getEntityInputStream

InputStream getEntityInputStream()

Gets the raw response entity.

Returns:

the entity response

getEntity

<T> T getEntity(Class<T> c)

Gets the raw response entity.

Returns:

the entity response

getType

String getType()

Get the media type of the response;

Returns:

the media type.

close

void close()

Close the response.

The entity input stream is closed;