Index

DKThirdPartyServerDef

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:

Constructors and destructor
DKThirdPartyServerDef(); Default constructor for this object

Parameters: None. virtual ~DKThirdPartyServerDef(); Destructor for this object

Member functions

getFileName
Retrieves the file name to be used for this third party content operation.

Parameters: None

Returns: File name as a string variable.

Memory Management: None.

DKString  getFileName();

getFilePath
Retrieves the input file path name for this third party content operation.

Parameters: None

Returns: File path as a string variable.

Memory Management: None.

DKString  getFilePath();

getHostName
Retrieves the name of the host providing this third party content service.

Parameters: None.

Returns: Host name as a string variable.

Memory Management: None.

DKString  getHostName();

getInputFileList
Retrieves the file list to be used for this third party content add or update operation. This data is only relevant for add or update operation.

Parameters: None

Returns: The input file list, separated by commas.

Memory Management: None.

 DKString  getInputFileList();

getMimeType
Retrieves the mime type for the content.

Parameters: None

Returns: Mime type for the content as a string variable.

Memory Management: None.

DKString getMimeType();

getPassword
Gets the user's password to logon to host providing this third party content operation.

Parameters: None.

Returns: User's password as a string variable.

Memory Management: None.

DKString  getPassword();

getProtocol
Retrieves the protocol used for this third party content operation.

Parameters: None.

Returns: The protocol. See the method setProtocol(String) for protocols supported.

Memory Management: None.

DKString  getProtocol();

getUserId
Gets the user ID at the host authorized for this third party content operation.

Parameters: None

Returns: The user ID used to connect to this third party server.

Memory Management: None.

DKString  getUserId();

isAsyncOperation
Retrieves the flag specifying if the thrid party operation is asynchronous.

Parameters: None

Returns: True if the operation is asynchronous; false if the operation is synchronous.

Memory Management: None.

DKBoolean isAsyncOperation();

setFileName
Sets the file name required for this third party content operation.

Parameters: dksFileName - the name of the file.

Returns: None.

Memory Management: None.

void  setFileName(DKString dksFileName);

setFilePath
Sets the file path name of the input file for this third party content operation.

Parameters: dksFilePath - the file path name

Returns: None.

Memory Management: None.

void  setFilePath(DKString dksFilePath);

setHostName
Sets the hostname providing this third party content operations.

Parameters: dksHostName - The name of this third party host providing the content service.

Returns: None.

Memory Management: None.

void      setHostName(DKString dksHostName);

setInputContentLength
Sets the length of the resource content to be stored into the resource manager. If used in conjunction with a FileList, this represents the sum of the sizes of all the files in the list. This data is only relevant for add or update operations.

Parameters: double - the length of the input content, in 64 bits integer.

Returns: None.

Memory Management: None.

void  setInputContentLength(longlong llContentLength);

setInputFileList
Sets a file list, delimited by commas to be the input for this third party content add or update operation. The specified files can have fully qualified paths or optionally the FilePath can be used to qualify the path to these files. All files get stored into a single resource content in the resource manager under the name specified as the fileName. The name given as the fileName has to be the first member in the fileList. For example, if fileName="v1.mpg," then fileList="v1.mpg,v2.mpg...". The name of the object under which all these files will be stored, will be "v1.mpg". Specifying dksfileList is optional. Use of this method is recommended where a large file has been split into multiple parts. This data is only relevant for the add or update operation.

Parameters: dksFileList - file list.

Returns: None.

Memory Management: None.

void setInputFileList(DKString dksFileList);

setMimeType
Sets the mime type for the content

Parameters: dksMimeType - mime type

Returns: None.

Memory Management: None.

void      setMimeType(DKString dksMimeType);

setPassword
Sets the user's password required for accessing the host to perform this third party content operation.

Parameters: dksPassword - password for the user.

Returns: None.

Memory Management: None.

void      setPassword(DKString dksPassword);

setPort
Sets the port number for accessing the host which provides this third party content operation. This port is specific to the protocol specified for this third party content operation.

Parameters: iPort - the port number.

Returns: None.

Memory Management: None.

void      setPort(int iPort);

setProtocol
Sets the protocol to be used for this third party content operation. If the ftp protocol is used, the ftp server must support UNIX style commands. For file protocol the hostname, user id, password need not be provided but these must be specified for ftp protocol.

Parameters: dksProtocol - the protocol. Supported protocols are ftp and file.

Returns: None.

Memory Management: None.

void      setProtocol(DKString dksProtocol);

setRetention
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: iRetention - the number of days to retain an object using third party store.

Returns: None.

Memory Management: None.

void  setRetention(int iRetention);

setUserId
Sets the user identifier required for accessing this host to perform a third party content operation.

Parameters: dksUserId - the user-id at the host providing the service

Returns: None

Memory Management: None.

void      setUserId(DKString dksUserId);

setAsyncOperation
Sets if the third party operation is asynchronous. By default all third party operations are synchronous

Parameters: dkbIsAsync- true if the operation is asynchronous; false if the operation is synchronous(default).

Returns: None

Memory Management: None.

void     setAsyncOperation(DKBoolean dkbIsAsync);

getInputContentLength
Retrieves the length of the input resource content to be stored into the resource manager. This data is only relevant for add or update operations.

Parameters: None

Returns: The length, as a 64 bits integer

Memory Management: None.

 longlong    getInputContentLength();

getPort
Retrieves the host port number to be used for this third party content operation.

Parameters: None

Returns: The port number

Memory Management: None.

int      getPort();

getRetention
Retrieves the number of days from the creation date for which this object is to be retained.

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.