Index

DKServerDefFed

Purpose:

This class represents a server definition.

Class summary:

class DKEXPORT DKServerDefFed : public dkServerDef
{
  public:
   DKServerDefFed(dkDatastore *ds);
   DKServerDefFed(const DKServerDefFed& def);
   virtual ~DKServerDefFed();
   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 singleSignOn);
 
   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);
 
   //  Valid values for osType (NT,AIX,SUN,MVS)
   virtual DKString getOSType();
   virtual void setOSType(const char* osType);
};

Members:

Constructors and destructor
DKServerDefFed(dkDatastore *ds)

Constructs a server definition associated with the datastore Fed

Parameters: ds - instance of Fed datastore

DKServerDefFed(const DKServerDefFed& def)

Constructs a server definition associated with the datastore Fed

Parameters: def - instance of server definition object associated with the datastore Fed

virtual ~DKServerDefFed()

Destructor. Destroys the in-memory representation of the server definition object.

Member functions

getRepositoryType
Gets the repository type for this server.

Returns: The repository type. 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
Gets the schema name of this server.

Returns: The schema name. For Fed, the default schema name is usually "ICMADMIN"

virtual DKString getSchemaName();

setSchemaName
Sets the schema name for this server.

Parameters: schemaName - the schema name

virtual void setschemaName(const char* schemaName);

isSingleSignOn
Checks if server support single sign-on.

Returns: TRUE if single sign-on is supported

virtual DKBoolean isSingleSignOn();

setSingleSignOn
Sets the single sign-on indicator to TRUE or FALSE.

Parameters: singleSignOn - the single sign-on flag

virtual void setSingleSignOn(DKBoolean singleSignOn);

isServerAuthentication
Check for server authentication information required.

Returns: TRUE if server authentication information is required. The database userid and password must be supplied to the server.

virtual DKBoolean isServerAuthentication();

setServerAuthentication
Sets the server authentication indicator to TRUE or FALSE.

Parameters: serverAuth - the server authentication flag

virtual void setServerAuthentication(DKBoolean serverAuth);

isRemote
Check if library server database is remote.

Returns: TRUE if library server database is remote

virtual DKBoolean isRemote();

setRemote
Sets the library server remote database indicator to TRUE or FALSE.

Parameters: remote - the remote library server database flag

virtual void setRemote(DKBoolean remote);

getHostName
Gets the hostname of this server.

Returns: the hostname known to the TCP/IP network

virtual DKString getHostName();

setHostName
Sets the hostname for this server.

Parameters: hostname - the TCP/IP hostname. Maximum length is 255 characters

virtual void setHostName(const char* hostname);

getPortNumber
Gets the port number of this server.

Returns: the port number

virtual long    getPortNumber();

setPortNumber
Sets the port number for this server.

Parameters: portNumber - the port number. It must match the port number associated with the service name of this server.

virtual void setPortNumber(long portNumber);

getRemoteDatabase
Gets the remote library server database name of this server.

Returns: The remote library server database name

virtual DKString getRemoteDatabase();

setRemoteDatabase
Sets the remote database name for this server.

Parameters: remoteDB - the remote database name.

virtual void setRemoteDatabase(const char* remoteDB);

getNodeName
Gets the node name of this server.

Returns: The node name

virtual DKString getNodeName();

setNodeName
Sets the node name for this server.

Returns: nodeName - the node name. It is a user selected name used as a local alias to identify server's TCP/IP node. It must be a valid name for identifier, that is, it is an alphanumeric string which starts with alphabet.

virtual void setNodeName(const char* nodeName);

getOSType
Gets the operating system type of this server.

Returns: The operating system type. See setOSType method for the valid values of the OS type.

virtual DKString getOSType();

setOSType
Sets the operating system type for this server.

Parameters: osType - operating sytem type. Valid values for osType are NT,AIX,SUN,MVS

virtual void setOSType(const char* osType);

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