Package oracle.stellent.ridc.protocol

Class ServiceResponse

java.lang.Object

oracle.stellent.ridc.protocol.ServiceResponse

@Exported
public class ServiceResponse
extends Object

Represents a response from the Content Server

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ServiceResponse.ResponseType

Constructor Summary

Constructors

Constructor	Description
ServiceResponse(DataFactory dataFactory, String encoding, Map<String,String> headers, InputStream inputStream, ServiceResponse.ResponseType type)

Method Summary

Modifier and Type	Method	Description
void	close()	Close this response.
String	getHeader(String name)	Retrieve the header by name
Collection<String>	getHeaderNames()
DataBinder	getResponseAsBinder()	Convert the response stream to a data binder
DataBinder	getResponseAsBinder(boolean checkErrors)	Convert the response stream to a data binder
String	getResponseAsString()
InputStream	getResponseStream()
ServiceResponse.ResponseType	getResponseType()
boolean	isReleased()
void	setCloseMethod(CloseNotifyInputStream.CloseMethod closeMethod)	Set the method to call upon closure of the stream
void	setResponseStream(InputStream inputStream)
void	setServiceLog(ServiceLog serviceLog)

Methods inherited from class java.lang.Object

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

Constructor Details

ServiceResponse

public ServiceResponse(DataFactory dataFactory,
 String encoding,
 Map<String,String> headers,
 InputStream inputStream,
 ServiceResponse.ResponseType type)

Method Details

setServiceLog

public void setServiceLog(ServiceLog serviceLog)

setCloseMethod

public void setCloseMethod(CloseNotifyInputStream.CloseMethod closeMethod)

Set the method to call upon closure of the stream

Parameters:

closeMethod - the close method

isReleased

public boolean isReleased()

Returns:

true if the connection is released

getHeader

public String getHeader(String name)

Retrieve the header by name

Parameters:

name - the header name

Returns:

the value or null if not found

getHeaderNames

public Collection<String> getHeaderNames()

Returns:

a collection of the header names

getResponseAsBinder

public DataBinder getResponseAsBinder()
                               throws IdcClientException

Convert the response stream to a data binder

Returns:

the response as a data binder

Throws:

IdcClientException

getResponseAsBinder

public DataBinder getResponseAsBinder(boolean checkErrors)
                               throws IdcClientException

Convert the response stream to a data binder

Parameters:

checkErrors - true to examine the binder for errors

Returns:

the data binder

Throws:

IdcClientException

setResponseStream

public void setResponseStream(InputStream inputStream)

getResponseStream

public InputStream getResponseStream()

getResponseAsString

public String getResponseAsString()
                           throws IOException

Throws:

IOException

getResponseType

public ServiceResponse.ResponseType getResponseType()

close

public void close()

Close this response. Shortcut for calling close on the getResponseStream() object.