Skip navigation links

Oracle® WebCenter Content Remote Intradoc Client (RIDC) Java API Reference
11g Release 1 (11.1)

E17274-03


oracle.stellent.ridc.protocol
Class ServiceResponse

java.lang.Object
  extended by oracle.stellent.ridc.protocol.ServiceResponse


public class ServiceResponse
extends java.lang.Object

Represents a response from the Content Server


Nested Class Summary
static class ServiceResponse.ResponseType
           

 

Constructor Summary
ServiceResponse(DataFactory dataFactory, java.lang.String encoding, java.util.Map<java.lang.String,java.lang.String> headers, java.io.InputStream inputStream, ServiceResponse.ResponseType type)
           

 

Method Summary
 void close()
          Close this response.
 java.lang.String getHeader(java.lang.String name)
          Retrieve the header by name
 java.util.Collection<java.lang.String> getHeaderNames()
           
 DataBinder getResponseAsBinder()
          Convert the response stream to a data binder
 DataBinder getResponseAsBinder(boolean checkErrors)
          Convert the response stream to a data binder
 java.lang.String getResponseAsString()
           
 java.io.InputStream getResponseStream()
           
 ServiceResponse.ResponseType getResponseType()
           
 boolean isReleased()
           
 void setCloseMethod(CloseNotifyInputStream.CloseMethod closeMethod)
          Set the method to call upon closure of the stream
 void setResponseStream(java.io.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 Detail

ServiceResponse

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

Method Detail

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 java.lang.String getHeader(java.lang.String name)
Retrieve the header by name
Parameters:
name - the header name
Returns:
the value or null if not found

getHeaderNames

public java.util.Collection<java.lang.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(java.io.InputStream inputStream)

getResponseStream

public java.io.InputStream getResponseStream()

getResponseAsString

public java.lang.String getResponseAsString()
                                     throws java.io.IOException
Throws:
java.io.IOException

getResponseType

public ServiceResponse.ResponseType getResponseType()

close

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

Skip navigation links

Oracle® WebCenter Content Remote Intradoc Client (RIDC) Java API Reference
11g Release 1 (11.1)

E17274-03


Copyright © 2008, 2011, Oracle and/or its affiliates. All rights reserved.