Novell exteNd Web Services SDK API

com.sssw.jbroker.web.portable
Interface ClientRequest

All Superinterfaces:
OutputStream

public interface ClientRequest
extends OutputStream

The ClientRequest class represents the XML RPC request created by the client. It is a specialized output stream.


Method Summary
 Map _getProperties()
          Get request properties
 void _setProperties(Map properties)
          Set request properties
 ClientResponse createResponse(Reader reader)
          Create a client response object from data in Reader
 ClientResponse createResponse(Reader reader, Map mimeParts)
          Create a client response object from data in Reader
 ClientResponse createResponse(Reader reader, Map mimeParts, boolean headerExpected)
          Create a client response object from data in Reader
 void endHeader()
          Ends the SOAP Header element, writes the SOAP BODY element and name of the operation for rpc requests.
 String getMethod()
          Get the method name
 RequestProperty[] getProperties()
          Deprecated. As of JBroker Web 2.0, replaced by _getProperties()
 boolean responseExpected()
          Is the response expected
 void setProperties(RequestProperty[] properties)
          Deprecated. As of JBroker Web 2.0, replaced by _setProperties(Map)
 void setTypeMapper(TypeMapper typeMapper)
          Deprecated. As of jBrokerWeb 2.0 replaced by setTypeMappingRegistry(TypeMappingRegistry)
 void setTypeMappingRegistry(TypeMappingRegistry registry)
          Set the TypeMappingRegistry to be used when marshaling the request parameters
 
Methods inherited from interface com.sssw.jbroker.web.portable.OutputStream
createInputStream, createInputStream, createInputStreamReader, getEncodingStyleURI, getSchemaURI, isDocument, setEncodingStyleURI, size, toByteArray, writeAttachment, writeBoolean, writeBoolean, writeByte, writeByte, writeChar, writeChar, writeContent, writeDouble, writeDouble, writeFloat, writeFloat, writeInt, writeInt, writeLong, writeLong, writeObject, writeObject, writeObject, writeObject, writeShort, writeShort, writeTo
 

Method Detail

getMethod

public String getMethod()
Get the method name

Returns:
the name of the method invoked by this request

responseExpected

public boolean responseExpected()
Is the response expected

Returns:
TRUE if request is configured for a response, FALSE otherwise

createResponse

public ClientResponse createResponse(Reader reader)
                              throws IOException
Create a client response object from data in Reader

Parameters:
reader - the reader from which to read the response data
Throws:
IOException

createResponse

public ClientResponse createResponse(Reader reader,
                                     Map mimeParts)
                              throws IOException
Create a client response object from data in Reader

Parameters:
reader - the reader from which to read the response data
mimeParts - the mimeParts of the response data
Throws:
IOException

createResponse

public ClientResponse createResponse(Reader reader,
                                     Map mimeParts,
                                     boolean headerExpected)
                              throws IOException
Create a client response object from data in Reader

Parameters:
reader - the reader from which to read the response data
mimeParts - the mimeParts of the response data
headerExpected - true if the response contains header element
Throws:
IOException
Since:
jBroker Web 2.1

setProperties

public void setProperties(RequestProperty[] properties)
Deprecated. As of JBroker Web 2.0, replaced by _setProperties(Map)

Set the properties of this request

Parameters:
properties - an array of request properties

_setProperties

public void _setProperties(Map properties)
Set request properties

Parameters:
properties - a Map with request properties

getProperties

public RequestProperty[] getProperties()
Deprecated. As of JBroker Web 2.0, replaced by _getProperties()

Get the properties of this request

Returns:
an array of request properties

_getProperties

public Map _getProperties()
Get request properties

Specified by:
_getProperties in interface OutputStream
Returns:
a Map with request properties

setTypeMapper

public void setTypeMapper(TypeMapper typeMapper)
Deprecated. As of jBrokerWeb 2.0 replaced by setTypeMappingRegistry(TypeMappingRegistry)

Set the TypeMapper to be used when marshaling the request parameters

Parameters:
typeMapper - a type mapper object

setTypeMappingRegistry

public void setTypeMappingRegistry(TypeMappingRegistry registry)
Set the TypeMappingRegistry to be used when marshaling the request parameters

Parameters:
registry - a type mapping registry object

endHeader

public void endHeader()
               throws IOException
Ends the SOAP Header element, writes the SOAP BODY element and name of the operation for rpc requests. This method should be called once all the header elements are already written.

Throws:
IOException
Since:
jBrokerWeb 2.1

Novell exteNd Web Services SDK API

exteNd is a registered trademark of Novell, Inc.
Copyright 1998-2003 Novell, Inc. All Rights Reserved.