Purpose:
This class defines a third party server used as the location for storing or retrieving resource content during add, update, or retrieve operations. For add and update operations, the content is read from the host and stored into the resource manager. For a retrieval operation, the content is retrieved from the resource manager and stored into the host. This is a helper class for DKLobICM.
See Also: DKLobICM
Class summary:
class DKEXPORT DKThirdPartyServerDef { public: DKThirdPartyServerDef(); ~DKThirdPartyServerDef(); DKString getFileName(); DKString getFilePath(); DKString getHostName(); DKString getInputFileList(); DKString getMimeType(); DKString getPassword(); DKString getProtocol(); DKString getUserId(); DKBoolean isAsyncOperation(); void setFileName(DKString dksFileName); void setFilePath(DKString dksFilePath); void setHostName(DKString dksHostName); void setInputContentLength(longlong llContentLength); void setInputFileList(DKString dksFileList); void setMimeType(DKString dksMimeType); void setPassword(DKString dksPassword); void setPort(int iPort); void setProtocol(DKString dksProtocol); void setRetention(int iRetention); void setUserId(DKString dksUserId); void setAsyncOperation(DKBoolean dkbIsAsync); longlong getInputContentLength(); int getPort(); int getRetention(); };
Members:
Parameters: None. virtual ~DKThirdPartyServerDef(); Destructor for this object
Parameters: None
Returns: File name as a string variable.
Memory Management: None.
DKString getFileName();
Parameters: None
Returns: File path as a string variable.
Memory Management: None.
DKString getFilePath();
Parameters: None.
Returns: Host name as a string variable.
Memory Management: None.
DKString getHostName();
Parameters: None
Returns: The input file list, separated by commas.
Memory Management: None.
DKString getInputFileList();
Parameters: None
Returns: Mime type for the content as a string variable.
Memory Management: None.
DKString getMimeType();
Parameters: None.
Returns: User's password as a string variable.
Memory Management: None.
DKString getPassword();
Parameters: None.
Returns: The protocol. See the method setProtocol(String) for protocols supported.
Memory Management: None.
DKString getProtocol();
Parameters: None
Returns: The user ID used to connect to this third party server.
Memory Management: None.
DKString getUserId();
Parameters: None
Returns: True if the operation is asynchronous; false if the operation is synchronous.
Memory Management: None.
DKBoolean isAsyncOperation();
Parameters: dksFileName - the name of the file.
Returns: None.
Memory Management: None.
void setFileName(DKString dksFileName);
Parameters: dksFilePath - the file path name
Returns: None.
Memory Management: None.
void setFilePath(DKString dksFilePath);
Parameters: dksHostName - The name of this third party host providing the content service.
Returns: None.
Memory Management: None.
void setHostName(DKString dksHostName);
Parameters: double - the length of the input content, in 64 bits integer.
Returns: None.
Memory Management: None.
void setInputContentLength(longlong llContentLength);
Parameters: dksFileList - file list.
Returns: None.
Memory Management: None.
void setInputFileList(DKString dksFileList);
Parameters: dksMimeType - mime type
Returns: None.
Memory Management: None.
void setMimeType(DKString dksMimeType);
Parameters: dksPassword - password for the user.
Returns: None.
Memory Management: None.
void setPassword(DKString dksPassword);
Parameters: iPort - the port number.
Returns: None.
Memory Management: None.
void setPort(int iPort);
Parameters: dksProtocol - the protocol. Supported protocols are ftp and file.
Returns: None.
Memory Management: None.
void setProtocol(DKString dksProtocol);
Parameters: iRetention - the number of days to retain an object using third party store.
Returns: None.
Memory Management: None.
void setRetention(int iRetention);
Parameters: dksUserId - the user-id at the host providing the service
Returns: None
Memory Management: None.
void setUserId(DKString dksUserId);
Parameters: dkbIsAsync- true if the operation is asynchronous; false if the operation is synchronous(default).
Returns: None
Memory Management: None.
void setAsyncOperation(DKBoolean dkbIsAsync);
Parameters: None
Returns: The length, as a 64 bits integer
Memory Management: None.
longlong getInputContentLength();
Parameters: None
Returns: The port number
Memory Management: None.
int getPort();
Parameters: None
Returns: the retention date; 0 means retain forever.
Memory Management: None.
int getRetention();
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.