oracle.ifs.server

Class S_MediaCustom

java.lang.Object

oracle.ifs.server.S_LibraryObject

oracle.ifs.server.S_TieLibraryObject

oracle.ifs.server.S_SystemObject

oracle.ifs.server.S_TieSystemObject

oracle.ifs.server.S_Media

oracle.ifs.server.S_TieMedia

oracle.ifs.server.S_MediaCustom

All Implemented Interfaces:

IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

S_TieMediaCustom

public class S_MediaCustom
extends S_TieMedia

An S_MediaCustom instance is the server-side representation of a MediaCustom instance.

A MediaCustom instances can have secure parameters, name/value pairs whose values are securely stored. Administration mode is required to set, get, or delete a secure parameter.

(Published)

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.server.S_LibraryObject

S_LibraryObject.MapInfo

Field Summary

Fields inherited from class oracle.ifs.server.S_Media

CONTENTTABLE_EXPIRATIONDATE_COLUMN, CONTENTTABLE_MEDIAID_COLUMN, CONTENTTABLE_PARTITIONVALUE_COLUMN, CONTENTTABLE_TABLENAME_PREFIX

Fields inherited from class oracle.ifs.server.S_LibraryObject

CASCADE_OP_COPY_PUBLICOBJECT_TO_CATEGORY, CASCADE_OP_COPY_PUBLICOBJECT_TO_RIGHT_RELATIONSHIP, CASCADE_OP_DELETE_FAMILY_TO_VERSIONSERIES, CASCADE_OP_DELETE_PUBLICOBJECT_TO_LEFT_RELATIONSHIP, CASCADE_OP_DELETE_PUBLICOBJECT_TO_RIGHT_RELATIONSHIP, CASCADE_OP_DELETE_PUBLICOBJECT_TO_VERSIONDESCRIPTION, CASCADE_OP_DELETE_RELATIONSHIP_TO_LEFT_PUBLICOBJECT, CASCADE_OP_DELETE_RELATIONSHIP_TO_RIGHT_PUBLICOBJECT, CASCADE_OP_DELETE_VERSIONDESCRIPTION_TO_PUBLICOBJECT, CASCADE_OP_DELETE_VERSIONDESCRIPTION_TO_VERSIONSERIES, CASCADE_OP_DELETE_VERSIONSERIES_TO_FAMILY, CASCADE_OP_DELETE_VERSIONSERIES_TO_VERSIONDESCRIPTION, CASCADE_OP_FREE_CATEGORY_TO_PUBLICOBJECT, CASCADE_OP_FREE_CATEGORY_TO_SCHEMAOBJECT, CASCADE_OP_FREE_CATEGORY_TO_SYSTEMOBJECT, CASCADE_OP_FREE_FAMILY_TO_VERSIONSERIES, CASCADE_OP_FREE_PUBLICOBJECT_TO_CATEGORY, CASCADE_OP_FREE_PUBLICOBJECT_TO_LEFT_RELATIONSHIP, CASCADE_OP_FREE_PUBLICOBJECT_TO_RIGHT_RELATIONSHIP, CASCADE_OP_FREE_PUBLICOBJECT_TO_VERSIONDESCRIPTION, CASCADE_OP_FREE_RELATIONSHIP_TO_LEFT_PUBLICOBJECT, CASCADE_OP_FREE_RELATIONSHIP_TO_RIGHT_PUBLICOBJECT, CASCADE_OP_FREE_SCHEMAOBJECT_TO_CATEGORY, CASCADE_OP_FREE_SYSTEMOBJECT_TO_CATEGORY, CASCADE_OP_FREE_VERSIONDESCRIPTION_TO_PUBLICOBJECT, CASCADE_OP_FREE_VERSIONDESCRIPTION_TO_VERSIONSERIES, CASCADE_OP_FREE_VERSIONSERIES_TO_FAMILY, CASCADE_OP_FREE_VERSIONSERIES_TO_VERSIONDESCRIPTION, CASCADE_OP_UNDEFINED, CASCADE_OP_UNDELETE_FAMILY_TO_VERSIONSERIES, CASCADE_OP_UNDELETE_PUBLICOBJECT_TO_LEFT_RELATIONSHIP, CASCADE_OP_UNDELETE_PUBLICOBJECT_TO_RIGHT_RELATIONSHIP, CASCADE_OP_UNDELETE_PUBLICOBJECT_TO_VERSIONDESCRIPTION, CASCADE_OP_UNDELETE_RELATIONSHIP_TO_LEFT_PUBLICOBJECT, CASCADE_OP_UNDELETE_RELATIONSHIP_TO_RIGHT_PUBLICOBJECT, CASCADE_OP_UNDELETE_VERSIONDESCRIPTION_TO_PUBLICOBJECT, CASCADE_OP_UNDELETE_VERSIONDESCRIPTION_TO_VERSIONSERIES, CASCADE_OP_UNDELETE_VERSIONSERIES_TO_FAMILY, CASCADE_OP_UNDELETE_VERSIONSERIES_TO_VERSIONDESCRIPTION, CASCADE_OP_UPDATE_CATEGORY_TO_PUBLICOBJECT, CASCADE_OP_UPDATE_CATEGORY_TO_SCHEMAOBJECT, CASCADE_OP_UPDATE_CATEGORY_TO_SYSTEMOBJECT, CASCADE_OP_UPDATE_PUBLICOBJECT_TO_CATEGORY, CASCADE_OP_UPDATE_SCHEMAOBJECT_TO_CATEGORY, CASCADE_OP_UPDATE_SYSTEMOBJECT_TO_CATEGORY, DEFAULT_RENDERER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	S_MediaCustom(S_LibrarySession session, Long classId) Constructs an S_MediaCustom instance for the case where the object has not been created in the database yet.
protected	S_MediaCustom(S_LibrarySession session, S_LibraryObjectData data) Constructs an S_MediaCustom instance.

Method Summary

Modifier and Type	Method and Description
protected void	deleteSecureParameter(String name) Deletes the specified secure parameter of this MediaCustom instance.
protected void	destroyContent(Long cid, AttributeValue[] mediaOptions) Destroys the content with the specified content id.
protected void	extendedPostFree(OperationState opState, S_LibraryObjectDefinition def) Operations to be performed after freeing an object.
protected void	extendedPostInsert(OperationState opState, S_LibraryObjectDefinition sdef) Operations to be performed after creating an object.
protected void	extendedPreFree(OperationState opState, S_LibraryObjectDefinition sdef) Operations to be performed before freeing an object.
protected String	getAddress(Long cid) Gets the content address for the specified content id.
protected InputStream	getContent(Long cid) Gets the content stream for the specified content id.
protected long	getContentSize(Long cid) Gets the size of the content stream for the specified content id.
protected RandomAccessDriver	getRandomAccessDriver(Long cid) Gets a RandomAccessDriver for the specified content id.
protected String	getSecureParameter(String name) Gets the value of the specified secure parameter of this MediaCustom instance.
protected String[]	getSecureParameterNames() Gets the names of the secure parameters of this MediaCustom instance.
protected String	getSecureParameterPrefix() Gets the prefix automatically applied to the names of the secure parameters of this MediaCustom instance to make them repository unique.
protected void	setContent(Long cid, InputStream is, Long partitionValue, AttributeValue[] mediaOptions) Stores content read from the specified InputStream using the specified content id.
protected void	setContentReference(Long cid, String contentReference, Long partitionValue, AttributeValue[] mediaOptions) Stores content determined from a specified content reference for the specified content id.
protected void	setSecureParameter(String name, String value) Sets the value of the specified secure parameter of this MediaCustom instance.

Methods inherited from class oracle.ifs.server.S_Media

acquireContentTableLock, copyContent, destroyExpiredContent, DYNDestroyExpiredContent, ensureContentTableExists, extendedPreInsert, getColumnName, getContentIndexProcedure, getContentTableName, getPartitionValue, getTableName, isReadOnly, setEmptyContent, setExpirationDate, setPartitionValue

Methods inherited from class oracle.ifs.server.S_SystemObject

addCategory, cascadeFree, createCategories, deriveDefinition, extendedPostUpdate, extendedPreUpdate, getCategories, getCategories, getCategories, handleCascade, removeCategories, updateCategories, verifyCanCreate, verifyCanFree, verifyCanUpdate

Methods inherited from class oracle.ifs.server.S_LibraryObject

added, applyValueDefault, associatedPostFree, associatedPostInsert, associatedPreInsert, canPurge, cascadeCopy, cascadeUpdate, checkRequiredForInsert, checkSettable, clearArrayTypeAttributeValues, clearMapTypeAttributeValues, clonePublicObjectAttribute, constructIdArray, constructIdArray, copy, copy, copyVectorToLibraryObjectArray, createDefaultPolicyPropertyBundle, createDefaultPropertyBundle, createDefaultPropertyBundle, createInstance, deleteRows, deriveOwnerUniqueName, deriveOwnerUniqueName, deriveUppercasedAttribute, determineClassDomain, determinePolicy, determinePolicy, determineValueDefault, determineValueDomain, dispose, DYNInvalidateState, DYNLockRows, equals, equals, executePolicyOperation, extendedPreCopy, findPolicyFromPropertyBundleAv, free, free, getAttribute, getAttributeByUpperCaseName, getAuditCertificateName, getAuditDomainContext, getAuditEventFolderContext, getClassData, getClassId, getClassName, getClassObject, getContentStorageManager, getData, getDefinition, getEffectivePolicyActionContexts, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getId, getLibraryConnection, getName, getObjectReferenceAttribute, getPropertyBundle, getPropertyValue, getResourceString, getResourceString, getService, getSession, getSessionInterface, getTraceLogger, handleEvent, hashCode, hasNameAttribute, insertReferenceAttributes, insertRow, insertRows, invalidateState, invokeOperation, invokePolicyMethod, isAuditCertificateSecured, isBroadcastCreateEventEnabled, isInstanceOf, isPersistent, issueCascade, isTraced, lockRows, postEvent, postEvent, postFree, postInsert, postUpdate, preFree, preInsert, preUpdate, privilegedUpdate, removed, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, toString, trace, update, updateRows, validateStringArray, verifyCanGetContent, verifyCanSetContent, verifyCanSetPolicy, verifyPersistent, verifyWriteableTransactionInProgress

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Constructor Detail

S_MediaCustom

protected S_MediaCustom(S_LibrarySession session,
                        S_LibraryObjectData data)
                 throws IfsException

Constructs an S_MediaCustom instance.

Parameters:

session - the session context

data - the data component

Throws:

IfsException - if the operation fails

(Published)

S_MediaCustom

protected S_MediaCustom(S_LibrarySession session,
                        Long classId)
                 throws IfsException

Constructs an S_MediaCustom instance for the case where the object has not been created in the database yet.

Parameters:

session - the session context

classId - the id of the class

Throws:

IfsException - if the operation fails

(Published)

Method Detail

extendedPostInsert

protected void extendedPostInsert(OperationState opState,
                                  S_LibraryObjectDefinition sdef)
                           throws IfsException

Operations to be performed after creating an object.

This is overridden by classes that need to perform operations after successfully creating the rows for the new instance.

Overrides:

extendedPostInsert in class S_Media

Parameters:

opState - current operation state

sdef - object definition

Throws:

IfsException - if operation fails.

extendedPreFree

protected void extendedPreFree(OperationState opState,
                               S_LibraryObjectDefinition sdef)
                        throws IfsException

Operations to be performed before freeing an object. This is overridden by classes that need to perform operations before successfully deleting the rows for the freed instance.

Overrides:

extendedPreFree in class S_Media

Parameters:

opState - current operation state

sdef - object definition

Throws:

IfsException - if operation fails.

extendedPostFree

protected void extendedPostFree(OperationState opState,
                                S_LibraryObjectDefinition def)
                         throws IfsException

Operations to be performed after freeing an object. This is overridden by classes that need to perform operations after successfully deleting the rows for the freed instance.

Overrides:

extendedPostFree in class S_LibraryObject

Parameters:

opState - current operation state

def - object definition

Throws:

IfsException - if operation fails.

getSecureParameterPrefix

protected final String getSecureParameterPrefix()
                                         throws IfsException

Gets the prefix automatically applied to the names of the secure parameters of this MediaCustom instance to make them repository unique.

The arguments and return values of the getSecureParameterNames(), getSecureParameter(String), setSecureParameter(String, String), and deleteSecureParameter(String) methods are unprefixed names. The prefix returned by this method is transparently applied to arguments and stripped from return values.

Returns:

the name prefix

Throws:

IfsException - if the operation fails

(Published)

getSecureParameterNames

protected String[] getSecureParameterNames()
                                    throws IfsException

Gets the names of the secure parameters of this MediaCustom instance.

Returns:

the secure parameter names, or null if none

Throws:

IfsException - if the operation fails

(Published)

getSecureParameter

protected String getSecureParameter(String name)
                             throws IfsException

Gets the value of the specified secure parameter of this MediaCustom instance.

Parameters:

name - the secure parameter name

Returns:

the secure parameter value, or null if there is no secure parameter with the specified name

Throws:

IfsException - if the operation fails

(Published)

setSecureParameter

protected void setSecureParameter(String name,
                                  String value)
                           throws IfsException

Sets the value of the specified secure parameter of this MediaCustom instance.

Parameters:

name - the secure parameter name

value - the secure parameter value

Throws:

IfsException - if the operation fails

(Published)

deleteSecureParameter

protected void deleteSecureParameter(String name)
                              throws IfsException

Deletes the specified secure parameter of this MediaCustom instance.

Parameters:

name - the secure parameter name

Throws:

IfsException - if the operation fails

(Published)

getContent

protected InputStream getContent(Long cid)
                          throws IfsException

Gets the content stream for the specified content id.

Specified by:

getContent in class S_Media

Parameters:

cid - the content id; required

Returns:

the content stream; non-null

Throws:

IfsException - if the operation fails

getContentSize

protected long getContentSize(Long cid)
                       throws IfsException

Gets the size of the content stream for the specified content id.

Specified by:

getContentSize in class S_Media

Parameters:

cid - the content id; required

Returns:

the size, in bytes

Throws:

IfsException - if the operation fails

setContent

protected void setContent(Long cid,
                          InputStream is,
                          Long partitionValue,
                          AttributeValue[] mediaOptions)
                   throws IfsException

Stores content read from the specified InputStream using the specified content id.

The implementation of this method is responsible for inserting a row into the content table whose ID column is cid, storing content read from the InputStream, and closing the InputStream.

Specified by:

setContent in class S_Media

Parameters:

cid - the content id; required

is - the InputStream from which content is read

partitionValue - the value for the PARTITIONVALUE column in the content table, or null if none

mediaOptions - a set of name/value pairs whose semantics are Media determined, or null for no media options

Throws:

IfsException - if the operation fails

setContentReference

protected void setContentReference(Long cid,
                                   String contentReference,
                                   Long partitionValue,
                                   AttributeValue[] mediaOptions)
                            throws IfsException

Stores content determined from a specified content reference for the specified content id.

The implementation of this method is responsible for inserting a row into the content table whose ID column is cid.

The interpretation of contentReference varies by subtype. Some Media subtypes may store its value, while others may resolve its value (in a subtype-determined fashion) to other content and store that content instead.

Specified by:

setContentReference in class S_Media

Parameters:

cid - the content id; required

contentReference - the content reference; required

partitionValue - the value for the PARTITIONVALUE column in the content table, or null if none

mediaOptions - a set of name/value pairs whose semantics are Media determined, or null for no media options

Throws:

IfsException - if the operation fails

getRandomAccessDriver

protected RandomAccessDriver getRandomAccessDriver(Long cid)
                                            throws IfsException

Gets a RandomAccessDriver for the specified content id.

Specified by:

getRandomAccessDriver in class S_Media

Parameters:

cid - the content id

Returns:

the RandomAccessDriver

Throws:

IfsException - 13623: if the operation fails

destroyContent

protected void destroyContent(Long cid,
                              AttributeValue[] mediaOptions)
                       throws IfsException

Destroys the content with the specified content id.

The implementation of this method is responsible for deleting the content table row whose ID column is cid.

Specified by:

destroyContent in class S_Media

Parameters:

cid - the content id; required

mediaOptions - a set of name/value pairs whose semantics are Media determined, or null for no media options

Throws:

IfsException - if the operation fails

getAddress

protected String getAddress(Long cid)
                     throws IfsException

Gets the content address for the specified content id.

Parameters:

cid - the content id

Returns:

the content address

Throws:

IfsException - if the operation fails

(Unpublished)