|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
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.
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.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 |
public DKLobICM() throws DKUsageError, java.lang.Exception
DKUsageError
- on error.java.lang.Exception
- on error.public DKLobICM(dkDatastore ds) throws DKUsageError, java.lang.Exception
ds
- the associated datastore, a DKDatastoreICM object.DKUsageError
- on error.java.lang.Exception
- on errors.public DKLobICM(dkDatastore ds, byte[] buf) throws DKException, java.lang.Exception
ds
- the associated datastore, a DKDatastoreICM object.buf
- the byte array as the initial content of this resource.DKException
- on errors.java.lang.Exception
- on errors.public DKLobICM(DKLobICM aDKLobICM) throws DKException, java.lang.Exception
aDKLobICM
- an instance of DKLobICM to copy from.DKException
- on errors.java.lang.Exception
- on errors.Method Detail |
public void setRMName(java.lang.String rmName)
rmName
- a string identifier of the resource manager name.public java.lang.String getRMName() throws java.lang.Exception
java.lang.Exception
- on errors.public void setSMSCollName(java.lang.String smsCollName)
smsCollName
- a string identifier of the SMS collection name.public java.lang.String getSMSCollName() throws java.lang.Exception
java.lang.Exception
- on errors.public boolean isContentChanged()
isContentChanged
in class dkResource
public void setContentChanged(boolean aFlag)
aFlag
- a boolean value true to indicate that the content has been changed;
false means unchanged.public boolean isSet()
isSet
in class dkResource
public boolean isNull()
isNull
in class dkResource
public void setNull()
setNull
in class dkResource
public boolean equals(dkXDOBase adkXDOBase) throws DKException
dkResource
equals
in class dkResource
adkXDOBase
- an instance of dkXDOBaseDKException
- if objects are not the same class.public void copyData(dkXDO adkXDO) throws DKException, java.lang.Exception
copyData
in class dkResource
adkXDO
- the other XDO object to copy the content from.DKException
- on error.java.lang.Exception
- on error.public boolean compareData(dkXDO adkXDO) throws DKException, java.lang.Exception
compareData
in class dkResource
adkXDO
- the other resource object.DKException
- if object type differs.java.lang.Exception
- on error.public void setContent(byte[] aByteArray)
setContent
in class dkResource
aByteArray
- a byte array.public byte[] getContent() throws DKException, java.lang.Exception
getContent
in class dkResource
DKException
- if object type differs.java.lang.Exception
- on error.public void getContentToClientFile(java.lang.String afileName, int fileOption) throws DKException, java.lang.Exception
getContentToClientFile
in class dkResource
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:
DKException
- on error.java.lang.Exception
- on error.public boolean loadDataFromFile(java.lang.String afileName) throws DKException, java.lang.Exception
afileName
- a fully qualified path with file name. If no path is specified, the default is
in the current directory.DKException
- on error.java.lang.Exception
- on error.public void setContentFromClientFile(java.lang.String afileName) throws DKException
loadDataFromFile(java.lang.String)
method.setContentFromClientFile
in class dkResource
afileName
- a fully qualified path with file name. If no path is specified, the default is
in the current directory.DKException
- on error.public void open() throws DKException, java.lang.Exception
open
in class dkResource
DKException
- on error.java.lang.Exception
- on error.setInstanceOpenHandler(String,boolean)
public void open(java.lang.String afileName) throws DKException, java.lang.Exception
open
in class dkResource
afileName
- the provided file name.DKException
- on error.java.lang.Exception
- on error.setInstanceOpenHandler(java.lang.String, boolean)
public void setInstanceOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
setClassOpenHandler(java.lang.String, boolean)
sets the handler for the whole class,
instead of only for this instance.setInstanceOpenHandler
in class dkResource
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.open()
,
open(java.lang.String)
,
setClassOpenHandler(java.lang.String, boolean)
public void setClassOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
setInstanceOpenHandler(java.lang.String, boolean)
sets the handler for the object's
instance only, instead of for the whole class.setClassOpenHandler
in class dkResource
ahandler
- the handler program name to view the content.newSynchronousFlag
- true for synchronous process; false otherwise.open()
,
open(java.lang.String)
,
setInstanceOpenHandler(java.lang.String, boolean)
public java.lang.String getOpenHandler()
getOpenHandler
in class dkResource
setInstanceOpenHandler(java.lang.String, boolean)
public boolean isOpenSynchronous()
isOpenSynchronous
in class dkResource
setClassOpenHandler(java.lang.String, boolean)
,
setInstanceOpenHandler(java.lang.String, boolean)
public java.lang.String getItemId()
public java.lang.String getVersionNumber()
public int getAffiliatedType() throws DKException, java.lang.Exception
#getSemanticType()
Gets the affiliated type of this object.
The affiliated type could be DK_CM_ANNOTATION, DK_CM_NOTE, DK_CM_BASE, etc.
dkResource
getAffiliatedType
in class dkResource
public void setAffiliatedType(int aflType) throws DKException, java.lang.Exception
setSemanticType(int)
Sets the affiliated type of this object.
dkResource
Note:DKUsageError exception thrown if method is not implemented
setAffiliatedType
in class dkResource
aflType
- the affiliated type of this object.public void setSemanticType(int semanticType) throws DKException, java.lang.Exception
semanticType
- the semantic type of this object.DKException
- on error.java.lang.Exception
- on error.public void setMimeType(java.lang.String mType) throws DKException, java.lang.Exception
setMimeType
in class dkResource
mType
- the MIME type.DKException
- if the mime type specified is not found in the CM Library Server.java.lang.Exception
- on error.public java.lang.String getMimeType() throws DKException, java.lang.Exception
getMimeType
in class dkResource
DKException
- on error.java.lang.Exception
- on error.public java.lang.String getCreatedTimestamp() throws DKException, java.lang.Exception
DKException
- on error.java.lang.Exception
- on error.public java.lang.String getUpdatedTimestamp() throws DKException, java.lang.Exception
DKException
- on error.java.lang.Exception
- on error.public java.lang.String getReferencedTimestamp() throws DKException, java.lang.Exception
DKException
- on error.java.lang.Exception
- on error.public int size() throws DKException, java.lang.Exception
size
in class dkResource
DKException
- on error.java.lang.Exception
- on error.public int length() throws DKException, java.lang.Exception
length
in class dkResource
DKException
- on error.java.lang.Exception
- on error.public java.lang.Object getOption(int option) throws DKException, java.lang.Exception
getOption
in class dkResource
DKException
- on error.java.lang.Exception
- on error.setOption(int, java.lang.Object).
public void setOption(int option, java.lang.Object value) throws DKException, java.lang.Exception
setOption
in class dkResource
option
- an option. The valid options are:
value
- the option value. For DK_DL_OPT_DELETE_OPTION, the valid values are:
DKException
- on error.java.lang.Exception
- on error.public void setExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
addExtension(java.lang.String, com.ibm.mm.sdk.common.dkExtension)
.extensionName
- the extension name. The valid extension names are: extensionObj
- a source extension objectDKException
- on errorjava.lang.Exception
- on erroraddExtension(java.lang.String, com.ibm.mm.sdk.common.dkExtension)
public void addExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
addExtension
in class dkResource
extensionName
- the extension name.
The valid extension names are:
extensionObj
- a source extension object.DKException
- on error.java.lang.Exception
- on error.public dkExtension getExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
getExtension
in class dkResource
extensionName
- the extension name.
The valid extension names are:
DKException
- on error.java.lang.Exception
- on error.public void removeExtension(java.lang.String extensionName) throws DKException
removeExtension
in class dkResource
extensionName
- the extension name.DKException
- on error.public void changeStorage() throws DKException, java.lang.Exception
DKException
- on error.java.lang.Exception
- on error.public java.lang.String getResourceName()
setResourceName(java.lang.String)
public void setResourceName(java.lang.String name)
the
- external object name.getResourceName()
public void setDatastore(dkDatastore ds)
setDatastore
in class DKDDO
ds
- a dkDatastore, in this case a DKDatastoreICM object.public java.lang.String getOrgFileName() throws DKException, java.lang.Exception
DKException
- on error.java.lang.Exception
- on error.setOrgFileName(java.lang.String)
public void setOrgFileName(java.lang.String ofile)
ofile
- the original file name.public java.lang.String getName() throws java.lang.Exception
extName
- name of this extension object.java.lang.Exception
- on error.public void setName(java.lang.String extName) throws java.lang.Exception
extName
- name of this extension object.java.lang.Exception
- on error.public void add() throws DKException, java.lang.Exception
add
in class dkResource
DKException
- on error.java.lang.Exception
- on error.DKDatastoreICM.addObject(dkDataObject)
,
add(String)
,
add(InputStream,long)
public void add(int option) throws DKException, java.lang.Exception
add
in class DKDDO
option
- see DKDatastoreICM.addObject(dkDataObject, int)
DKException
- on error.java.lang.Exception
- on error.DKDatastoreICM.addObject(dkDataObject, int)
,
add(String)
,
add(InputStream,long)
public int getPartNumber()
setPartNumber(int)
public void setPartNumber(int partNum)
partNum
- the integer part number.public void add(java.lang.String aFullFileName) throws DKException, java.lang.Exception
add
in class dkResource
aFullFileName
- a fully qualified path and file name, default is the current directory.DKException
- on error.java.lang.Exception
- on error.add()
,
add(InputStream,long)
,
DKDatastoreICM.addObject(com.ibm.mm.sdk.common.dkDataObject)
public void add(java.lang.String aFullFileName, int option) throws DKException, java.lang.Exception
aFullFileName
- a fully qualified path and file name, default is the current directory.option
- see DKDatastoreICM.addObject(com.ibm.mm.sdk.common.dkDataObject, int)
DKException
- on error.java.lang.Exception
- on error.add()
,
add(InputStream,long)
,
DKDatastoreICM.addObject(com.ibm.mm.sdk.common.dkDataObject, int)
public void add(java.io.InputStream is, long length) throws DKException, java.lang.Exception
InputStream
- a valid input stream object.length
- the number of bytes to be stored.DKException
- if stream is null or on other communication errors.java.lang.Exception
- on error.public void add(java.io.InputStream is, long length, int option) throws DKException, java.lang.Exception
InputStream
- a valid input stream object.length
- the number of bytes to be stored.option
- see DKDatastoreICM.addObject(dkDataObject, int)
DKException
- if stream is null or on other communication errors.java.lang.Exception
- on error.add()
,
add(String)
,
DKDatastoreICM.addObject(dkDataObject, int)
public void addFrom() throws DKException, java.lang.Exception
DKException
- on error.java.lang.Exception
- on error.public void addFrom(int option) throws DKException, java.lang.Exception
option
- see DKDatastoreICM.addObject(dkDataObject, int)
DKException
- on error.java.lang.Exception
- on error.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
addFrom()
for more information.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)
.DKException
- on error.java.lang.Exception
- on error.addFrom()
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
addFrom()
for more information.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)
.DKException
- on error.java.lang.Exception
- on error.addFrom()
public void addFromAsync() throws DKException, java.lang.Exception
addFrom()
for more information.DKException
- on error.java.lang.Exception
- on error.addFrom()
,
addFromAsync()
public void setThirdPartyStore(boolean store)
store
- true or false; true indicates a setup for third party store.getThirdPartyStore()
public boolean getThirdPartyStore()
setThirdPartyStore(boolean)
public void setThirdPartyUserid(java.lang.String Userid)
Userid
- the user id for the third party host.addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
public void setThirdPartyPassword(java.lang.String Password)
Password
- the password for the user id to be used for the third party host.addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
public void setThirdPartyHostname(java.lang.String Hostname)
hostname
- the name of the third party host providing the service.addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
public void setInputFilename(java.lang.String Filename)
filename
- the name of the file for third party store.addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
public void setInputFilelist(java.lang.String Filelist)
filelist
- a list of filenames as a source for a third party store.addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
public void setThirdPartyPort(int Port)
port
- the port number to be used for third party store.addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
public void setInputFilepath(java.lang.String Filepath)
filepath
- the path for the input files for third party store.#setInputFilelist()
,
#setInputFilename()
,
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
public void setInputCreatedate(java.lang.String Cdate)
Cdate
- a timestamp in ISO Julian Format.addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
public void setInputContentlength(int Clength)
Clength
- - the size of the content to be stored using third party store.addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
public void setInputRetention(int Retention)
Retention
- the number of days to retain an object using third party store.addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
public void setInputProtocol(java.lang.String Protocol)
protocol
- the protocol to be used for party store e.g. ftp.addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
public void setUpdateDate(java.lang.String Upddate)
Upddate
- A timestamp.addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
public java.lang.String getThirdPartyHostname()
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
,
setThirdPartyHostname(java.lang.String)
public java.lang.String getThirdPartyUserid()
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
,
setThirdPartyUserid(java.lang.String)
public java.lang.String getThirdPartyPassword()
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
,
setThirdPartyPassword(java.lang.String)
public int getThirdPartyPort()
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
,
setThirdPartyPort(int)
public java.lang.String getInputFilename()
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
,
setInputFilename(java.lang.String)
public java.lang.String getInputFilelist()
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
,
setInputFilelist(java.lang.String)
public java.lang.String getInputFilepath()
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
,
setInputFilepath(java.lang.String)
public java.lang.String getInputCreatedate()
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
,
setInputCreatedate(java.lang.String)
public int getInputContentlength()
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
,
setInputContentlength(int)
public int getInputRetention()
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
,
setInputRetention(int)
public java.lang.String getInputProtocol()
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
,
setInputProtocol(java.lang.String)
public java.lang.String getUpdateDate()
addFrom()
,
updateFrom()
,
retrieveTo()
,
addFromAsync()
,
updateFromAsync()
,
setUpdateDate(java.lang.String)
public java.lang.Object retrieve(int option, long offset, long len) throws DKException, java.lang.Exception
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. DKException
- on error.java.lang.Exception
- on error.public void retrieve(int option) throws DKException, java.lang.Exception
retrieve
in class DKDDO
option
- acceptable values can be:DKException
- on error.java.lang.Exception
- on error.com.ibm.mm.sdk.server.DKDatastoreICM#retrieveObject()
,
retrieve()
public void retrieve() throws DKException, java.lang.Exception
retrieve
in class dkResource
DKException
- on error.java.lang.Exception
- on error.com.ibm.mm.sdk.server.DKDatastoreICM#retrieveObject()
public void retrieve(int option, java.lang.String fileName, int offset, int length) throws DKException, java.lang.Exception
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.DKException
- on error.java.lang.Exception
- on error.public void retrieve(java.lang.String fileName) throws DKException, java.lang.Exception
retrieve
in class dkResource
fileName
- a fully qualified path and file name, the default is in the current directory.DKException
- on error.java.lang.Exception
- on error.public java.io.InputStream getInputStream(int option, int offset, int length) throws DKException, java.lang.Exception
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. DKException
- on error.java.lang.Exception
- on error.public java.lang.String getContentURL(int option, int offset, int len) throws DKException, java.lang.Exception
option
- - valid option to retrieve the meta-data. Valid option values: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.DKException
- on error.java.lang.Exception
- on error.public java.lang.String getContentURL(int operation, int option, int offset, int len) throws DKException, java.lang.Exception
operation
- specifies the operation to perform. Valid operations can be :option
- options for the operation to be performed. Valid values are: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.DKException
- on invalid options.java.lang.Exception
- on error.public void retrieveTo() throws DKException, java.lang.Exception
DKException
- on error.java.lang.Exception
- on error.addFrom()
,
addFromAsync()
,
updateFrom()
,
updateFromAsync()
public void retrieveToAsync() throws DKException, java.lang.Exception
DKException
- on error.java.lang.Exception
- on error.addFrom()
,
addFromAsync()
,
updateFrom()
,
updateFromAsync()
,
retrieveTo()
public void setNewVersion(boolean newVersion)
true
- - create a new version of the part; false - do not create a new version.public boolean getNewVersion()
setNewVersion(boolean)
public void update() throws DKException, java.lang.Exception
update
in class dkResource
DKException
- on error.java.lang.Exception
- on error.update(String)
public void update(int option) throws DKException, java.lang.Exception
update
in class DKDDO
option
- valid update option. See DKDatastoreICM.updateObject(dkDataObject, int)
for valid options.DKException
- on error.java.lang.Exception
- on error.DKDatastoreICM.updateObject(dkDataObject, int)
public void update(java.lang.String aFullFileName) throws DKException, java.lang.Exception
update
in class dkResource
aFullFileName
- a fully qualified path and file name, the default is in the current directory.DKException
- on error.java.lang.Exception
- on error.update()
,
com.ibm.mm.sdk.server.DKDatastoreICM#updateObject()
public void update(java.lang.String aFullFileName, int option) throws DKException, java.lang.Exception
aFullFileName
- a fully qualified path and file name, the default is in the current directory.DKException
- on error.java.lang.Exception
- on error.update()
,
DKDatastoreICM.updateObject(dkDataObject, int)
public void update(java.io.InputStream is, long length) throws DKException, java.lang.Exception
InputStream
- the file stream source to read in the new content.long
- the length of bytes to be read.DKException
- on error.java.lang.Exception
- on error.com.ibm.mm.sdk.server.DKDatastoreICM#updateObject()
public void update(java.io.InputStream is, long length, int option) throws DKException, java.lang.Exception
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)
DKException
- on error.java.lang.Exception
- on error.DKDatastoreICM.updateObject(dkDataObject, int)
public void updateFrom() throws DKException, java.lang.Exception
DKException
- on error.java.lang.Exception
- on error.addFrom()
,
retrieveTo()
,
updateFromAsync()
public void updateFrom(int option) throws DKException, java.lang.Exception
DKException
- on error.java.lang.Exception
- on error.addFrom()
,
retrieveTo()
,
updateFromAsync()
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
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.DKException
- on error.java.lang.Exception
- on error.addFrom()
,
retrieveTo()
,
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
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.DKException
- on error.java.lang.Exception
- on error.addFrom()
,
retrieveTo()
,
updateFrom()
public void updateFromAsync() throws DKException, java.lang.Exception
DKException
- on error.java.lang.Exception
- on error.addFrom()
,
retrieveTo()
,
updateFrom()
public void updateFromAsync(int option) throws DKException, java.lang.Exception
public void del() throws DKException, java.lang.Exception
del
in class dkResource
DKException
- on error.java.lang.Exception
- on error.add()
public void del(boolean flush) throws DKException, java.lang.Exception
del
in class dkResource
flush
- if true, the memory content will be flushed.
The default is to flushDKException
- on error.java.lang.Exception
- on error.public void addReplicaInfo(java.lang.String txID, java.lang.String Token, int rmcode, java.lang.String collection) throws DKException, java.lang.Exception
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.DKException
- on error.java.lang.Exception
- on error.public void addRMInfo(DKRMInfoICM rminfo) throws DKException, java.lang.Exception
rmInfo
- replica with Resource Manager information.DKException
- on error.java.lang.Exception
- on error.public void addReplicaInfo(java.lang.String txID, java.lang.String token, int[] rmcodes, java.lang.String[] collections) throws DKException, java.lang.Exception
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.DKException
- on error.java.lang.Exception
- on error.public void querySMSInfo() throws DKException, java.lang.Exception
DKException
- on error.java.lang.Exception
- on error.public void changeSMSInfo(java.lang.String rmName, java.lang.String targetCollection) throws DKException, java.lang.Exception
rmName
- the new target resource manager name.target
- collection the new collection name in the target resource manager.DKException
- on error.java.lang.Exception
- on error.public void changeSMSInfo(java.lang.String targetCollection) throws DKException, java.lang.Exception
targetCollection
- the target collection name.DKException
- on error.java.lang.Exception
- on error.public long getSize()
#setSize(long)
public void addURLInfo(DKRMInfoICM rminfo) throws DKException, java.lang.Exception
rmInfo
- replica with Resource Manager information. ???duplicate of addRMinfo ?DKException
- on error.java.lang.Exception
- on error.public void catalogContent(java.lang.String fileName, java.lang.String rmScopeFilePath) throws DKException, java.lang.Exception
fileName
- name of the file to be cataloged.rmScopeFilePath
- absolute path of the file to be cataloged.DKException
- on error.java.lang.Exception
- on error.public java.lang.String getToken()
public java.lang.String getUser() throws java.lang.Exception
java.lang.Exception
- on error.public void setHttpStoreMethod(java.lang.String method)
public java.lang.String getHttpStoreMethod() throws java.lang.Exception
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |