BinaryBody Type
An object that encapsulates a binary document body. Each binary body object has a unique ID
and is made up of three parts: binary data (read and written using an InputStream), a name,
and content type. A binary body might have a name "technote.pfg" and corresponding content
type of "application/pdf". A full listing of possible content types can be found at:
ftp://ftp.iana.org/in-notes/iana/assignments/media-types/
Type Template
<...>
<ID>xs:long</ID>
<objectType>xs:int</objectType>
<contentType>xs:string</contentType>
<!-- List of ... -->
<data>xs:base64Binary</data>
<downloadCount>xs:int</downloadCount>
<name>xs:string</name>
<size>xs:long</size>
<...>Note: Element descriptions are split into information that's
relevant when you're creating an instance of this type and information
relevant when you're receiving an instance of it. Occasionally these
will differ.
Elements
| Element |
Description |
| contentType
|
- Setting
- Getting
- Returns the content type of the body object. For example, the content type of an pdf
body object might be "application/pdf".
|
| data
|
- Setting
- Getting
-
Returns a
InputStream
for the binary contents of the body object. The stream
should be closed after reading the body object is completed. The InputStream will already be
buffered, so there is no advantage to using additional buffering.
|
| downloadCount
|
- Setting
- Getting
- Returns the number of times the binary body has been downloaded.
|
| ID
|
- Setting
- Set the unique id of this object.
- Getting
|
| name
|
- Setting
- Sets the name of the body object. Most often, the body object name is the original name of
the file that created the body object, such as "technote.pdf"
- Getting
- Returns the name of the body object. Most often, the body object name is the original name of
the file that created the body object, such as "technote.pdf"
|
| objectType
|
- Setting
- Sets the object type of the jive object.
- Getting
|
| size
|
- Setting
- Getting
- Returns the size of the body object in bytes.
|