Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKServerDefFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractServerDef
        |
        +--com.ibm.mm.sdk.common.DKServerDefFed
All Implemented Interfaces:
DKConstant, DKConstantFed, DKMessageId, DKMessageIdFed, dkServerDef, java.io.Serializable

public class DKServerDefFed
extends dkAbstractServerDef
implements DKMessageIdFed, DKConstantFed, java.io.Serializable

DKServerDefFed : This class represents a server definition.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed
    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.common.DKConstantFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Constructor Summary
DKServerDefFed()
           
DKServerDefFed(dkDatastore ds)
          Constructs a server definition associated with datastore Fed
 
Method Summary
 java.lang.String getHostName()
          Gets the hostname of this server
 java.lang.String getNodeName()
          Gets the node name of this server
 java.lang.String getOSType()
          Gets the operating system type of this server
 int getPortNumber()
          Gets the port number of this server
 java.lang.String getRemoteDatabase()
          Gets the remote library server database name of this server
 java.lang.String getRepositoryType()
          Gets the repository type of this server
 java.lang.String getSchemaName()
          Gets the schema name of this server
 boolean isRemote()
          Checks if library server database is remote
 boolean isServerAuthentication()
          Checks if server authentication information required
 boolean isSingleSignOn()
          Checks if server supports single sign-on
 void setHostName(java.lang.String hostname)
          Sets the host name for this server
 void setNodeName(java.lang.String nodeName)
          Sets the node name for this server
 void setOSType(java.lang.String osType)
          Sets the operating system type for this server
 void setPortNumber(int portNumber)
          Sets the port number for this server
 void setRemote(boolean remote)
          Sets the library server remote database indicator to true or false
 void setRemoteDatabase(java.lang.String remoteDB)
          Sets the remote database name for this server
 void setRepositoryType(java.lang.String type)
          Sets the repository type for this server
 void setSchemaName(java.lang.String schemaName)
          Sets the schema name for this server
 void setServerAuthentication(boolean serverAuth)
          Sets the server authentication indicator to true or false
 void setSingleSignOn(boolean singleSignOn)
          Sets the single sign-on indicator to true or false
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractServerDef
datastoreType, getDatastore, getName, setDatastore, setName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKServerDefFed

public DKServerDefFed()

DKServerDefFed

public DKServerDefFed(dkDatastore ds)
Constructs a server definition associated with datastore Fed
Parameters:
ds - datastore
Method Detail

getRepositoryType

public java.lang.String getRepositoryType()
Gets the repository type of this server
Returns:
repository type. Currently, the only supported repository type is "DB2"

setRepositoryType

public void setRepositoryType(java.lang.String type)
Sets the repository type for this server
Parameters:
type - repository type. Currently, the only supported repository type is "DB2"

getSchemaName

public java.lang.String getSchemaName()
Gets the schema name of this server
Returns:
the schema name. For the federated database, the default schema name is usually "ICMADMIN"

setSchemaName

public void setSchemaName(java.lang.String schemaName)
Sets the schema name for this server
Parameters:
schemaName - the schema name.

isSingleSignOn

public boolean isSingleSignOn()
Checks if server supports single sign-on
Returns:
true if single signon is supported

setSingleSignOn

public void setSingleSignOn(boolean singleSignOn)
Sets the single sign-on indicator to true or false
Parameters:
singleSignOn - the single sign-on flag

isServerAuthentication

public boolean isServerAuthentication()
Checks if server authentication information required
Returns:
true if server authentication information is required. The database userid and password must be supplied to the server.

setServerAuthentication

public void setServerAuthentication(boolean serverAuth)
Sets the server authentication indicator to true or false
Parameters:
serverAuth - the server authentication flag

isRemote

public boolean isRemote()
Checks if library server database is remote
Returns:
true if library server database is remote

setRemote

public void setRemote(boolean remote)
Sets the library server remote database indicator to true or false
Parameters:
remote - the remote library server database flag

getHostName

public java.lang.String getHostName()
Gets the hostname of this server
Returns:
the hostname known to the TCP/IP network

setHostName

public void setHostName(java.lang.String hostname)
Sets the host name for this server
Parameters:
hostname - the TCP/IP hostname. Maximum length is 255 characters.

getPortNumber

public int getPortNumber()
Gets the port number of this server
Returns:
the port number

setPortNumber

public void setPortNumber(int portNumber)
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.

getRemoteDatabase

public java.lang.String getRemoteDatabase()
Gets the remote library server database name of this server
Returns:
the remote library server database name

setRemoteDatabase

public void setRemoteDatabase(java.lang.String remoteDB)
Sets the remote database name for this server
Parameters:
remoteDB - the remote database name

getNodeName

public java.lang.String getNodeName()
Gets the node name of this server
Returns:
the node name

setNodeName

public void setNodeName(java.lang.String nodeName)
Sets the node name for this server
Parameters:
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.

getOSType

public java.lang.String 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.

setOSType

public void setOSType(java.lang.String osType)
Sets the operating system type for this server
Parameters:
osType - operating sytem type Valid values for osType are NT,AIX,SUN,MVS

EIP Java APIs

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