oracle.ifs.common

Interface ContentStreamSerializer

All Superinterfaces:

Serializable

All Known Implementing Classes:

LocalContentStream

public interface ContentStreamSerializer
extends Serializable

A ContentStreamSerializer is used to allow ContentStreams to be remoted. This object is serializable, whereas InputStreams are not.

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTENTTYPE_CONTENTROWREF Content type indicating the content is available via a direct reference to a content row using a content ID.
static int	CONTENTTYPE_COPIEDCONTENT Content type indicating the content is available via copying an existing ContentObject.
static int	CONTENTTYPE_EMPTY Content type indicating an empty LOB.
static int	CONTENTTYPE_PATH Content type indicating the content is available via a local file path.
static int	CONTENTTYPE_READER Content type indicating a Reader.
static int	CONTENTTYPE_REFERENCE Content type indicating the content is specified by a string reference that is interpreted by the Media instance.
static int	CONTENTTYPE_SHAREDCONTENT Content type indicating the content is available via sharing an existing ContentObject.
static int	CONTENTTYPE_STREAM Content type indicating an InputStream.
static int	CONTENTTYPE_STRING Content type indicating explicit content, specified as a String.
static int	CONTENTTYPE_UNKNOWN Invalid or uninitialized content type.

Method Summary

Modifier and Type	Method and Description
Reader	getContentReader() Get the content as a reader.
String	getContentReference() Gets the content as a string reference that is interpreted by the Media instance.
Long	getContentRowReference() Get the content as a content row ID reference.
InputStream	getContentStream() Get the content as a stream.
String	getContentString() Get the content as an explicit String.
int	getContentType() Get the content type.
AttributeValue	getCopiedContent() Get the content as an AttributeValue reference to another ContentObject.
String	getLocalContentPath() Get the content as a path to a file in the local file system.
AttributeValue	getSharedContent() Get the content as an AttributeValue reference to another ContentObject.
void	setContentReader(Reader content) Set the content as a Reader.
void	setContentReference(LibrarySessionInterface session, String reference) Sets the content as a string reference that is interpreted by the Media instance.
void	setContentRowReference(LibrarySessionInterface session, Long content) Set the content as a content row ID reference.
void	setContentStream(InputStream content) Set the content as a stream.
void	setContentString(String content) Set the content as an explicit String.
void	setCopiedContent(AttributeValue content) Set the content as an AttributeValue reference to another ContentObject.
void	setEmptyContent() Set the content explicitly as "empty content".
void	setLocalContentPath(String path) Set the content as a path to a file in the local file system.
void	setSharedContent(AttributeValue content) Set the content as an AttributeValue reference to another ContentObject.

Field Detail

CONTENTTYPE_UNKNOWN

static final int CONTENTTYPE_UNKNOWN

Invalid or uninitialized content type.

See Also:

Constant Field Values

(Published)

CONTENTTYPE_EMPTY

static final int CONTENTTYPE_EMPTY

Content type indicating an empty LOB.

See Also:

Constant Field Values

(Unpublished)

CONTENTTYPE_STREAM

static final int CONTENTTYPE_STREAM

Content type indicating an InputStream.

See Also:

Constant Field Values

(Unpublished)

CONTENTTYPE_READER

static final int CONTENTTYPE_READER

Content type indicating a Reader.

See Also:

Constant Field Values

(Unpublished)

CONTENTTYPE_STRING

static final int CONTENTTYPE_STRING

Content type indicating explicit content, specified as a String.

See Also:

Constant Field Values

(Unpublished)

CONTENTTYPE_PATH

static final int CONTENTTYPE_PATH

Content type indicating the content is available via a local file path.

See Also:

Constant Field Values

(Unpublished)

CONTENTTYPE_COPIEDCONTENT

static final int CONTENTTYPE_COPIEDCONTENT

Content type indicating the content is available via copying an existing ContentObject.

See Also:

Constant Field Values

(Unpublished)

CONTENTTYPE_CONTENTROWREF

static final int CONTENTTYPE_CONTENTROWREF

Content type indicating the content is available via a direct reference to a content row using a content ID.

See Also:

Constant Field Values

(Unpublished)

CONTENTTYPE_SHAREDCONTENT

static final int CONTENTTYPE_SHAREDCONTENT

Content type indicating the content is available via sharing an existing ContentObject.

See Also:

Constant Field Values

(Unpublished)

CONTENTTYPE_REFERENCE

static final int CONTENTTYPE_REFERENCE

Content type indicating the content is specified by a string reference that is interpreted by the Media instance.

See Also:

Constant Field Values

(Unpublished)

Method Detail

getContentType

int getContentType()

Get the content type.

Must be one of the valid Content type constants defined in this interface.

Returns:

the content type

(Unpublished)

setEmptyContent

void setEmptyContent()

Set the content explicitly as "empty content".

(Unpublished)

getContentStream

InputStream getContentStream()
                      throws IfsException

Get the content as a stream.

Returns:

the content as a stream

Throws:

IfsException

(Unpublished)

setContentStream

void setContentStream(InputStream content)

Set the content as a stream.

Parameters:

content - the content as a stream

(Unpublished)

getContentReader

Reader getContentReader()

Get the content as a reader.

Returns:

the content as a reader

(Unpublished)

setContentReader

void setContentReader(Reader content)

Set the content as a Reader.

Parameters:

content - the content as a Reader

(Unpublished)

getContentString

String getContentString()

Get the content as an explicit String.

Returns:

the content as a String

(Unpublished)

setContentString

void setContentString(String content)
               throws IfsException

Set the content as an explicit String.

Parameters:

content - the content as a String

Throws:

IfsException

(Unpublished)

getLocalContentPath

String getLocalContentPath()

Get the content as a path to a file in the local file system.

Returns:

the content as a local file path

(Unpublished)

setLocalContentPath

void setLocalContentPath(String path)
                  throws IfsException

Set the content as a path to a file in the local file system.

Parameters:

path - the content as a local file path

Throws:

IfsException

(Unpublished)

getCopiedContent

AttributeValue getCopiedContent()

Get the content as an AttributeValue reference to another ContentObject.

Returns:

the content as ContentObject value

(Unpublished)

setCopiedContent

void setCopiedContent(AttributeValue content)

Set the content as an AttributeValue reference to another ContentObject.

Parameters:

content - the content as ContentObject value

(Unpublished)

getSharedContent

AttributeValue getSharedContent()

Get the content as an AttributeValue reference to another ContentObject.

Returns:

the content as ContentObject value

(Unpublished)

setSharedContent

void setSharedContent(AttributeValue content)

Set the content as an AttributeValue reference to another ContentObject.

Parameters:

content - the content as ContentObject value

(Unpublished)

getContentRowReference

Long getContentRowReference()

Get the content as a content row ID reference.

Returns:

the content as a content row ID reference.

(Unpublished)

setContentRowReference

void setContentRowReference(LibrarySessionInterface session,
                            Long content)
                     throws IfsException

Set the content as a content row ID reference.

This operation requires administration mode.

Parameters:

session - a session; must be in admin mode

content - the content as a content row ID reference.

Throws:

IfsException

(Unpublished)

getContentReference

String getContentReference()
                    throws IfsException

Gets the content as a string reference that is interpreted by the Media instance.

Returns:

the content reference

Throws:

IfsException - if the operation fails

(Unpublished)

setContentReference

void setContentReference(LibrarySessionInterface session,
                         String reference)
                  throws IfsException

Sets the content as a string reference that is interpreted by the Media instance.

This operation requires administration mode.

Parameters:

session - a session; must be in admin mode

reference - the content reference

Throws:

IfsException - if the operation fails

(Unpublished)