com.sssw.jbroker.web.portable
Interface InputStream

All Known Subinterfaces:

ClientResponse, ServerRequest

public interface InputStream

The XML RPC Input Stream. The input stream is used by marshalers to read data from the underlying XML buffer.

Field Summary

static int	NEXT_ELEMENT constant for next element
static int	SOAP_BODY constant for SOAP:BODY element
static int	SOAP_HEADER constant for SOAP:HEADER element

Method Summary

void	close() Close the input stream and free resources.
Attributes	getAttributes() Provides access to the list of attributes of the current XML element
String	getEncodingStyleURI() Get the current Encoding Style
QName	getQName() Get QName of the last object read.
boolean	isDocument() Determine whether stream is document oriented
QName	peek() Peek the QName of the next tag
Object	readAttachment(String nsuri, String name, Class javaType) Read attachment Object
boolean	readBoolean() Deprecated. As of JBroker Web 1.1, replaced by readBoolean(String name)
boolean	readBoolean(String name) Read a boolean from the stream with name
byte	readByte() Deprecated. As of JBroker Web 1.1, replaced by readByte(String)
byte	readByte(String name) Read a byte from the stream with name
char	readChar() Deprecated. As of JBroker Web 1.1, replaced by readChar(String name)
char	readChar(String name) Read a char from the stream with name
String	readContent() Get the content of the present tag
double	readDouble() Deprecated. As of JBroker Web 1.1, replaced by readDouble(String name)
double	readDouble(String name) Read a double from the stream with name
float	readFloat() Deprecated. As of JBroker Web 1.1, replaced by readFloat(String name)
float	readFloat(String name) Read a float from the stream with name
int	readInt() Deprecated. As of JBroker Web 1.1, replaced by readInt(String name)
int	readInt(String name) Read an integer from the stream with name
long	readLong() Deprecated. As of JBroker Web 1.1, replaced by readLong(String name)
long	readLong(String name) Read a long from the stream with name
Object	readObject() Deprecated. As of JBroker Web 1.1, replaced by readObject(Class, String)
Object	readObject(Class expectedType) Deprecated. As of JBroker Web 1.1, replaced by readObject(Class, String)
Object	readObject(Class expectedType, String name) Read an object from the stream with expected type and name
Object	readObject(Class expectedType, String namespace, String lname) Read an object from the stream with expected type and QName
Object	readObject(Class expectedType, String namespace, String lname, String typeNamespace, String typeLocalName) Read an object from the stream with expected type and QName
short	readShort() Deprecated. As of JBroker Web 1.1, replaced by readShort(String name)
short	readShort(String name) Read a short from the stream with name
String	setEncodingStyleURI(String encodingStyleURI) Set the Encoding Style on the stream
void	setMixedContent(boolean mixed) Set the mixed content mode for input stream

Field Detail

SOAP_BODY

public static final int SOAP_BODY

constant for SOAP:BODY element

See Also:

Constant Field Values

SOAP_HEADER

public static final int SOAP_HEADER

constant for SOAP:HEADER element

See Also:

Constant Field Values

NEXT_ELEMENT

public static final int NEXT_ELEMENT

constant for next element

See Also:

Constant Field Values

Method Detail

readByte

public byte readByte()
              throws IOException

Deprecated. As of JBroker Web 1.1, replaced by readByte(String)

Read a byte from the stream

Throws:

IOException - if an I/O exception occurred during read

readByte

public byte readByte(String name)
              throws IOException

Read a byte from the stream with name

Parameters:

name - of the byte to read

Throws:

IOException - if an I/O exception occurred during read

Since:

jBroker Web 1.1

readChar

public char readChar()
              throws IOException

Deprecated. As of JBroker Web 1.1, replaced by readChar(String name)

Read a char from the stream

Throws:

IOException - if an I/O exception occurred during read

readChar

public char readChar(String name)
              throws IOException

Read a char from the stream with name

Parameters:

name - of the char to read

Throws:

IOException - if an I/O exception occurred during read

Since:

JBroker Web 1.1

readBoolean

public boolean readBoolean()
                    throws IOException

Deprecated. As of JBroker Web 1.1, replaced by readBoolean(String name)

Read a boolean from the stream

Throws:

IOException - if an I/O exception occurred during read

readBoolean

public boolean readBoolean(String name)
                    throws IOException

Read a boolean from the stream with name

Parameters:

name - of the boolean to read

Throws:

IOException - if an I/O exception occurred during read

Since:

JBroker Web 1.1

readInt

public int readInt()
            throws IOException

Deprecated. As of JBroker Web 1.1, replaced by readInt(String name)

Read an integer from the stream

Throws:

IOException - if an I/O exception occurred during read

readInt

public int readInt(String name)
            throws IOException

Read an integer from the stream with name

Parameters:

name - of the integer to read

Throws:

IOException - if an I/O exception occurred during read

Since:

JBroker Web 1.1

readShort

public short readShort()
                throws IOException

Deprecated. As of JBroker Web 1.1, replaced by readShort(String name)

Read a short from the stream

Throws:

IOException - if an I/O exception occurred during read

readShort

public short readShort(String name)
                throws IOException

Read a short from the stream with name

Parameters:

name - of the short to read

Throws:

IOException - if an I/O exception occurred during read

Since:

JBroker Web 1.1

readLong

public long readLong()
              throws IOException

Deprecated. As of JBroker Web 1.1, replaced by readLong(String name)

Read a long from the stream

Throws:

IOException - if an I/O exception occurred during read

readLong

public long readLong(String name)
              throws IOException

Read a long from the stream with name

Parameters:

name - of the long to read

Throws:

IOException - if an I/O exception occurred during read

Since:

JBroker Web 1.1

readFloat

public float readFloat()
                throws IOException

Deprecated. As of JBroker Web 1.1, replaced by readFloat(String name)

Read a float from the stream

Throws:

IOException - if an I/O exception occurred during read

readFloat

public float readFloat(String name)
                throws IOException

Read a float from the stream with name

Parameters:

name - of the float to read

Throws:

IOException - if an I/O exception occurred during read

Since:

JBroker Web 1.1

readDouble

public double readDouble()
                  throws IOException

Deprecated. As of JBroker Web 1.1, replaced by readDouble(String name)

Read a double from the stream

Throws:

IOException - if an I/O exception occurred during read

readDouble

public double readDouble(String name)
                  throws IOException

Read a double from the stream with name

Parameters:

name - of the double to read

Throws:

IOException - if an I/O exception occurred during read

Since:

JBroker Web 1.1

readObject

public Object readObject()
                  throws IOException

Deprecated. As of JBroker Web 1.1, replaced by readObject(Class, String)

Read an object from the stream

Throws:

IOException - if an I/O exception occurred during read

readObject

public Object readObject(Class expectedType)
                  throws IOException

Deprecated. As of JBroker Web 1.1, replaced by readObject(Class, String)

Read an object from the stream with expected type

Parameters:

expectedType - the expected type of the object to read

Throws:

IOException - if an I/O exception occurred during read

readObject

public Object readObject(Class expectedType,
                         String name)
                  throws IOException

Read an object from the stream with expected type and name

Parameters:

expectedType - the expected type of the object to read

name - of the object to read

Throws:

IOException - if an I/O exception occurred during read

Since:

JBroker Web 1.1

readObject

public Object readObject(Class expectedType,
                         String namespace,
                         String lname)
                  throws IOException

Read an object from the stream with expected type and QName

Parameters:

expectedType - the expected type of the object to read

namespace - the namespace of the object to read

lname - local name of the object to read

Throws:

IOException - if an I/O exception occurred during read

Since:

JBroker Web 1.1

readObject

public Object readObject(Class expectedType,
                         String namespace,
                         String lname,
                         String typeNamespace,
                         String typeLocalName)
                  throws IOException

Read an object from the stream with expected type and QName

Parameters:

expectedType - the expected type of the object to read

typeNamespace - namespace of object's xml type

typeLocalName - local name of object's xml type

Throws:

IOException - if an I/O exception occurred during read

Since:

JBroker Web 1.1

getAttributes

public Attributes getAttributes()
                         throws IOException

Provides access to the list of attributes of the current XML element

Returns:

an Attributes object

Throws:

IOException - if an I/O exception occurred during read

getQName

public QName getQName()
               throws IOException

Get QName of the last object read. Within the marshaler, it is the QName of the current object.

Returns:

a QName object representing the last object read

Throws:

IOException - if an I/O exception occurred during read

peek

public QName peek()
           throws IOException

Peek the QName of the next tag

Returns:

the QName of next object

Throws:

IOException - if an I/O exception occurred during read

readContent

public String readContent()
                   throws IOException

Get the content of the present tag

Returns:

a string representation of the present tag

Throws:

IOException - if an I/O exception occurred during read

setEncodingStyleURI

public String setEncodingStyleURI(String encodingStyleURI)

Set the Encoding Style on the stream

Parameters:

encodingStyleURI - the new Encoding Style to use

Returns:

previous Encoding Style

getEncodingStyleURI

public String getEncodingStyleURI()

Get the current Encoding Style

Returns:

current Encoding Style

isDocument

public boolean isDocument()

Determine whether stream is document oriented

Returns:

TRUE if document oriented, FALSE otherwise

readAttachment

public Object readAttachment(String nsuri,
                             String name,
                             Class javaType)
                      throws IOException

Read attachment Object

Parameters:

nsuri - URI of the element

name - name of the element

javaType - class of the mime to be read

Returns:

Object the mime object from mime part

Throws:

IOException - if an I/O exception while reading attachment

setMixedContent

public void setMixedContent(boolean mixed)
                     throws IOException

Set the mixed content mode for input stream

Parameters:

mixed - boolean to specify mixed content mode

Returns:

boolean representing the present mixed content mode

Throws:

IOException - if an I/O exception occurs

Since:

jBroker Web 2.1

close

public void close()
           throws IOException

Close the input stream and free resources.

Throws:

IOException

Since:

jBroker Web 2.1