Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKLobICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractDataObjectBase
        |
        +--com.ibm.mm.sdk.common.dkDataObject
              |
              +--com.ibm.mm.sdk.common.DKDDOBase
                    |
                    +--com.ibm.mm.sdk.common.DKDDO
                          |
                          +--com.ibm.mm.sdk.common.dkResource
                                |
                                +--com.ibm.mm.sdk.common.DKLobICM
All Implemented Interfaces:
DKConstant, DKConstantICM, dkDataObjectBase, DKMessageId, DKMessageIdICM, dkXDO, dkXDOBase, com.ibm.mm.sdk.internal.PRMConstantICM, java.io.Serializable
Direct Known Subclasses:
DKImageICM, DKStreamICM, DKTextICM

public class DKLobICM
extends dkResource
implements DKConstantICM, DKMessageIdICM, com.ibm.mm.sdk.internal.PRMConstantICM, java.io.Serializable

This class represents an abstraction of generic resource in the IBM Content Manager.
A resource object consists of a content stored in a Resource Manager and the meta-data describing this content stored in the Library Server of Content Manager. A resource has state and behavior. The state of a resource is described by its meta-data, that is the attributes and their values as well as its data or content. The behavior is implemented by this class, and its more specialized subclasses.
Resources are defined as a collection of "instances of user defined types" called " resource item types". In other words, resources represent files in a file system, data objects in HSM servers, video clips in a video server, and Blobs in RDBMS tables. At runtime instances of the DKLobICM or its subclasses, are used to access the physical data they point to. CM resources are typed, which among others means that they are designed to hold media specific state and provide media specific behavior. In a CM System the Library Server and its associated Resource Managers, share a schema to store the state of the managed resources . The base resource types provided by a CM System are: the generic Lob, a Text, an Image, a Stream and a Video Stream resource class. These classes can be instantiated to hold both the meta data and the content of data objects. Within the CM OO Framework the resource types are represented respectively by the classes: DKLobICM, and its subclasses DKTextICM, DKImageICM, DKStreamICM, and DKVideoStreamICM. If necessary they can be sub-classed and further specialized by CM applications. The rich media content of a resource can be stored on and retrieved from a CM Resource Manager. For this purpose a set of resource services and functions are made available.
The behavior of a resource is implemented through the methods of the DKLobICM class and its derived sub classes. They constitute the resource services. The resource services in CM represent the end-to-end support for content access and delivery. The core part of these methods include, among others, the basic CRUD (Create (Add), Retrieve,Update, and Delete) methods.
They are meant to support content access/delivery using the push, pull and stream models over commonly use data transport protocols like: http, ftp and filesystem. The major goal of the resource framework, is to provide transactional content access and distribution functions in order to ensure referrential integrity between the meta data and the data of resources.

The actual content of a resource is persistently stored on CM Resource Manager. At runtime a copy is stored within a DKLobICM instance in a byte buffer. It is the responsibility of the application to synchronize the in-memory content with the content stored on a Resource Manager.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.internal.PRMConstantICM
background, badrequest, BOUNDARYTAG, COLON, CONTENTTYPE, CRLF, DK_ICM_BLOBTABLE, DK_ICM_FSEXPORT, DK_ICM_FTPROOT, DK_ICM_HTTPROOT, DK_ICM_LBOS_AREA, DK_ICM_LBOS_DRIVE, DK_ICM_LBOS_SUBPATH, DK_ICM_NONNORMALMEDIA, DK_ICM_NORMALMEDIA, DK_ICM_RMVERSION, DK_ICM_STAGING_AREA, DK_ICM_STAGING_DRIVE, DK_ICM_STAGING_SUBPATH, DK_ICM_TABLECOLLECTION, DK_ICM_TABLECOLLECTIONNAME, DK_ICM_VOL_FREESPACE, DK_ICM_VOL_LOGICALNAME, DK_ICM_VOL_MOUNTPOINT, DK_ICM_VOL_PATH, DK_ICM_VOL_SIZE, DK_ICM_VOL_STATUS, DK_ICM_VOL_STATUS_ASSIGNED, DK_ICM_VOL_STATUS_OVERFLOW, DK_ICM_VOL_VOLUMEID, eoh, expire, FORMDATACOLLECTION, FORMDATAFILENAME, FORMDATAOBJNAME, FORMDATAORDER, FORMDATAREPTYPE, FORMDATARESNUM, FORMDATAVERSID, GBYTE, ICM_DEFAULTCOLLECTION, ICM_DEFAULTCOLLECTIONID, ICM_DEFAULTREPTYPE, ICM_RESOURCETYPE_BASE, ICM_RESOURCETYPE_CONTAINER, ICM_RESOURCETYPE_STREAM, ICM_RESOURCETYPE_TEXT, ICM_RESOURCETYPE_VIDEO, ICM_RESOURCETYPE_XML, ICMADMIN, ICMCACHE, ICMCACHERETRIEVE, ICMCATALOG, ICMCHANGESMS, ICMCHANGESMSINFO, ICMCREATE, ICMCREATEENTITY, ICMDEBUG, ICMDELETE, ICMDELETEENTITY, ICMENDTRANS, ICMFSEXPORT, ICMFTPEXPORT, ICMHTTPEXPORT, ICMIMPORTFROMFS, ICMIMPORTFROMWEB, ICMKEYFLUSH, ICMLIST, ICMLISTDEVMGR, ICMLISTMGTCLASSES, ICMLISTSMSINFO, ICMLISTSTGCLASSES, ICMLISTSTGGROUPS, ICMLISTVOLUMES, ICMMIDTIERCREATE, ICMMIDTIERDELETE, ICMMIDTIERRETRIEVE, ICMMIDTIERSTOREFROMASYNC, ICMMIDTIERSTOREFROMFTP, ICMMIDTIERUPDATE, ICMORDER, ICMPLAY, ICMQUERY, ICMQUERYENTITY, ICMREPLACE, ICMREPLACEFROM, ICMREPLACEFROMASYNC, ICMREPLICATE, ICMRETRIEVE, ICMRETRIEVEASYNC, ICMRETRIEVETO, ICMRETRIEVETOASYNC, ICMRETRIEVETOOLD, ICMRM_DELETE_FAILED, ICMRM_DELETE_OK, ICMRM_OPT_RETRIEVAL_ACTION, ICMRM_REPLACE_FAILED, ICMRM_REPLACE_OK, ICMRM_RETRIEVAL_GET_IT, ICMRM_RETRIEVAL_GET_IT_PREFETCH, ICMRM_RETRIEVAL_NO_MOUNT, ICMRM_RETRIEVAL_NO_MOUNT_PREFETCH, ICMRM_RETRIEVAL_STAGE_IT, ICMRM_RETRIEVAL_STAGE_IT_PREFETCH, ICMRM_RETRIEVE_FAILED, ICMRM_RETRIEVE_OK, ICMRM_STAGE_FAILED, ICMRM_STAGE_OK, ICMRM_STORE_FAILED, ICMRM_STORE_OK, ICMRM_UPDATE_FAILED, ICMRM_UPDATE_OK, ICMRMBITRATE, ICMRMCACHETYPE, ICMRMCOLLECTION, ICMRMCOMMIT, ICMRMCONTENTDISPOSITION, ICMRMCONTENTLENGTH, ICMRMCONTENTRANGE, ICMRMCONTENTTYPE, ICMRMCREATEDATE, ICMRMDURATION, ICMRMFILELENGTH, ICMRMFILELIST, ICMRMFILENAME, ICMRMFILEPATH, ICMRMFUNCTION, ICMRMGROUP, ICMRMHOSTNAME, ICMRMITEMID, ICMRMLIBNAME, ICMRMMODE, ICMRMNAME, ICMRMOBJNAME, ICMRMOFFLINE, ICMRMORDER, ICMRMPASSWORD, ICMRMPORT, ICMRMPROTOCOL, ICMRMRCLIST, ICMRMREFERENCEDATE, ICMRMREPTYPE, ICMRMRESNUM, ICMRMRETENTION, ICMRMROLLBACK, ICMRMSERVERPORT, ICMRMSTARTTIME, ICMRMSTOPTIME, ICMRMSTREAMMODE, ICMRMTARGETCOLLECTION, ICMRMTOKEN, ICMRMTXID, ICMRMUPDATEDATE, ICMRMURL, ICMRMUSER, ICMRMUSERID, ICMRMVERSID, ICMRMVERSION, ICMSMSLOGOFF, ICMSMSLOGON, ICMSTORE, ICMSTORECACHE, ICMSTOREFROM, ICMSTOREFROMASYNC, ICMSTOREFROMASYNCOLD, ICMSTOREFROMBROWSER, ICMSTOREFROMFTP, ICMSTOREFROMOLD, ICMSTOREFROMWEB, ICMSTREAMADMIN, ICMSTREAMDELIVERYSERVICES, ICMSTREAMIMPORTSERVICES, ICMTABLECOLLECTIONID, ICMUPDATE, ICMUPDATEENTITY, ICMUPDATEFROMBROWSER, ICMUPDATEFROMFS, ICMUPDATEFROMWEB, ICMVIEW, ID, KBYTE, MAXBLOBSIZE, MBYTE, METHOD_CONNECT, METHOD_COPY, METHOD_DELETE, METHOD_GET, METHOD_HEAD, METHOD_LOCK, METHOD_MKCOL, METHOD_MOVE, METHOD_OPTIONS, METHOD_POST, METHOD_PROPFIND, METHOD_PROPPATCH, METHOD_PUT, METHOD_TRACE, METHOD_UNLOCK, MIMETYPE, notfound, OBJARCHIVED, OBJDELETEPENDING, OBJDISCARDED, OBJSTAGED, OBJSTOREPENDING, OBJUPDATED, ok, SEMICOLON, TENMB, TENMEG, TWOMEG
 
Constructor Summary
DKLobICM()
          The default constructor for generic resource objects.
DKLobICM(dkDatastore ds)
          Constructs a generic resource object associated with the given datastore.
DKLobICM(dkDatastore ds, byte[] buf)
          Constructs a generic resource object associated with the datastore, then sets the initial content to the given byte array.
DKLobICM(DKLobICM aDKLobICM)
          The copy constructor for this object.
 
Method Summary
 void add()
          Adds or stores the content and meta-data of this resource object into the persistent store.
 void add(java.io.InputStream is, long length)
          Adds the content and meta-information of this resource object into the persistent store with input stream.
 void add(java.io.InputStream is, long length, int option)
          Adds the content and meta-information of this resource object into the persistent store with input stream.
 void add(int option)
          Adds or stores the content and meta-data of this resource object into the persistent store.
 void add(java.lang.String aFullFileName)
          Adds the content and meta-information of this resource object into the persistent store with input file.
 void add(java.lang.String aFullFileName, int option)
          Adds the content and meta-information of this resource object into the persistent store with input file.
 void addExtension(java.lang.String extensionName, dkExtension extensionObj)
          Adds an extension to this resource object.
 void addFrom()
          Adds or store a resource from a third party source to the Resource Manager and Content Manager persistent store.
 void addFrom(int option)
          Adds or store a resource from a third party source to the Resource Manager and Content Manager persistent store.
 void addFrom(java.lang.String hostname, java.lang.String userid, java.lang.String passwd, java.lang.String protocol, int port, java.lang.String filename, int option)
          Adds or store a resource from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store.
The content store takes place synchronously.
 void addFromAsync()
          Adds or store a resource asynchronously from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store.
 void addFromAsync(java.lang.String hostname, java.lang.String userid, java.lang.String passwd, java.lang.String protocol, int port, java.lang.String filename, int option)
          Adds or store a resource asynchronously from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store.
 void addReplicaInfo(java.lang.String txID, java.lang.String token, int[] rmcodes, java.lang.String[] collections)
          Adds a replica information to this resource describing a set of resource managers that store the replica of this resource.
 void addReplicaInfo(java.lang.String txID, java.lang.String Token, int rmcode, java.lang.String collection)
          Adds a replica information to this resource describing the resource manager location that stores the replica of this resource.
 void addRMInfo(DKRMInfoICM rminfo)
          adds the replica info structure of this resource in order to communicate with its default the RM.
 void addURLInfo(DKRMInfoICM rminfo)
          Adds the replica info structure of this resource in order to communicate with its default the RM.
 void catalogContent(java.lang.String fileName, java.lang.String rmScopeFilePath)
          This will catalog into the Library Server and store the content into the Resource Manager from a file that is physically present on the Resource Manager machine.
 void changeSMSInfo(java.lang.String targetCollection)
          Moves the content of this resource into the specified collection in the same resource manager.
 void changeSMSInfo(java.lang.String rmName, java.lang.String targetCollection)
          Moves the location of the content of this resource to the specified resource manager and collection name.
 void changeStorage()
          Changes the system-managed storage (SMS) criteria for this object.
 boolean compareData(dkXDO adkXDO)
          Compares the content of this object with the content of another resource object.
 void copyData(dkXDO adkXDO)
          Replaces the content of this object with the content of the other resource object.
 void del()
          Deletes this resource from the persistent store.
 void del(boolean flush)
          Deletes this resource from the persistent store and from memory according to the specified option.
 boolean equals(dkXDOBase adkXDOBase)
          Check if this resource is equal to the given resource Each subclass must override this method to provide a specific implemntation appropriate for it.
 int getAffiliatedType()
          Gets the affiliated type of this object.
 byte[] getContent()
          Gets the content of this object.
 void getContentToClientFile(java.lang.String afileName, int fileOption)
          Copies the content of this object to the given file.
 java.lang.String getContentURL(int option, int offset, int len)
          Gets the URL address to be used for retrieving the content directly from the Resource Manager.
 java.lang.String getContentURL(int operation, int option, int offset, int len)
          Gets the URL address to be used for retrieving the content directly from the Resource Manager.
 java.lang.String getCreatedTimestamp()
          Gets the timestamp when this object was created.
 dkExtension getExtension(java.lang.String extensionName)
          Gets the extension object with the given name.
 java.lang.String getHttpStoreMethod()
          gets the http method.
 int getInputContentlength()
          Gets the length of the resource content that was stored using third party store or update.
 java.lang.String getInputCreatedate()
          Gets the ISO Format Julian Timestamp create-date, if set during third party store.
 java.lang.String getInputFilelist()
          Gets the input file list separated by comma to be used for third party content store, update or retrieve.
 java.lang.String getInputFilename()
          Gets the input file name to be used for third party content store, update or retrieve.
 java.lang.String getInputFilepath()
          Gets the path of the input file(s) for third party content store, update or retrieve.
 java.lang.String getInputProtocol()
          Gets the protocol specified to be used with the third party content store.
 int getInputRetention()
          Gets the number of days from the creation date for which this object is to be retained.
 java.io.InputStream getInputStream(int option, int offset, int length)
          Retrieves the object's content from the persitent store to a stream.
 java.lang.String getItemId()
          Gets the itemId of this resource item.
 java.lang.String getMimeType()
          Gets the MIME type of the content of this resource item.
 java.lang.String getName()
          Gets the name of this extension object.
 boolean getNewVersion()
          This method returns the flag specifying if a new version is to be created when updating a part.
 java.lang.String getOpenHandler()
          Gets the current program name of the handler for this object's instance.
 java.lang.Object getOption(int option)
          Gets the delete or retrieval option to perform the delete or retrieve action.
 java.lang.String getOrgFileName()
          Gets the original filename of this resource.
 int getPartNumber()
          Gets the part number of this resource in a document.
 java.lang.String getReferencedTimestamp()
          Gets the timestamp when this object was last updated.
 java.lang.String getResourceName()
          Gets the resource name or external object name of this resource.
 java.lang.String getRMName()
          Gets the resource manager name used to store the content of this resource.
 long getSize()
          Gets the size of this resource content in memory.
 java.lang.String getSMSCollName()
          Gets the SMS collection name from the resource manager, used to store the content of this object.
 java.lang.String getThirdPartyHostname()
          Gets the system hostname specified for third party content store, retrieve or update.
 java.lang.String getThirdPartyPassword()
          Gets the user's password set for third party content store, update or retrieve.
 int getThirdPartyPort()
          Gets the host port number to be used for third party content store, update or retrieve.
 boolean getThirdPartyStore()
          Checks if this object is prepared for a third party content store.
 java.lang.String getThirdPartyUserid()
          Gets the userId set for third party content store, update or retrieve.
 java.lang.String getToken()
          Gets the security token required to retrieve the content object directly from the resource manager.
 java.lang.String getUpdateDate()
          Gets the update date specified to be used with the third party content store.
 java.lang.String getUpdatedTimestamp()
          Gets the timestamp when this object was last updated.
 java.lang.String getUser()
          Gets the name of the user currently using this datastore object.
 java.lang.String getVersionNumber()
          Gets the version number of this resource item.
 boolean isContentChanged()
          Checks if the in-memory content of this resource has been changed.
 boolean isNull()
          Checks if the in-memory content of this object is null.
 boolean isOpenSynchronous()
          Checks the synchronization property of the current executable handler program.
 boolean isSet()
          Checks if the in-memory content of this object has been set.
 int length()
          Gets the actual size of this resource content in memory.
 boolean loadDataFromFile(java.lang.String afileName)
          Replaces the content of this object with the contents of the file afileName.
 void open()
          Unloads the object's content to a client file with a system generated name and then synchronously invokes a default handler against the file.
 void open(java.lang.String afileName)
          Unloads the object's content to the given file name and then synchronously invoke a default handler against the file.
 void querySMSInfo()
          Query the SMS related information of this object from the resource manager.
 void removeExtension(java.lang.String extensionName)
          Remove the extension object with the given name.
 void retrieve()
          Retrieves the meta-data from the Library Server and the content from Resource Manager persistent store.
 void retrieve(int option)
          Retrieves the meta-data from the Library Server and the content from Resource Manager persistent store.
 java.lang.Object retrieve(int option, long offset, long len)
          Retrieves resource meta-data from the library server and the whole or partial content object from the Resource Manager to the memory buffer.
 void retrieve(int option, java.lang.String fileName, int offset, int length)
          Retrieves the meta-data for this object and a partial or whole content from the resource manager to the specified file name.
 void retrieve(java.lang.String fileName)
          Retrieves this resource from the persistent store, but streams the content directly into the specified filename.
 void retrieveTo()
          Retrieves the content and meta-data of the resource stored in the Resource Manager and Content Manager persistent store to a third party destination.
 void retrieveToAsync()
          Asynchronously retrieves the content and meta-data of the resource stored in the Resource Manager and Content Manager persistent store to a third party destination.
 void setAffiliatedType(int aflType)
          Sets the affiliated type for this object.
 void setClassOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
          Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object's class.
The method setInstanceOpenHandler(java.lang.String, boolean) sets the handler for the object's instance only, instead of for the whole class.
 void setContent(byte[] aByteArray)
          Sets the content of this object to the given byte array value.
 void setContentChanged(boolean aFlag)
          Sets the content changed indicator to true or false.
 void setContentFromClientFile(java.lang.String afileName)
          Replaces the in memory content of this object with the contents of the given file named.
 void setDatastore(dkDatastore ds)
          Sets the datastore associated with this object.
 void setExtension(java.lang.String extensionName, dkExtension extensionObj)
          Sets a system defined extension to this resource object.
 void setHttpStoreMethod(java.lang.String method)
          sets the http method.For ex: "POST" or "PUT".
 void setInputContentlength(int Clength)
          Sets the length of the data object to be stored.
 void setInputCreatedate(java.lang.String Cdate)
          Sets the timestamp creation date for this object during third party content store.
 void setInputFilelist(java.lang.String Filelist)
          Sets a list of files delimited by comma and with fully qualified path name to be the input of a third party content store.
 void setInputFilename(java.lang.String Filename)
          Sets the filename required for a third party content store.
 void setInputFilepath(java.lang.String Filepath)
          Sets the file path name of the input file(s) for a third party content store.
 void setInputProtocol(java.lang.String Protocol)
          Sets the protocol to be used for third party content store, retrieve or update.
 void setInputRetention(int Retention)
          Sets the number of days from the creation date for which the object is to be retained.
 void setInstanceOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
          Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object instance.
The method setClassOpenHandler(java.lang.String, boolean) sets the handler for the whole class, instead of only for this instance.
 void setMimeType(java.lang.String mType)
          Sets the MIME type for the content of this resource item.
 void setName(java.lang.String extName)
          Sets the name of this extension object.
 void setNewVersion(boolean newVersion)
          This method is used to specify if a new version is to be created when updating a part.
 void setNull()
          Sets the in-memory content of this object to null.
 void setOption(int option, java.lang.Object value)
          Sets the option aplicable to persistent operations on this object.
 void setOrgFileName(java.lang.String ofile)
          Sets the original filename for this resource.
 void setPartNumber(int partNum)
          Sets the part number of this resource in a document.
 void setResourceName(java.lang.String name)
          Sets the resource name or external object name for this resource.
 void setRMName(java.lang.String rmName)
          Sets the resource manager name used to store the content of this resource.
 void setSemanticType(int semanticType)
          Sets the semantic type of this resource.
 void setSMSCollName(java.lang.String smsCollName)
          Sets the SMS collection name in the resource manager, used to store the content of this object.
 void setThirdPartyHostname(java.lang.String Hostname)
          Sets the hostname required for a third party content store.
 void setThirdPartyPassword(java.lang.String Password)
          Sets the user password required for accessing the host for a third party content store, retrieve or update.
 void setThirdPartyPort(int Port)
          Sets the port number for accessing the host providing a third party content store.
 void setThirdPartyStore(boolean store)
          Sets this object to indicate that it will require a third party store into the resource manager.
 void setThirdPartyUserid(java.lang.String Userid)
          Sets the userId required for accessing the host for a third party content store, retrieve or update.
 void setUpdateDate(java.lang.String Upddate)
          Sets the update date to be used for third party content store.
 int size()
          Gets the actual size of this resource content in the persistent store.
 void update()
          Updates the meta-data and content of this resource in the persistent store from the value in memory.
 void update(java.io.InputStream is, long length)
          Updates the metadata in the datastore and object content in resource manager with the content from a stream file.
 void update(java.io.InputStream is, long length, int option)
          Updates the metadata in the datastore and object content in resource manager with the content from a stream file.
 void update(int option)
          Updates the meta-data in the datastore and object content in resource manager with the content in memory, according to the specified option.
 void update(java.lang.String aFullFileName)
          Updates this resource in the persistent store with content directly from the specified file.
 void update(java.lang.String aFullFileName, int option)
          Updates this resource in the persistent store with content directly from the specified file.
 void updateFrom()
          Updates the content and meta-data of the resource stored in the Resource Manager and Content Manager persistent store from a third party content source.
 void updateFrom(int option)
          Updates the content and meta-data of the resource stored in the Resource Manager and Content Manager persistent store from a third party content source.
 void updateFrom(java.lang.String hostname, java.lang.String userid, java.lang.String passwd, java.lang.String protocol, int port, java.lang.String filename, int option)
          Updates the content and meta-data of the resource stored in the Resource Manager and Content Manager persistent store from a third party content source.
 void updateFromAsync()
          Asynchronously updates the content and meta-data of the resource stored in the Resource Manager and Content Manager persistent store from a third party content source.
 void updateFromAsync(int option)
           
 void updateFromAsync(java.lang.String hostname, java.lang.String userid, java.lang.String passwd, java.lang.String protocol, int port, java.lang.String filename, int option)
          Asynchronously updates the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store from a third party content source identified by the supplied parameters.
 
Methods inherited from class com.ibm.mm.sdk.common.dkResource
cloneSkeleton, getClassName, getContentType, getRank, notEqual, protocol, setClassName, setContentType, setRank
 
Methods inherited from class com.ibm.mm.sdk.common.DKDDO
add, del, del, fromXML, fromXML, getDatastore, retrieve, toXML, update
 
Methods inherited from class com.ibm.mm.sdk.common.DKDDOBase
addData, addData, addData, addDataProperty, addDataProperty, addDataProperty, addProperty, addProperty, addProperty, dataCount, dataId, dataId, dataIdsByNameSpace, dataNameSpaceCount, dataPropertyCount, dataPropertyId, getData, getDataByName, getDataByName, getDataName, getDataNameSpace, getDataProperty, getDataPropertyByName, getDataPropertyByName, getDataPropertyByName, getDataPropertyName, getObjectType, getProperty, getPropertyByName, getPropertyName, isDataPropertySet, isDataSet, isNull, isPropertySet, propertyCount, propertyId, setData, setDataName, setDataName, setDataNameSpace, setDataProperty, setDataPropertyName, setNull, setObjectType, setProperty, setPropertyName, updatable
 
Methods inherited from class com.ibm.mm.sdk.common.dkDataObject
getPid, getPidObject, setPid, setPidObject
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDataObjectBase
getParent, getRootObject, setParent, setRootObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.mm.sdk.common.dkXDO
datastore, getDatastore, getPid, getPidObject, setPid, setPidObject
 
Methods inherited from interface com.ibm.mm.sdk.common.dkDataObjectBase
getObjectType, getParent, getRootObject, setParent, setRootObject
 

Constructor Detail

DKLobICM

public DKLobICM()
         throws DKUsageError,
                java.lang.Exception
The default constructor for generic resource objects.
Throws:
DKUsageError - on error.
java.lang.Exception - on error.

DKLobICM

public DKLobICM(dkDatastore ds)
         throws DKUsageError,
                java.lang.Exception
Constructs a generic resource object associated with the given datastore.
Parameters:
ds - the associated datastore, a DKDatastoreICM object.
Throws:
DKUsageError - on error.
java.lang.Exception - on errors.

DKLobICM

public DKLobICM(dkDatastore ds,
                byte[] buf)
         throws DKException,
                java.lang.Exception
Constructs a generic resource object associated with the datastore, then sets the initial content to the given byte array. Caution: this constructor is only applicable for small objects.
Parameters:
ds - the associated datastore, a DKDatastoreICM object.
buf - the byte array as the initial content of this resource.
Throws:
DKException - on errors.
java.lang.Exception - on errors.

DKLobICM

public DKLobICM(DKLobICM aDKLobICM)
         throws DKException,
                java.lang.Exception
The copy constructor for this object.
Parameters:
aDKLobICM - an instance of DKLobICM to copy from.
Throws:
DKException - on errors.
java.lang.Exception - on errors.
Method Detail

setRMName

public void setRMName(java.lang.String rmName)
Sets the resource manager name used to store the content of this resource.
Parameters:
rmName - a string identifier of the resource manager name.

getRMName

public java.lang.String getRMName()
                           throws java.lang.Exception
Gets the resource manager name used to store the content of this resource.
Throws:
java.lang.Exception - on errors.

setSMSCollName

public void setSMSCollName(java.lang.String smsCollName)
Sets the SMS collection name in the resource manager, used to store the content of this object.
Parameters:
smsCollName - a string identifier of the SMS collection name.

getSMSCollName

public java.lang.String getSMSCollName()
                                throws java.lang.Exception
Gets the SMS collection name from the resource manager, used to store the content of this object.
Throws:
java.lang.Exception - on errors.

isContentChanged

public boolean isContentChanged()
Checks if the in-memory content of this resource has been changed.
Overrides:
isContentChanged in class dkResource
Returns:
true if the object content is changed in-memory; false otherwise.

setContentChanged

public void setContentChanged(boolean aFlag)
Sets the content changed indicator to true or false. True means that the content has been updated in-memory.
Parameters:
aFlag - a boolean value true to indicate that the content has been changed; false means unchanged.

isSet

public boolean isSet()
Checks if the in-memory content of this object has been set.
Overrides:
isSet in class dkResource
Returns:
true if the object's content is set; false otherwise.

isNull

public boolean isNull()
Checks if the in-memory content of this object is null. Returns true if it is null.
Overrides:
isNull in class dkResource
Returns:
true if the object's content is null; false otherwise.

setNull

public void setNull()
Sets the in-memory content of this object to null.
Overrides:
setNull in class dkResource

equals

public boolean equals(dkXDOBase adkXDOBase)
               throws DKException
Description copied from class: dkResource
Check if this resource is equal to the given resource Each subclass must override this method to provide a specific implemntation appropriate for it.
Overrides:
equals in class dkResource
Parameters:
adkXDOBase - an instance of dkXDOBase
Returns:
true if the objects have the same type, persistent identifier, content and search index information; false otherwise.
Throws:
DKException - if objects are not the same class.

copyData

public void copyData(dkXDO adkXDO)
              throws DKException,
                     java.lang.Exception
Replaces the content of this object with the content of the other resource object.
Overrides:
copyData in class dkResource
Parameters:
adkXDO - the other XDO object to copy the content from.
Throws:
DKException - on error.
java.lang.Exception - on error.

compareData

public boolean compareData(dkXDO adkXDO)
                    throws DKException,
                           java.lang.Exception
Compares the content of this object with the content of another resource object.
Overrides:
compareData in class dkResource
Parameters:
adkXDO - the other resource object.
Throws:
DKException - if object type differs.
java.lang.Exception - on error.

setContent

public void setContent(byte[] aByteArray)
Sets the content of this object to the given byte array value.
Overrides:
setContent in class dkResource
Parameters:
aByteArray - a byte array.

getContent

public byte[] getContent()
                  throws DKException,
                         java.lang.Exception
Gets the content of this object.
Overrides:
getContent in class dkResource
Returns:
the object's content as a byte array.
Throws:
DKException - if object type differs.
java.lang.Exception - on error.

getContentToClientFile

public void getContentToClientFile(java.lang.String afileName,
                                   int fileOption)
                            throws DKException,
                                   java.lang.Exception
Copies the content of this object to the given file.
Overrides:
getContentToClientFile in class dkResource
Parameters:
afileName - a fully qualified path with file name. If no path is supplied, the default is in the current directory.
fileOption. - The following are valid file options:
  • OVERWRITE : it will create a new file or overwrite an existing file;
  • NOOVERWRITE : it will only create a new file, but will also throw an exception if the file already exists;
  • APPEND : it will appends to an existing file.
Throws:
DKException - on error.
java.lang.Exception - on error.

loadDataFromFile

public boolean loadDataFromFile(java.lang.String afileName)
                         throws DKException,
                                java.lang.Exception
Replaces the content of this object with the contents of the file afileName.
Parameters:
afileName - a fully qualified path with file name. If no path is specified, the default is in the current directory.
Throws:
DKException - on error.
java.lang.Exception - on error.

setContentFromClientFile

public void setContentFromClientFile(java.lang.String afileName)
                              throws DKException
Replaces the in memory content of this object with the contents of the given file named. No server communication is involved. This is the same as loadDataFromFile(java.lang.String) method.
Overrides:
setContentFromClientFile in class dkResource
Parameters:
afileName - a fully qualified path with file name. If no path is specified, the default is in the current directory.
Throws:
DKException - on error.

open

public void open()
          throws DKException,
                 java.lang.Exception
Unloads the object's content to a client file with a system generated name and then synchronously invokes a default handler against the file. The executable handler program name has to be set before calling this method.
A handler is a program which knows how to process the file, it could be simply a text editor or a viewer for a particular content type.
Overrides:
open in class dkResource
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
setInstanceOpenHandler(String,boolean)

open

public void open(java.lang.String afileName)
          throws DKException,
                 java.lang.Exception
Unloads the object's content to the given file name and then synchronously invoke a default handler against the file. The executable handler program name has to be set before calling this method.
Overrides:
open in class dkResource
Parameters:
afileName - the provided file name.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
setInstanceOpenHandler(java.lang.String, boolean)

setInstanceOpenHandler

public void setInstanceOpenHandler(java.lang.String ahandler,
                                   boolean newSynchronousFlag)
Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object instance.
The method setClassOpenHandler(java.lang.String, boolean) sets the handler for the whole class, instead of only for this instance.
Overrides:
setInstanceOpenHandler in class dkResource
Parameters:
ahandler - the handler program name to view the content. It could be simply a text editor or a specific viewer for this content type.
newSynchronousFlag - true for synchronous process; false otherwise.
See Also:
open(), open(java.lang.String), setClassOpenHandler(java.lang.String, boolean)

setClassOpenHandler

public void setClassOpenHandler(java.lang.String ahandler,
                                boolean newSynchronousFlag)
Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object's class.
The method setInstanceOpenHandler(java.lang.String, boolean) sets the handler for the object's instance only, instead of for the whole class.
Overrides:
setClassOpenHandler in class dkResource
Parameters:
ahandler - the handler program name to view the content.
newSynchronousFlag - true for synchronous process; false otherwise.
See Also:
open(), open(java.lang.String), setInstanceOpenHandler(java.lang.String, boolean)

getOpenHandler

public java.lang.String getOpenHandler()
Gets the current program name of the handler for this object's instance.
Overrides:
getOpenHandler in class dkResource
Returns:
the instance handler program name.
See Also:
setInstanceOpenHandler(java.lang.String, boolean)

isOpenSynchronous

public boolean isOpenSynchronous()
Checks the synchronization property of the current executable handler program. Returns true if it operates synchronously; false otherwise.
Overrides:
isOpenSynchronous in class dkResource
Returns:
true or false.
See Also:
setClassOpenHandler(java.lang.String, boolean), setInstanceOpenHandler(java.lang.String, boolean)

getItemId

public java.lang.String getItemId()
Gets the itemId of this resource item.
Returns:
the itemId of this object.

getVersionNumber

public java.lang.String getVersionNumber()
Gets the version number of this resource item. The version number is an integer that starts from one, and goes up if this item is versioned and new versions are created.
Returns:
java.lang.String the version number of this resource item.

getAffiliatedType

public int getAffiliatedType()
                      throws DKException,
                             java.lang.Exception
Deprecated. Replace by #getSemanticType() Gets the affiliated type of this object. The affiliated type could be DK_CM_ANNOTATION, DK_CM_NOTE, DK_CM_BASE, etc.

Description copied from class: dkResource
Gets the affiliated type of this object. An affiliated type could be ANNOTATION, NOTES, etc. The subclass need to override the behaviour of the default implementation of this method.
Overrides:
getAffiliatedType in class dkResource
Returns:
the affiliated type of this object.

setAffiliatedType

public void setAffiliatedType(int aflType)
                       throws DKException,
                              java.lang.Exception
Deprecated. Replace by setSemanticType(int) Sets the affiliated type of this object.

Description copied from class: dkResource
Sets the affiliated type for this object. The subclass need to override the behaviour of the default implementation of this method.

Note:DKUsageError exception thrown if method is not implemented

Overrides:
setAffiliatedType in class dkResource
Parameters:
aflType - the affiliated type of this object.

setSemanticType

public void setSemanticType(int semanticType)
                     throws DKException,
                            java.lang.Exception
Sets the semantic type of this resource. Semantic types can be used to classify resources.
Given a specific document model the resources of a collection described by that model could be classified using some specific categories. For example, a data model may specifies that every resource might have one or more associated proxy version. One could have, resources with a semantic type of ORIGINAL, or HTMLPROXY, XMLPROXY, LOWResolutionProxy etc..
Semantic types are generaly user defined and as such are under user control, except system defined types. There are system defined semantic types: DK_CM_FOLDER, DK_CM_DOCUMENT or DK_CM_ITEM.
Parameters:
semanticType - the semantic type of this object.
Throws:
DKException - on error.
java.lang.Exception - on error.

setMimeType

public void setMimeType(java.lang.String mType)
                 throws DKException,
                        java.lang.Exception
Sets the MIME type for the content of this resource item.
Overrides:
setMimeType in class dkResource
Parameters:
mType - the MIME type.
Throws:
DKException - if the mime type specified is not found in the CM Library Server.
java.lang.Exception - on error.

getMimeType

public java.lang.String getMimeType()
                             throws DKException,
                                    java.lang.Exception
Gets the MIME type of the content of this resource item.
Overrides:
getMimeType in class dkResource
Returns:
the MIME type.
Throws:
DKException - on error.
java.lang.Exception - on error.

getCreatedTimestamp

public java.lang.String getCreatedTimestamp()
                                     throws DKException,
                                            java.lang.Exception
Gets the timestamp when this object was created.
Returns:
the creation timestamp of this object.
Throws:
DKException - on error.
java.lang.Exception - on error.

getUpdatedTimestamp

public java.lang.String getUpdatedTimestamp()
                                     throws DKException,
                                            java.lang.Exception
Gets the timestamp when this object was last updated.
Returns:
the last updated timestamp of this object.
Throws:
DKException - on error.
java.lang.Exception - on error.

getReferencedTimestamp

public java.lang.String getReferencedTimestamp()
                                        throws DKException,
                                               java.lang.Exception
Gets the timestamp when this object was last updated.
Returns:
the last updated timestamp of this object.
Throws:
DKException - on error.
java.lang.Exception - on error.

size

public int size()
         throws DKException,
                java.lang.Exception
Gets the actual size of this resource content in the persistent store.
Overrides:
size in class dkResource
Returns:
the object's size.
Throws:
DKException - on error.
java.lang.Exception - on error.

length

public int length()
           throws DKException,
                  java.lang.Exception
Gets the actual size of this resource content in memory. All subclasses need to overide the behavior of the default implementation of this method.
Overrides:
length in class dkResource
Returns:
a byte length of this resource content in memory.
Throws:
DKException - on error.
java.lang.Exception - on error.

getOption

public java.lang.Object getOption(int option)
                           throws DKException,
                                  java.lang.Exception
Gets the delete or retrieval option to perform the delete or retrieve action.
Overrides:
getOption in class dkResource
Returns:
a retrieval or delete option
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
setOption(int, java.lang.Object).

setOption

public void setOption(int option,
                      java.lang.Object value)
               throws DKException,
                      java.lang.Exception
Sets the option aplicable to persistent operations on this object.
Overrides:
setOption in class dkResource
Parameters:
option - an option. The valid options are:
  • DK_DL_OPT_DELETE_OPTION: for delete
  • DK_DL_OPT_RETRIEVAL_ACTION: for retrieve
value - the option value. For DK_DL_OPT_DELETE_OPTION, the valid values are:
    For Non-media objects only:
    • DK_DELETE_ITEM - Deletes this item if no more parts are left in the item.
    • DK_DELETE_OBJECT_ONLY (default if not set) - Don't delete this item, even if there are no more parts left in the item.
    For Media objects only:
    • DK_DELETE_NO_DROPITEM_MEDIA_AVAIL - Don't delete the item if there is no part left in the item. Media parts (media objects) cannot be deleted when they are in use.
    • DK_DELETE_NO_DROPITEM_MEDIA_INUSE - Don't delete the item, even if there are no parts left in the item. Media parts (media objects) can be deleted, even if they are in use.
    • DK_DELETE_DROPITEM_MEDIA_AVAIL - Deletes the item if there is no part left in the item. Media parts (media objects) cannot be deleted when they are in use.
    • DK_DELETE_DROPITEM_MEDIA_INUSE - Deletes the item if there is no part left in the item. Media parts (media objects) can be deleted, even if they are in use.
For DK_DL_OPT_RETRIEVAL_ACTION, the valid values are:
  • DK_RETRIEVAL_GET_IT
  • DK_RETRIEVAL_GET_IT_PREFETCH
  • DK_RETRIEVAL_NO_MOUNT
  • DK_RETRIEVAL_NO_MOUNT_PREFETCH
  • DK_RETRIEVAL_STAGE_IT
  • DK_RETRIEVAL_STAGE_IT_PREFETCH
Throws:
DKException - on error.
java.lang.Exception - on error.

setExtension

public void setExtension(java.lang.String extensionName,
                         dkExtension extensionObj)
                  throws DKException,
                         java.lang.Exception
Sets a system defined extension to this resource object. The extension has an identifier and the corresponding object that implements the extension functions. This method provides the same function as addExtension(java.lang.String, com.ibm.mm.sdk.common.dkExtension).
Parameters:
extensionName - the extension name. The valid extension names are:
  • DKStorageManageInfoICM - To associate this part with a different storage colleciton name, this extension object needs to be set to hold the storage collection information.
extensionObj - a source extension object
Throws:
DKException - on error
java.lang.Exception - on error
See Also:
addExtension(java.lang.String, com.ibm.mm.sdk.common.dkExtension)

addExtension

public void addExtension(java.lang.String extensionName,
                         dkExtension extensionObj)
                  throws DKException,
                         java.lang.Exception
Adds an extension to this resource object. The extension has an identifier and the corresponding object that implements the extension functions.
Overrides:
addExtension in class dkResource
Parameters:
extensionName - the extension name.

The valid extension names are:

extensionObj - a source extension object.
Throws:
DKException - on error.
java.lang.Exception - on error.

getExtension

public dkExtension getExtension(java.lang.String extensionName)
                         throws DKException,
                                java.lang.Exception
Gets the extension object with the given name.
Overrides:
getExtension in class dkResource
Parameters:
extensionName - the extension name.

The valid extension names are:

Returns:
a dkExtension object for the specified extension name.
Throws:
DKException - on error.
java.lang.Exception - on error.

removeExtension

public void removeExtension(java.lang.String extensionName)
                     throws DKException
Remove the extension object with the given name.
Overrides:
removeExtension in class dkResource
Parameters:
extensionName - the extension name.
Throws:
DKException - on error.

changeStorage

public void changeStorage()
                   throws DKException,
                          java.lang.Exception
Changes the system-managed storage (SMS) criteria for this object. This method effectively causes a move of the resource from one collection to another collection on the same Resource Manager. The collection name must be valid on the Library Server and Resource Manager where the object is being stored. The object cannot be moved from one server to another without using this function.
Throws:
DKException - on error.
java.lang.Exception - on error.

getResourceName

public java.lang.String getResourceName()
Gets the resource name or external object name of this resource.
See Also:
setResourceName(java.lang.String)

setResourceName

public void setResourceName(java.lang.String name)
Sets the resource name or external object name for this resource. An external object name is a string identifier assigned as the external name for this object.
Parameters:
the - external object name.
See Also:
getResourceName()

setDatastore

public void setDatastore(dkDatastore ds)
Sets the datastore associated with this object.
Overrides:
setDatastore in class DKDDO
Parameters:
ds - a dkDatastore, in this case a DKDatastoreICM object.

getOrgFileName

public java.lang.String getOrgFileName()
                                throws DKException,
                                       java.lang.Exception
Gets the original filename of this resource. The original file is the file from which content is read to store as a resource.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
setOrgFileName(java.lang.String)

setOrgFileName

public void setOrgFileName(java.lang.String ofile)
Sets the original filename for this resource. The original file is the file from which content is read to store as a resource.
Parameters:
ofile - the original file name.

getName

public java.lang.String getName()
                         throws java.lang.Exception
Gets the name of this extension object.
Parameters:
extName - name of this extension object.
Throws:
java.lang.Exception - on error.

setName

public void setName(java.lang.String extName)
             throws java.lang.Exception
Sets the name of this extension object.
Parameters:
extName - name of this extension object.
Throws:
java.lang.Exception - on error.

add

public void add()
         throws DKException,
                java.lang.Exception
Adds or stores the content and meta-data of this resource object into the persistent store. The content is stored in the Resource Manager and the meta-data describing the content is stored in the Library Server of Content Manager. Both information are tied together.
If the content is not available, then only the meta-data is created. The content can be added later.
Overrides:
add in class dkResource
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
DKDatastoreICM.addObject(dkDataObject), add(String), add(InputStream,long)

add

public void add(int option)
         throws DKException,
                java.lang.Exception
Adds or stores the content and meta-data of this resource object into the persistent store. The content is stored in the Resource Manager and the meta-data describing the content is stored in the Library Server of Content Manager. Both information are tied together.
If the content is not available, then only the meta-data is created. The content can be added later.
Overrides:
add in class DKDDO
Parameters:
option - see DKDatastoreICM.addObject(dkDataObject, int)
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
DKDatastoreICM.addObject(dkDataObject, int), add(String), add(InputStream,long)

getPartNumber

public int getPartNumber()
Gets the part number of this resource in a document. Returns an integer part number if this resource is a part of a document.
See Also:
setPartNumber(int)

setPartNumber

public void setPartNumber(int partNum)
Sets the part number of this resource in a document. This method is valid only if this resource is a part of a document.
Parameters:
partNum - the integer part number.

add

public void add(java.lang.String aFullFileName)
         throws DKException,
                java.lang.Exception
Adds the content and meta-information of this resource object into the persistent store with input file. The content is stored directly from the given file into the Resource Manager. The meta-information is stored in the Library Server of Content Manager. Both information are tied together.
Overrides:
add in class dkResource
Parameters:
aFullFileName - a fully qualified path and file name, default is the current directory.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
add(), add(InputStream,long), DKDatastoreICM.addObject(com.ibm.mm.sdk.common.dkDataObject)

add

public void add(java.lang.String aFullFileName,
                int option)
         throws DKException,
                java.lang.Exception
Adds the content and meta-information of this resource object into the persistent store with input file. The content is stored directly from the given file into the Resource Manager. The meta-information is stored in the Library Server of Content Manager. Both information are tied together.
Parameters:
aFullFileName - a fully qualified path and file name, default is the current directory.
option - see DKDatastoreICM.addObject(com.ibm.mm.sdk.common.dkDataObject, int)
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
add(), add(InputStream,long), DKDatastoreICM.addObject(com.ibm.mm.sdk.common.dkDataObject, int)

add

public void add(java.io.InputStream is,
                long length)
         throws DKException,
                java.lang.Exception
Adds the content and meta-information of this resource object into the persistent store with input stream. The content is stored directly from the given input stream into the Resource Manager. The meta-information is stored in the Library Server of Content Manager. Both information are tied together.
Parameters:
InputStream - a valid input stream object.
length - the number of bytes to be stored.
Throws:
DKException - if stream is null or on other communication errors.
java.lang.Exception - on error.

add

public void add(java.io.InputStream is,
                long length,
                int option)
         throws DKException,
                java.lang.Exception
Adds the content and meta-information of this resource object into the persistent store with input stream. The content is stored directly from the given input stream into the Resource Manager. The meta-information is stored in the Library Server of Content Manager. Both information is tied together.
Parameters:
InputStream - a valid input stream object.
length - the number of bytes to be stored.
option - see DKDatastoreICM.addObject(dkDataObject, int)
Throws:
DKException - if stream is null or on other communication errors.
java.lang.Exception - on error.
See Also:
add(), add(String), DKDatastoreICM.addObject(dkDataObject, int)

addFrom

public void addFrom()
             throws DKException,
                    java.lang.Exception
Adds or store a resource from a third party source to the Resource Manager and Content Manager persistent store. The information describing the third party source, such as hostname, userId, password, protocol, port number, and file name needs to be set prior to calling this method.
The content store takes place synchronously. This request along with the necessary parameters is passed to the CM Resource Manager, which on behalf of the end user will contact the specified host, using the specified protocol to get the content from the given file name. The RM must be able to reach this host via a standard network connection using the protocol specified in the protocol field.
This method can also be used to perform the store of a streamable resource onto a RM or a Video Charger.
Throws:
DKException - on error.
java.lang.Exception - on error.

addFrom

public void addFrom(int option)
             throws DKException,
                    java.lang.Exception
Adds or store a resource from a third party source to the Resource Manager and Content Manager persistent store. The information describing the third party source, such as hostname, userId, password, protocol, port number, and file name needs to be set prior to calling this method. The content store takes place synchronously. This request along with the necessary parameters is passed to the CM Resource Manager, which on behalf of the end user will contact the specified host, using the specified protocol to get the content from the given file name. The RM must be able to reach this host via a standard network connection using the protocol specified in the protocol field.
This method can also be used to perform the store of a streamable resource onto a RM or a Video Charger.
Parameters:
option - see DKDatastoreICM.addObject(dkDataObject, int)
Throws:
DKException - on error.
java.lang.Exception - on error.

addFrom

public void addFrom(java.lang.String hostname,
                    java.lang.String userid,
                    java.lang.String passwd,
                    java.lang.String protocol,
                    int port,
                    java.lang.String filename,
                    int option)
             throws DKException,
                    java.lang.Exception
Adds or store a resource from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store.
The content store takes place synchronously. See the description of method addFrom() for more information.
Parameters:
hostname - the name of the host where the content is located.
userid - the user id to use on the host for retrieving the content.
password - the password for this user id.
protocol - the name of the protocol for transferring the content e.g. ftp.
port - the port number, by which the host can be reached using the specified protocol.
filename - a fully qualified path and file name, where the content is stored. By default the file is expected to be in the current login directory.
option - see DKDatastoreICM.addObject(dkDataObject, int).
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
addFrom()

addFromAsync

public void addFromAsync(java.lang.String hostname,
                         java.lang.String userid,
                         java.lang.String passwd,
                         java.lang.String protocol,
                         int port,
                         java.lang.String filename,
                         int option)
                  throws DKException,
                         java.lang.Exception
Adds or store a resource asynchronously from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store. See the description of method addFrom() for more information.
During the uploading process, the resource status is set to "Load Pending", until the process is completed.
Parameters:
hostname - the name of the host where the content is located.
userid - the user id to use on the host for retrieving the content.
password - the password for this user id.
protocol - the name of the protocol for transferring the content e.g. ftp.
port - the port number, by which the host can be reached using the specified protocol.
filename - a fully qualified path and file name, where the content is stored. By default the file is expected to be in the current login directory.
option - see DKDatastoreICM.addObject(dkDataObject, int).
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
addFrom()

addFromAsync

public void addFromAsync()
                  throws DKException,
                         java.lang.Exception
Adds or store a resource asynchronously from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store. The information describing the third party source, such as hostname, userId, password, protocol, port number, and file name must be set prior to calling this method. See the description of method addFrom() for more information.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
addFrom(), addFromAsync()

setThirdPartyStore

public void setThirdPartyStore(boolean store)
Sets this object to indicate that it will require a third party store into the resource manager. Returns true if this object is prepared for a third party store and requesting this service to the resource manager. If the addFrom(), addFromAsync() related methods are being used to store, then this flag is not required to be set. This is used only in context to Document model parts operations.
Parameters:
store - true or false; true indicates a setup for third party store.
See Also:
getThirdPartyStore()

getThirdPartyStore

public boolean getThirdPartyStore()
Checks if this object is prepared for a third party content store.
Returns:
true if this object is prepared for a third party store and will be requesting this service to the resource manager.
See Also:
setThirdPartyStore(boolean)

setThirdPartyUserid

public void setThirdPartyUserid(java.lang.String Userid)
Sets the userId required for accessing the host for a third party content store, retrieve or update. This is a required parameter for third party operations for certain protocols like ftp.
Parameters:
Userid - the user id for the third party host.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync()

setThirdPartyPassword

public void setThirdPartyPassword(java.lang.String Password)
Sets the user password required for accessing the host for a third party content store, retrieve or update. This is a required parameter for third party operations for certain protocols like ftp.
Parameters:
Password - the password for the user id to be used for the third party host.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync()

setThirdPartyHostname

public void setThirdPartyHostname(java.lang.String Hostname)
Sets the hostname required for a third party content store. This is a required parameter for all third party operations.
Parameters:
hostname - the name of the third party host providing the service.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync()

setInputFilename

public void setInputFilename(java.lang.String Filename)
Sets the filename required for a third party content store. The filename is the source to load the content from. This is a required parameter for all third party operations.
Parameters:
filename - the name of the file for third party store.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync()

setInputFilelist

public void setInputFilelist(java.lang.String Filelist)
Sets a list of files delimited by comma and with fully qualified path name to be the input of a third party content store. All files get stored as one single resource object. This is an optional parameter for third party operations.
Parameters:
filelist - a list of filenames as a source for a third party store.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync()

setThirdPartyPort

public void setThirdPartyPort(int Port)
Sets the port number for accessing the host providing a third party content store. This port would be specific to the protocol specified for third party store.
Parameters:
port - the port number to be used for third party store.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync()

setInputFilepath

public void setInputFilepath(java.lang.String Filepath)
Sets the file path name of the input file(s) for a third party content store. This can be used to provide a fully qualified path to the files specified in the Filename or Filelist.This is optional.
Parameters:
filepath - the path for the input files for third party store.
See Also:
#setInputFilelist(), #setInputFilename(), addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync()

setInputCreatedate

public void setInputCreatedate(java.lang.String Cdate)
Sets the timestamp creation date for this object during third party content store. This is optional.
Parameters:
Cdate - a timestamp in ISO Julian Format.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync()

setInputContentlength

public void setInputContentlength(int Clength)
Sets the length of the data object to be stored. It is in base 10 formatted 64 bit integer. It is the physical size of the file from which the content is being stored. This is required.
Parameters:
Clength - - the size of the content to be stored using third party store.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync()

setInputRetention

public void setInputRetention(int Retention)
Sets the number of days from the creation date for which the object is to be retained. This value is optional, the default is 0, which means retain forever.
Parameters:
Retention - the number of days to retain an object using third party store.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync()

setInputProtocol

public void setInputProtocol(java.lang.String Protocol)
Sets the protocol to be used for third party content store, retrieve or update. This is required to be specified.
Parameters:
protocol - the protocol to be used for party store e.g. ftp.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync()

setUpdateDate

public void setUpdateDate(java.lang.String Upddate)
Sets the update date to be used for third party content store. This is optional.
Parameters:
Upddate - A timestamp.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync()

getThirdPartyHostname

public java.lang.String getThirdPartyHostname()
Gets the system hostname specified for third party content store, retrieve or update.
Returns:
the hostname set for third party operations.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync(), setThirdPartyHostname(java.lang.String)

getThirdPartyUserid

public java.lang.String getThirdPartyUserid()
Gets the userId set for third party content store, update or retrieve.
Returns:
the userId set for third party operations.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync(), setThirdPartyUserid(java.lang.String)

getThirdPartyPassword

public java.lang.String getThirdPartyPassword()
Gets the user's password set for third party content store, update or retrieve.
Returns:
the user password specified for third party operations.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync(), setThirdPartyPassword(java.lang.String)

getThirdPartyPort

public int getThirdPartyPort()
Gets the host port number to be used for third party content store, update or retrieve.
Returns:
the port number set for third party operations.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync(), setThirdPartyPort(int)

getInputFilename

public java.lang.String getInputFilename()
Gets the input file name to be used for third party content store, update or retrieve.
Returns:
the file name set for third party operations.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync(), setInputFilename(java.lang.String)

getInputFilelist

public java.lang.String getInputFilelist()
Gets the input file list separated by comma to be used for third party content store, update or retrieve.
Returns:
the file list set for third party operations.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync(), setInputFilelist(java.lang.String)

getInputFilepath

public java.lang.String getInputFilepath()
Gets the path of the input file(s) for third party content store, update or retrieve.
Returns:
the file(s) path set for third party operations.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync(), setInputFilepath(java.lang.String)

getInputCreatedate

public java.lang.String getInputCreatedate()
Gets the ISO Format Julian Timestamp create-date, if set during third party store.
Returns:
a timestamp in ISO Format Julian.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync(), setInputCreatedate(java.lang.String)

getInputContentlength

public int getInputContentlength()
Gets the length of the resource content that was stored using third party store or update. It is the physical size of the content file that was stored.
Returns:
the size of the content to be stored.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync(), setInputContentlength(int)

getInputRetention

public int getInputRetention()
Gets the number of days from the creation date for which this object is to be retained.
Returns:
the retention date; 0 means retain forever.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync(), setInputRetention(int)

getInputProtocol

public java.lang.String getInputProtocol()
Gets the protocol specified to be used with the third party content store.
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync(), setInputProtocol(java.lang.String)

getUpdateDate

public java.lang.String getUpdateDate()
Gets the update date specified to be used with the third party content store.
Returns:
a date
See Also:
addFrom(), updateFrom(), retrieveTo(), addFromAsync(), updateFromAsync(), setUpdateDate(java.lang.String)

retrieve

public java.lang.Object retrieve(int option,
                                 long offset,
                                 long len)
                          throws DKException,
                                 java.lang.Exception
Retrieves resource meta-data from the library server and the whole or partial content object from the Resource Manager to the memory buffer.
Parameters:
option - see retrieve(int).
offset - for partial content only. The offset of the resource.
length - for partial content only. The number of bytes from the offset. A length of -1, signifies the end of resource.
If both offset and length are -1, it means to retrieve the entire object.
Throws:
DKException - on error.
java.lang.Exception - on error.

retrieve

public void retrieve(int option)
              throws DKException,
                     java.lang.Exception
Retrieves the meta-data from the Library Server and the content from Resource Manager persistent store.
Overrides:
retrieve in class DKDDO
Parameters:
option - acceptable values can be:
  • DK_CM_CONTENT_YES - Retrieve meta data and content.
  • DK_CM_CONTENT_NO - Retrieve meta only.
  • DK_CM_CONTENT_ONLY - Retrieve content only , assuming meta is retrieved.
  • DK_CM_CONTENT_ATTRONLY- Retrieves Item Attributes.
  • DK_CM_CONTENT_CHILDREN- Retrieves the children of the current DDO.
  • DK_CM_CONTENT_LINKS - Retrieves Inbound and Outbound links.
  • DK_CM_CONTENT_ONELEVEL- Retrieves all information, including attributes, child components, but without links, for the current component level in the hierarchy.
  • DK_CM_CONTENT_ITEMTREE- Retrieves the whole item tree hierarchy.
  • DK_CM_VERSION_LATEST - Retrieves the latest version of this item.
  • DK_CM_CHECKOUT - Retrieves the item and checks it out.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
com.ibm.mm.sdk.server.DKDatastoreICM#retrieveObject(), retrieve()

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Retrieves the meta-data from the Library Server and the content from Resource Manager persistent store. This is the default retrieve. It always retrieves the entire data object.
Overrides:
retrieve in class dkResource
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
com.ibm.mm.sdk.server.DKDatastoreICM#retrieveObject()

retrieve

public void retrieve(int option,
                     java.lang.String fileName,
                     int offset,
                     int length)
              throws DKException,
                     java.lang.Exception
Retrieves the meta-data for this object and a partial or whole content from the resource manager to the specified file name.
Parameters:
fileName - a fully qualified path and file name, the default is current directory.
option - valid retrieval option , default -1. for other options. See DKLobICM#retrieve(int)
offset - for partial content retrieval only. The byte offset position in the resource.
length - for partial content retrieval only. The number of bytes from the offset. A value of 1 indicates up to the end of resource.
Offset -1 and length -1 means retrieve the whole object.
Throws:
DKException - on error.
java.lang.Exception - on error.

retrieve

public void retrieve(java.lang.String fileName)
              throws DKException,
                     java.lang.Exception
Retrieves this resource from the persistent store, but streams the content directly into the specified filename.
Overrides:
retrieve in class dkResource
Parameters:
fileName - a fully qualified path and file name, the default is in the current directory.
Throws:
DKException - on error.
java.lang.Exception - on error.

getInputStream

public java.io.InputStream getInputStream(int option,
                                          int offset,
                                          int length)
                                   throws DKException,
                                          java.lang.Exception
Retrieves the object's content from the persitent store to a stream.
Parameters:
option - valid options, the default is -1.
offset - for partial content only. The byte offset position in the resource.
length - for partial content only. The number of bytes from the offset, -1 means to the end of the Resource.
Offset -1 and length -1, means retrieve the whole object.
Returns:
the input stream.
Throws:
DKException - on error.
java.lang.Exception - on error.

getContentURL

public java.lang.String getContentURL(int option,
                                      int offset,
                                      int len)
                               throws DKException,
                                      java.lang.Exception
Gets the URL address to be used for retrieving the content directly from the Resource Manager.
Parameters:
option - - valid option to retrieve the meta-data. Valid option values:
  • DK_CM_VERSION_LATEST - Retrieve the latest version of this item.
  • DK_CM_CHECKOUT - Checkout the item.
An option value of -1 implies DK_CM_CHECKOUT.
offset - the byte offset in the resource.
len - the number of bytes from the offset. To retrieve entire object set offset to -1 and len to -1.
Returns:
the URL address of the content.
Throws:
DKException - on error.
java.lang.Exception - on error.

getContentURL

public java.lang.String getContentURL(int operation,
                                      int option,
                                      int offset,
                                      int len)
                               throws DKException,
                                      java.lang.Exception
Gets the URL address to be used for retrieving the content directly from the Resource Manager. to the Resource Manager
Parameters:
operation - specifies the operation to perform. Valid operations can be :
  • DK_CM_RETRIEVE - retrieve the content directly from the Resource Manager.
  • DK_CM_STORE - store the content directly to the Resource Manager.
  • DK_CM_UPDATE - update the content directly on to the Resource Manager.
option - options for the operation to be performed. Valid values are:
    For DK_CM_RETRIEVE option can be:
    • DK_CM_VERSION_LATEST - retrieve the latest version of this item.
    • DK_CM_CHECKOUT - perform a checkout of the item from the Library Server.
    • An option of -1 is the same as DK_CM_CHECKOUT.
    For DK_CM_STORE option can be:
    • DK_CM_CHECKOUT - perform a checkout of the item from the Library Server.
    • DK_CM_CHECKIN - perform a checkin of the item in the Library Server after the store is complete.
    • An option of -1 is the same as DK_CM_CHECKIN.
    For DK_CM_UPDATE option can be:
    • DK_CM_CHECKOUT - perform a checkout of the item from the Library Server.
    • DK_CM_CHECKIN - perform a checkin of the item in the Library Server after the update is complete.
    • An option of -1 is the same as DK_CM_CHECKIN.
offset - the byte offset in the resource.
len - the number of bytes from the offset. To retrieve or update entire object set offset to -1 and len to -1.
Returns:
the URL address of the content.
Throws:
DKException - on invalid options.
java.lang.Exception - on error.

retrieveTo

public void retrieveTo()
                throws DKException,
                       java.lang.Exception
Retrieves the content and meta-data of the resource stored in the Resource Manager and Content Manager persistent store to a third party destination. The information describing the third party destination, such as hostname, userId, password, protocol, port number and file name, must be set prior to calling this method.
The retrieval takes place synchronously.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
addFrom(), addFromAsync(), updateFrom(), updateFromAsync()

retrieveToAsync

public void retrieveToAsync()
                     throws DKException,
                            java.lang.Exception
Asynchronously retrieves the content and meta-data of the resource stored in the Resource Manager and Content Manager persistent store to a third party destination. The information describing the third party destination, such as hostname, userId, password, protocol, and port number, must be set prior to calling this method.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
addFrom(), addFromAsync(), updateFrom(), updateFromAsync(), retrieveTo()

setNewVersion

public void setNewVersion(boolean newVersion)
This method is used to specify if a new version is to be created when updating a part.
Parameters:
true - - create a new version of the part; false - do not create a new version.
See Also:

getNewVersion

public boolean getNewVersion()
This method returns the flag specifying if a new version is to be created when updating a part.
Returns:
true create a new version of the part; false - do not create a new version.
See Also:
setNewVersion(boolean)

update

public void update()
            throws DKException,
                   java.lang.Exception
Updates the meta-data and content of this resource in the persistent store from the value in memory.
Overrides:
update in class dkResource
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
update(String)

update

public void update(int option)
            throws DKException,
                   java.lang.Exception
Updates the meta-data in the datastore and object content in resource manager with the content in memory, according to the specified option.
Overrides:
update in class DKDDO
Parameters:
option - valid update option. See DKDatastoreICM.updateObject(dkDataObject, int) for valid options.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
DKDatastoreICM.updateObject(dkDataObject, int)

update

public void update(java.lang.String aFullFileName)
            throws DKException,
                   java.lang.Exception
Updates this resource in the persistent store with content directly from the specified file.
Overrides:
update in class dkResource
Parameters:
aFullFileName - a fully qualified path and file name, the default is in the current directory.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
update(), com.ibm.mm.sdk.server.DKDatastoreICM#updateObject()

update

public void update(java.lang.String aFullFileName,
                   int option)
            throws DKException,
                   java.lang.Exception
Updates this resource in the persistent store with content directly from the specified file.
Parameters:
aFullFileName - a fully qualified path and file name, the default is in the current directory.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
update(), DKDatastoreICM.updateObject(dkDataObject, int)

update

public void update(java.io.InputStream is,
                   long length)
            throws DKException,
                   java.lang.Exception
Updates the metadata in the datastore and object content in resource manager with the content from a stream file.
Parameters:
InputStream - the file stream source to read in the new content.
long - the length of bytes to be read.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
com.ibm.mm.sdk.server.DKDatastoreICM#updateObject()

update

public void update(java.io.InputStream is,
                   long length,
                   int option)
            throws DKException,
                   java.lang.Exception
Updates the metadata in the datastore and object content in resource manager with the content from a stream file. The resource will be checked-in after update depending on the option.
Parameters:
InputStream - the file stream source to read in the new content.
long - the length of bytes to be read.
option - see DKDatastoreICM.updateObject(dkDataObject, int)
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
DKDatastoreICM.updateObject(dkDataObject, int)

updateFrom

public void updateFrom()
                throws DKException,
                       java.lang.Exception
Updates the content and meta-data of the resource stored in the Resource Manager and Content Manager persistent store from a third party content source. The information describing the third party source, such as hostname, userId, password, protocol, and port number, must be set prior to calling this method. The content update takes place synchronously.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
addFrom(), retrieveTo(), updateFromAsync()

updateFrom

public void updateFrom(int option)
                throws DKException,
                       java.lang.Exception
Updates the content and meta-data of the resource stored in the Resource Manager and Content Manager persistent store from a third party content source. The information describing the third party source, such as hostname, userId, password, protocol, and port number, must be set prior to calling this method.
The content update takes place synchronously.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
addFrom(), retrieveTo(), updateFromAsync()

updateFrom

public void updateFrom(java.lang.String hostname,
                       java.lang.String userid,
                       java.lang.String passwd,
                       java.lang.String protocol,
                       int port,
                       java.lang.String filename,
                       int option)
                throws DKException,
                       java.lang.Exception
Updates the content and meta-data of the resource stored in the Resource Manager and Content Manager persistent store from a third party content source. The information describing the third party source, such as hostname, userId, password, protocol, and port number, must be set prior to calling this method.
The content is update takes place synchronously.
Parameters:
hostname - the name of the host where the content is located.
userid - the user id to use on the host for retrieving the content.
password - the password for this user id.
protocol - the name of the protocol for transferring the content e.g. ftp.
port - the port number, by which the host can be reached using the specified protocol.
filename - a fully qualified path and file name, where the content is stored. By default the file is expected to be in the current login directory.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
addFrom(), retrieveTo(), updateFromAsync()

updateFromAsync

public void updateFromAsync(java.lang.String hostname,
                            java.lang.String userid,
                            java.lang.String passwd,
                            java.lang.String protocol,
                            int port,
                            java.lang.String filename,
                            int option)
                     throws DKException,
                            java.lang.Exception
Asynchronously updates the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store from a third party content source identified by the supplied parameters. During the uploading process, the resource status is set to "Load Pending", until the process is completed.
Parameters:
hostname - the name of the host where the content is located.
userid - the user id to use on the host for retrieving the content.
password - the password for this user id.
protocol - the name of the protocol for transferring the content e.g. ftp.
port - the port number, by which the host can be reached using the specified protocol.
filename - a fully qualified path and file name, where the content is stored. By default the file is expected to be in the current login directory.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
addFrom(), retrieveTo(), updateFrom()

updateFromAsync

public void updateFromAsync()
                     throws DKException,
                            java.lang.Exception
Asynchronously updates the content and meta-data of the resource stored in the Resource Manager and Content Manager persistent store from a third party content source. The information describing the third party source, such as hostname, userId, password, protocol, port number, and file name must be set prior to calling this method.
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
addFrom(), retrieveTo(), updateFrom()

updateFromAsync

public void updateFromAsync(int option)
                     throws DKException,
                            java.lang.Exception

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes this resource from the persistent store.
Overrides:
del in class dkResource
Throws:
DKException - on error.
java.lang.Exception - on error.
See Also:
add()

del

public void del(boolean flush)
         throws DKException,
                java.lang.Exception
Deletes this resource from the persistent store and from memory according to the specified option.
Overrides:
del in class dkResource
Parameters:
flush - if true, the memory content will be flushed. The default is to flush
Throws:
DKException - on error.
java.lang.Exception - on error.

addReplicaInfo

public void addReplicaInfo(java.lang.String txID,
                           java.lang.String Token,
                           int rmcode,
                           java.lang.String collection)
                    throws DKException,
                           java.lang.Exception
Adds a replica information to this resource describing the resource manager location that stores the replica of this resource. The replica information allows a client application to choose the nearest resource manager location to retrieve or update this resource.
Parameters:
txID - TransactionID should always be there as the RM does not know about implicit transactions.
Token - every RM Operation needs a security token.
rmcode - this is the entry point in the RMInfo Cache.
Collection - the collection name on the given RM.
Throws:
DKException - on error.
java.lang.Exception - on error.

addRMInfo

public void addRMInfo(DKRMInfoICM rminfo)
               throws DKException,
                      java.lang.Exception
adds the replica info structure of this resource in order to communicate with its default the RM.
Parameters:
rmInfo - replica with Resource Manager information.
Throws:
DKException - on error.
java.lang.Exception - on error.

addReplicaInfo

public void addReplicaInfo(java.lang.String txID,
                           java.lang.String token,
                           int[] rmcodes,
                           java.lang.String[] collections)
                    throws DKException,
                           java.lang.Exception
Adds a replica information to this resource describing a set of resource managers that store the replica of this resource. The replica information allows a client application to choose the nearest resource manager location to retrieve or update this resource.
Parameters:
txID - TransactionID should always be there as the RM does not know about implicit transactions.
Token - every RM Operation needs a security token.
rmcode - this is the entry point in the RMInfo Cache.
collection - the collection names on the given RMs.
Throws:
DKException - on error.
java.lang.Exception - on error.

querySMSInfo

public void querySMSInfo()
                  throws DKException,
                         java.lang.Exception
Query the SMS related information of this object from the resource manager. The SMS information is updated in the DKStorageManageInfoICM extension of this object.
Throws:
DKException - on error.
java.lang.Exception - on error.

changeSMSInfo

public void changeSMSInfo(java.lang.String rmName,
                          java.lang.String targetCollection)
                   throws DKException,
                          java.lang.Exception
Moves the location of the content of this resource to the specified resource manager and collection name.
Parameters:
rmName - the new target resource manager name.
target - collection the new collection name in the target resource manager.
Throws:
DKException - on error.
java.lang.Exception - on error.

changeSMSInfo

public void changeSMSInfo(java.lang.String targetCollection)
                   throws DKException,
                          java.lang.Exception
Moves the content of this resource into the specified collection in the same resource manager.
Parameters:
targetCollection - the target collection name.
Throws:
DKException - on error.
java.lang.Exception - on error.

getSize

public long getSize()
Gets the size of this resource content in memory.
Returns:
the size of this content, in bytes.
See Also:
#setSize(long)

addURLInfo

public void addURLInfo(DKRMInfoICM rminfo)
                throws DKException,
                       java.lang.Exception
Adds the replica info structure of this resource in order to communicate with its default the RM.
Parameters:
rmInfo - replica with Resource Manager information. ???duplicate of addRMinfo ?
Throws:
DKException - on error.
java.lang.Exception - on error.

catalogContent

public void catalogContent(java.lang.String fileName,
                           java.lang.String rmScopeFilePath)
                    throws DKException,
                           java.lang.Exception
This will catalog into the Library Server and store the content into the Resource Manager from a file that is physically present on the Resource Manager machine. ???
Parameters:
fileName - name of the file to be cataloged.
rmScopeFilePath - absolute path of the file to be cataloged.
Throws:
DKException - on error.
java.lang.Exception - on error.

getToken

public java.lang.String getToken()
Gets the security token required to retrieve the content object directly from the resource manager.
Returns:
token string security token.

getUser

public java.lang.String getUser()
                         throws java.lang.Exception
Gets the name of the user currently using this datastore object. ???make protected ?
Returns:
user name.
Throws:
java.lang.Exception - on error.

setHttpStoreMethod

public void setHttpStoreMethod(java.lang.String method)
sets the http method.For ex: "POST" or "PUT".

getHttpStoreMethod

public java.lang.String getHttpStoreMethod()
                                    throws java.lang.Exception
gets the http method.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.