oracle.syndication.ice.payload
Class Ice_payload

java.lang.Object
  |
  +--oracle.xml.classgen.CGNode
        |
        +--oracle.xml.classgen.CGDocument
              |
              +--oracle.syndication.ice.payload.Ice_payload

public class Ice_payload

extends oracle.xml.classgen.CGDocument

implements Printable, oracle.syndication.server.event.EventConstructor, oracle.syndication.server.event.EventConstants

The Document Class (for the root element Ice_payload).For ICE protocol impl. getXXX methods are also implemented. The child elements allowed under this element include the following:

• Ice_header
• Ice_request
• Ice_response

The child elements that will not be covered in this release are:

• ice-unsolicited-now
• ice-unsolicited-request
• ice-unsolicited-response

Since:

9.0.0.0.0 Beta

Method Summary

Type	Method
oracle.xml.parser.v2.DTD	getDTDNode() Returns the Ice_payload DTD.
java.util.List	getICERequests() Gets a list of objects representing all the "ice-request"s embedded within this document.
java.util.List	getICEResponses() Gets a list of objects representing all the "ice-response"s embedded within this document.
Ice_code	getICEResponseStatusCode() Shortcut to get the status code of the first response within this ice-payload document.
Ice_header	getPayloadHeader() Gets the object representing the "ice-header" section of this ICE payload.
java.lang.String	getPayloadICEVersion() ICE Version of this ICE Payload
java.lang.String	getPayloadId() This returns the unique Identifier of this ICE Payload.
java.lang.String	getPayloadID()
java.lang.String	getPayloadTimeStamp()
java.lang.String	getPayloadType()
java.lang.String	getRequestID()
java.lang.String	getSenderID()
ISODatetime	getTimestamp() The time at which this ICE Payload is generated.
void	print(java.io.OutputStream out) [Deprecated]Prints the document to the specified OutputStream
void	print(java.lang.String szSpace, java.io.Writer wSink) This implementation of the Printable interface prints the whole ICE Payload by traversing down to its containees.
static void	reInitDTD() Every time when a new Ice_payload is constructed upon the receiving of an XML package, the DTD object which represents the ice DTD file will be re-initialized; this step is necessary for the using the SAX parser to parse the ice-payload.
oracle.xml.parser.v2.XMLDocument	toEventExtension()

Methods inherited from class oracle.xml.classgen.CGNode

setDocument

Methods inherited from class java.lang.Object

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

Method Detail

reInitDTD

public static void reInitDTD()
                      throws OSSException

Every time when a new Ice_payload is constructed upon the receiving of an XML package, the DTD object which represents the ice DTD file will be re-initialized; this step is necessary for the using the SAX parser to parse the ice-payload. Otherwise, an exception oracle.xml.parser.v2.XMLDOMException with the message "Node doesn't belong to the current document" will be thrown during parsing.

print

public void print(java.io.OutputStream out)
           throws oracle.xml.classgen.InvalidContentException

[Deprecated]Prints the document to the specified OutputStream

Parameters:

out - Java outputstream.

Throws:

oracle.xml.classgen.InvalidContentException - if the document is not valid

print

public void print(java.lang.String szSpace,
                  java.io.Writer wSink)
           throws java.io.IOException

This implementation of the Printable interface prints the whole ICE Payload by traversing down to its containees.

Specified by:

print in interface Printable

Parameters:

szSpace - Space to print before each line.

wSink - Sink to print the node to.

getPayloadId

public java.lang.String getPayloadId()

This returns the unique Identifier of this ICE Payload.

Returns:

The unique Identifier of this ICE Payload

getTimestamp

public ISODatetime getTimestamp()

The time at which this ICE Payload is generated.

Returns:

The time following iso8601 standard when this ICE Payload is generated.

getPayloadICEVersion

public java.lang.String getPayloadICEVersion()

ICE Version of this ICE Payload

Returns:

The ICE Version of this Payload

getPayloadHeader

public Ice_header getPayloadHeader()

Gets the object representing the "ice-header" section of this ICE payload.

getICERequests

public java.util.List getICERequests()

Gets a list of objects representing all the "ice-request"s embedded within this document.

Returns:

The list of Ice_requests within this document.

getICEResponses

public java.util.List getICEResponses()

Gets a list of objects representing all the "ice-response"s embedded within this document.

Returns:

The list of Ice_responses within this document.

getICEResponseStatusCode

public Ice_code getICEResponseStatusCode()

Shortcut to get the status code of the first response within this ice-payload document.

Returns:

This returns the status code object contained within the first instance of Ice_response embedded.

getDTDNode

public oracle.xml.parser.v2.DTD getDTDNode()

Returns the Ice_payload DTD.

Returns:

The DTD Node that the ice-payload conforms to.

See Also:

DTD

getPayloadID

public java.lang.String getPayloadID()

Specified by:

getPayloadID in interface oracle.syndication.server.event.EventConstructor

getPayloadTimeStamp

public java.lang.String getPayloadTimeStamp()

Specified by:

getPayloadTimeStamp in interface oracle.syndication.server.event.EventConstructor

getSenderID

public java.lang.String getSenderID()

Specified by:

getSenderID in interface oracle.syndication.server.event.EventConstructor

getRequestID

public java.lang.String getRequestID()

Specified by:

getRequestID in interface oracle.syndication.server.event.EventConstructor

getPayloadType

public java.lang.String getPayloadType()

Specified by:

getPayloadType in interface oracle.syndication.server.event.EventConstructor

toEventExtension

public oracle.xml.parser.v2.XMLDocument toEventExtension()

Specified by:

toEventExtension in interface oracle.syndication.server.event.EventConstructor