Index

DKServerDefICM

Purpose:

This class is used to represent a server definition. It inherits from dkServerDef and is specialized to include additional information specific to the Content Manager server, like the information required to catalog a remote Content Manager server.

Since: Version 8

Class summary:

class DKEXPORT DKServerDefICM : public dkServerDef
 {
   public:
     DKServerDefICM(dkDatastore *ds);
     DKServerDefICM(const DKServerDefICM& def);
     virtual ~DKServerDefICM();
     virtual DKString getRepositoryType();
     virtual void setRepositoryType(const char* type);
     virtual DKString getSchemaName();
     virtual void setSchemaName(const char* schemaName);
    
     virtual DKBoolean isSingleSignOn();
     virtual void setSingleSignOn(DKBoolean setSingleSignOn);
    
     virtual DKBoolean isServerAuthentication();
     virtual void setServerAuthentication(DKBoolean serverAuth);
 
     virtual DKBoolean isRemote();
     virtual void setRemote(DKBoolean remote);
 
     virtual DKString getHostName();
     virtual void setHostName(const char* hostname);
 
     virtual long getPortNumber();
     virtual void setPortNumber(long portNumber);
 
     virtual DKString getRemoteDatabase();
     virtual void setRemoteDatabase(const char* remoteDB);
 
     virtual DKString getNodeName();
     virtual void setNodeName(const char* nodeName);
 
     virtual DKString getOSType();
     virtual void setOSType(const char* osType);
   };

Members:

Constructors and destructor
Constructs a server definition for Content Manager.
DKServerDefICM(dkDatastore *ds);
Constructs a server definition associated with the specified datastore.
Parameters: 
     ds - instance of ICM datastore 
virtual ~DKServerDefICM();
Destructor for this object.

Member functions

getRepositoryType()
Retrieves the repository type for this server. Returns: the repository type as an instance of DKString. Currently , the only supported repository type is "DB2".
virtual DKString getRepositoryType();

setRepositoryType()
Sets the repository type for this server. Parameters: type - the repository type. Currently, the only supported repository type is "DB2".
virtual void setRepositoryType(const char* type);

getSchemaName
Retrieves the schema name for this server. Parameters: type - the repository type. Currently, the only supported repository type is "DB2". Returns: schemaName - the schema name for this server. For CM, the default schema name is "ICMADMIN".
virtual DKString getSchemaName();

setSchemaName
Sets the schema name for this server. Parameters: schemaName - the schema name to be set.
virtual void setSchemaName(const char* schemaName);

isSingleSignOn
Checks if this server supports single signon. Returns: TRUE, if single sign-on is supported; FALSE otherwise
virtual DKBoolean isSingleSignOn();

setSingleSignOn
Sets the single sign-on indicator on the server definition object. Parameters: singleSignOn - the single sign-on flag
virtual void setSingleSignOn(DKBoolean singleSignOn);

isServerAuthentication
Checks if server-based authentication is supported on this server. Returns: TRUE, if server-based authentication is supported; FALSE otherwise.
virtual DKBoolean isServerAuthentication();

setServerAuthentication
sets the server authentication indicator on this server. Parameters: serverAuth - the server authentication flag
virtual void setServerAuthentication(DKBoolean serverAuth);

isRemote
Checks whether the library server database is remote or not. Returns: TRUE if the library server database is remote; FALSE otherwise.
virtual DKBoolean isRemote();

setRemote
Sets the library server remote database indicator to TRUE or FALSE. Parameters: remote - the remote lirbary server database flag.
virtual void setRemote(DKBoolean remote);

getHostName
Retrieves the host name for this server. Returns: the hostname known to the TCP/IP network as a DKString instance.
virtual DKString getHostName();

setHostName
Sets the host name for this server. Parameters: hostname - the TCP/IP based hostname. Maximum length is 255 characters.
virtual void setHostName(const char* hostname);

getPortNumber
Retrieves the port number for this server. Returns: the port number.
virtual long getPortNumber();

setPortNumber
Sets the port number for this server. Parameters: portNumber - the port number for this server. The value must match the port number associated with the service name of the server.
virtual void setPortNumber(long portNumber);

getNodeName
Retrieves the node name of this server. Returns: the node name as an instance of DKString.
virtual DKString getNodeName();

setNodeName
Sets the node name for this server. Parameters: nodeName - the node name. The value is a user-selected name used as a local alias to identify the server's TCP/IP node. It must be a valid name for use as an identifier (i.e. an alphanumeric string starting with a letter).
virtual void setNodeName(const char* nodeName);

getOSType
Retrieves the operating system type for the operating system this server is running on. Returns: the operating system type. See the setOSType method for valid values of the OS type that are supported.
virtual DKString getOSType();

setOSType
Sets the operating system type for the operating system this server is running on. Parameters: osType - the operating system type. Valid values are "WIN95", "NT", "AIX", "SUN", and "MVS".
virtual void setOSType(const char* osType);

getRemoteDatabase
Retrieves the name of the remote library server database for this server. Returns: name of the remote database as an instance of DKString.
virtual DKString getRemoteDatabase();

setRemoteDatabase
Sets the remote library server database name for this server. Parameters: remoteDB - name of the remote library server database.
virtual void setRemoteDatabase(const char* remoteDB);

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