Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKLSCfgDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKLSCfgDefICM
All Implemented Interfaces:
DKMessageId, java.io.Serializable

public class DKLSCfgDefICM
extends java.lang.Object
implements DKMessageId, java.io.Serializable

This class provides getter and setter methods for listing and updating the Library Server Configuration parameters. It maps the getter methods to the output parameters of stored procedure ICMLISTCNTRLPARM and the setter methods to the stored procedure ICMDEFINECNTRLPARM.

See Also:
Serialized Form

Field Summary
static int ADMIN_DOMAIN_ENABLED
           
static int AIX
           
static int ALLOW_LOGON_W_NO_WARNING
           
static int ALLOW_LOGON_W_WARNING
           
static int BASIC_TRACE
           
static int DATA_TRACE
           
static int DB2
           
static int DETAILED_TRACE
           
static int DOC_ROUTE_ACL
           
static int FALSE
           
static int IM_ENABLED
           
static int ITEM_ACL_BINDING
           
static int ITEM_TYPE_ACL
           
static int ITEMTYPE_ACL_BINDING
           
static int LDAP_ENABLED
           
static int LIBRARY_ACL
           
static int LIBRARY_ACL_BINDING
           
static int MIXED_ACL_BINDING
           
static int NO_ACCESS_ACL
           
static int ORACLE
           
static int OS390
           
static int PERFORMANCE_TRACE
           
static int PUBLIC_READ_ACL
           
static int REJECT_LOGON
           
static short SMS_ITEMTYPE_ITEMTYPE
           
static short SMS_ITEMTYPE_USER
           
static short SMS_USER_ITEMTYPE
           
static short SMS_USER_USER
           
static int SOLARIS
           
static int SUPER_USER_ACL
           
static int TIE_ENABLED
           
static int TRUE
           
static int USER_PROFILE_ACL
           
static int WINDOWS
           
static int WORKFLOW_ENABLED
           
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKLSCfgDefICM()
          Constructs a new DKLSCfgDefICM class with owner datastore object
DKLSCfgDefICM(dkDatastore ds)
          Constructs a new DKLSCfgDefICM class with owner datastore object
 
Method Summary
 java.lang.String datastoreType()
          Gets the type for this datastore object
 short getACLBindingLevel()
          Gets Access Control List Binding Level
 int getCurrentUsers()
          Gets Current users
 java.lang.String getDatabaseName()
          Gets Database Name
 java.lang.String getDatabaseSchemaName()
          Gets Database Schema Name
 short getDatabaseType()
          Gets Database type
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 short getDefaultACLChoice()
          Gets Default ACL Choice
 java.lang.String getLanguageCode()
          Gets Language Code
 int getLibraryACLCode()
          Gets Library Server ACL code
 java.lang.String getLibraryACLName()
          Gets Library Server ACL name
 java.lang.String getLibraryServerDesc()
          Gets Library Server Desc
 int getLibraryServerID()
          Gets Library Server ID
 java.lang.String getLibraryServerName()
          Gets Library Server Name
 short getMaxLogonRetry()
          Gets Max Logon Retry
 short getMaxUserAction()
          Gets Max user action
 int getMaxUsers()
          Gets Max Users
 short getPasswordDuration()
          Gets Password Duration
 short getPlatform()
          Gets Platform
 short getPublicAccessEnabled()
          Gets Public Access Enabled
 short getSMSChoice()
          Gets SMS Choice
 short getSysAdminEventFlag()
          Gets System Adamin Event Flag
 short getSystemFlag()
          Gets System Flag
 short getSystemTraceLevel()
          Gets System Trace Level
 java.lang.String getTraceFileName()
          Gets Trace File Name
 short getTrustedLogon()
          Gets TrustedLogon
 boolean isLDAPEnabled()
          Returns LDAP enabled state
 boolean isTIEEnabled()
          Returns TIE enabled state
 void setACLBindingLevel(short sACLBindingLevel)
          Sets Access Control List Binding Level
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setDefaultACLChoice(short sDfltACLChoice)
          Sets Default ACL Choice
 void setLanguageCode(java.lang.String szLanguageCode)
          Sets Language Code
 void setLibraryACLCode(int lLibraryACLCode)
          Sets Library Server ACL code
 void setLibraryServerDesc(java.lang.String szLibraryServerDesc)
          Sets Library Server Desc
 void setLibraryServerName(java.lang.String szLibraryServerName)
          Sets Library Server Name
 void setMaxLogonRetry(short sMaxLogonRetry)
          Sets Max Logon Retry
 void setMaxUserAction(short sMaxUserAction)
          Sets Max user action
 void setMaxUsers(int lMaxUsers)
          Sets Max Users
 void setPasswordDuration(short sPasswordDuration)
          Sets Password Duration
 void setPublicAccessEnabled(short sPubAccessEnabled)
          Sets Public Access Enabled
 void setSMSChoice(short sSMSChoice)
          Sets SMS Choice
 void setSysAdminEventFlag(short sSysAdminEventFlag)
          Sets System Adamin Event Flag
 void setSystemFlag(short sSystemFlag)
          Sets System Flag
 void setSystemTraceLevel(short sSTTraceLevel)
          Sets System Trace Level
 void setTIEUserID(java.lang.String szTIEUserID)
          Sets TIE User ID
 void setTIEUserPassword(java.lang.String szTIEUserPassword)
          Sets TIE User Password
 void setTraceFileName(java.lang.String szTraceFileName)
          Sets Trace File Name
 void setTrustedLogon(short sTrustedLogon)
          Sets TrustedLogon
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TIE_ENABLED

public static final int TIE_ENABLED

WORKFLOW_ENABLED

public static final int WORKFLOW_ENABLED

IM_ENABLED

public static final int IM_ENABLED

LDAP_ENABLED

public static final int LDAP_ENABLED

ADMIN_DOMAIN_ENABLED

public static final int ADMIN_DOMAIN_ENABLED

SMS_USER_USER

public static final short SMS_USER_USER

SMS_ITEMTYPE_ITEMTYPE

public static final short SMS_ITEMTYPE_ITEMTYPE

SMS_ITEMTYPE_USER

public static final short SMS_ITEMTYPE_USER

SMS_USER_ITEMTYPE

public static final short SMS_USER_ITEMTYPE

ITEMTYPE_ACL_BINDING

public static final int ITEMTYPE_ACL_BINDING

ITEM_ACL_BINDING

public static final int ITEM_ACL_BINDING

MIXED_ACL_BINDING

public static final int MIXED_ACL_BINDING

LIBRARY_ACL_BINDING

public static final int LIBRARY_ACL_BINDING

ITEM_TYPE_ACL

public static final int ITEM_TYPE_ACL

USER_PROFILE_ACL

public static final int USER_PROFILE_ACL

LIBRARY_ACL

public static final int LIBRARY_ACL

FALSE

public static final int FALSE

TRUE

public static final int TRUE

BASIC_TRACE

public static final int BASIC_TRACE

DETAILED_TRACE

public static final int DETAILED_TRACE

DATA_TRACE

public static final int DATA_TRACE

PERFORMANCE_TRACE

public static final int PERFORMANCE_TRACE

ALLOW_LOGON_W_WARNING

public static final int ALLOW_LOGON_W_WARNING

REJECT_LOGON

public static final int REJECT_LOGON

ALLOW_LOGON_W_NO_WARNING

public static final int ALLOW_LOGON_W_NO_WARNING

SUPER_USER_ACL

public static final int SUPER_USER_ACL

NO_ACCESS_ACL

public static final int NO_ACCESS_ACL

PUBLIC_READ_ACL

public static final int PUBLIC_READ_ACL

DOC_ROUTE_ACL

public static final int DOC_ROUTE_ACL

WINDOWS

public static final int WINDOWS

AIX

public static final int AIX

SOLARIS

public static final int SOLARIS

OS390

public static final int OS390

DB2

public static final int DB2

ORACLE

public static final int ORACLE
Constructor Detail

DKLSCfgDefICM

public DKLSCfgDefICM()
Constructs a new DKLSCfgDefICM class with owner datastore object

DKLSCfgDefICM

public DKLSCfgDefICM(dkDatastore ds)
Constructs a new DKLSCfgDefICM class with owner datastore object
Parameters:
ds - reference to owner dkDatastore object
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Parameters:
ds - reference to owner dkDatastore object

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Returns:
the dkDatastore object

datastoreType

public java.lang.String datastoreType()
                               throws java.lang.Exception
Gets the type for this datastore object
Returns:
datastore type
Throws:
DKException - if error occurs

getLibraryServerID

public int getLibraryServerID()
Gets Library Server ID
Returns:
Library Server ID

setLibraryServerName

public void setLibraryServerName(java.lang.String szLibraryServerName)
Sets Library Server Name
Parameters:
szLibraryServerName - new szLibraryServerName value to be set

getLibraryServerName

public java.lang.String getLibraryServerName()
Gets Library Server Name
Returns:
Library Server Name

setLibraryServerDesc

public void setLibraryServerDesc(java.lang.String szLibraryServerDesc)
Sets Library Server Desc
Parameters:
szLibraryServerDesc - new szLibraryServerDesc value to be set

getLibraryServerDesc

public java.lang.String getLibraryServerDesc()
Gets Library Server Desc
Returns:
Library Server Desc

setACLBindingLevel

public void setACLBindingLevel(short sACLBindingLevel)
Sets Access Control List Binding Level

Sets the level of access control for Content Manager's controlled entities.

Access to CM user data can be controlled at levels of Item, Item type, or the entire Library.

Possible levels are:

Parameters:
sACLBindingLevel - new sACLBindingLevel value to be set
  • DKLSCfgDefICM.ITEMTYPE_ACL_BINDING
  • DKLSCfgDefICM.ITEM_ACL_BINDING
  • DKLSCfgDefICM.MIXED_ACL_BINDING
  • DKLSCfgDefICM.LIBRARY_ACL_BINDING

getACLBindingLevel

public short getACLBindingLevel()
Gets Access Control List Binding Level

Gets the level of access control for Content Manager's controlled entities.

Returns:
  • DKLSCfgDefICM.ITEMTYPE_ACL_BINDING
  • DKLSCfgDefICM.ITEM_ACL_BINDING
  • DKLSCfgDefICM.MIXED_ACL_BINDING
  • DKLSCfgDefICM.LIBRARY_ACL_BINDING

setLibraryACLCode

public void setLibraryACLCode(int lLibraryACLCode)
Sets Library Server ACL code

Library Server ACL code stores the ACL setting for the Library Server.

Possible values are:

Parameters:
lLibraryACLCode - new lLibraryACLCode value to be set
  • DKLSCfgDefICM.SUPER_USER_ACL
  • DKLSCfgDefICM.NO_ACCESS_ACL
  • DKLSCfgDefICM.PUBLIC_READ_ACL
  • DKLSCfgDefICM.DOC_ROUTE_ACL

getLibraryACLCode

public int getLibraryACLCode()
Gets Library Server ACL code

Library Server ACL code stores the ACL setting for the Library Server.

Returns:
  • DKLSCfgDefICM.SUPER_USER_ACL
  • DKLSCfgDefICM.NO_ACCESS_ACL
  • DKLSCfgDefICM.PUBLIC_READ_ACL
  • DKLSCfgDefICM.DOC_ROUTE_ACL

getLibraryACLName

public java.lang.String getLibraryACLName()
Gets Library Server ACL name
Returns:
Library Server ACL name

setPublicAccessEnabled

public void setPublicAccessEnabled(short sPubAccessEnabled)
Sets Public Access Enabled

The capability of opening a bound entity public to all users can be configured using this flag system-wide. When disabled, all the ACL rules that being specified public are ignored during the access control process. By being specified public, the ACL rules authorizes all users to perform operations specified in the ACL privileges on the bound entity, provided that users have passed their User Privlleges check.

Valid values are:

Parameters:
sPubAccessEnabled - new sPubAccessEnabled value to be set
  • DKLSCfgDefICM.TRUE
  • DKLSCfgDefICM.FLASE

getPublicAccessEnabled

public short getPublicAccessEnabled()
Gets Public Access Enabled
Returns:
  • DKLSCfgDefICM.TRUE
  • DKLSCfgDefICM.FLASE

setDefaultACLChoice

public void setDefaultACLChoice(short sDfltACLChoice)
Sets Default ACL Choice

Default ACL Choice is the default ACL choice being used.

Valid values are:

Parameters:
sDfltACLChoice - new sDfltACLChoice value to be set
  • DKLSCfgDefICM.ITEM_TYPE_ACL
  • DKLSCfgDefICM.USER_PROFILE_ACL
  • DKLSCfgDefICM.LIBRARY_ACL

getDefaultACLChoice

public short getDefaultACLChoice()
Gets Default ACL Choice
Returns:
  • DKLSCfgDefICM.ITEM_TYPE_ACL
  • DKLSCfgDefICM.USER_PROFILE_ACL
  • DKLSCfgDefICM.LIBRARY_ACL

setSMSChoice

public void setSMSChoice(short sSMSChoice)
Sets SMS Choice

When a value is not provided for both the object server and the collection name, SMS choice indicates which default values to use for these parameters when creating an item part.

Valid values are:

Parameters:
sSMSChoice - new sSMSChoice value to be set
  • DKLSCfgDefICM.SMS_USER_USER
  • DKLSCfgDefICM.SMS_ITEMTYPE_ITEMTYPE
  • DKLSCfgDefICM.SMS_ITEMTYPE_USER
  • DKLSCfgDefICM.SMS_USER_ITEMTYPE

getSMSChoice

public short getSMSChoice()
Gets SMS Choice
Returns:
  • DKLSCfgDefICM.SMS_USER_USER
  • DKLSCfgDefICM.SMS_ITEMTYPE_ITEMTYPE
  • DKLSCfgDefICM.SMS_ITEMTYPE_USER
  • DKLSCfgDefICM.SMS_USER_ITEMTYPE

setSystemTraceLevel

public void setSystemTraceLevel(short sSTTraceLevel)
Sets System Trace Level

The trace levels can be set to log different level of traces in Library Server log file. The user can set multiple trace levels.

The value of System Trace Level should be interpreted in a BIT WISE mode.

Valid values are:

Parameters:
sSTTraceLevel - new sSTTraceLevel value to be set
  • DKLSCfgDefICM.BASIC_TRACE
  • DKLSCfgDefICM.DETAILED_TRACE
  • DKLSCfgDefICM.DATA_TRACE
  • DKLSCfgDefICM.PERFORMANCE_TRACE

getSystemTraceLevel

public short getSystemTraceLevel()
Gets System Trace Level
Returns:
  • DKLSCfgDefICM.BASIC_TRACE
  • DKLSCfgDefICM.DETAILED_TRACE
  • DKLSCfgDefICM.DATA_TRACE
  • DKLSCfgDefICM.PERFORMANCE_TRACE

setMaxUsers

public void setMaxUsers(int lMaxUsers)
Sets Max Users

The maximum number of concurrent users. Set 0 for no limit. No checking will be done, and user counts will not be maintained.

Parameters:
lMaxUsers - new lMaxUsers value to be set

getMaxUsers

public int getMaxUsers()
Gets Max Users
Returns:
Max Users

setMaxUserAction

public void setMaxUserAction(short sMaxUserAction)
Sets Max user action

The action to take when maximum number of concurrent users is reached.

Valid values are:

Parameters:
sMaxUserAction - new sMaxUserAction value to be set
  • DKLSCfgDefICM.ALLOW_LOGON_W_WARNING
  • DKLSCfgDefICM.REJECT_LOGON
  • DKLSCfgDefICM.ALLOW_LOGON_W_NO_WARNING

getMaxUserAction

public short getMaxUserAction()
Gets Max user action
Returns:
  • DKLSCfgDefICM.ALLOW_LOGON_W_WARNING
  • DKLSCfgDefICM.REJECT_LOGON
  • DKLSCfgDefICM.ALLOW_LOGON_W_NO_WARNING

getCurrentUsers

public int getCurrentUsers()
Gets Current users

An estimate of the number of users currently logged on.

Returns:
Current Users

setMaxLogonRetry

public void setMaxLogonRetry(short sMaxLogonRetry)
Sets Max Logon Retry

The maximum number of logon failures allowed due to an invalid password. Set 0 for no limit.

Parameters:
sMaxLogonRetry - new sMaxLogonRetry value to be set

getMaxLogonRetry

public short getMaxLogonRetry()
Gets Max Logon Retry
Returns:
Max Logon Retry

setPasswordDuration

public void setPasswordDuration(short sPasswordDuration)
Sets Password Duration

The number of days that a password is valid. Set 0 for no limit.

Parameters:
sPasswordDuration - new sPasswordDuration value to be set

getPasswordDuration

public short getPasswordDuration()
Gets Password Duration
Returns:
Password Duration

setSysAdminEventFlag

public void setSysAdminEventFlag(short sSysAdminEventFlag)
Sets System Adamin Event Flag

System Admin Event Flag indicates whether the logging of SystemAdmin events is enabled.

Valid values are:

Parameters:
sSysAdminEventFlag - new sSysAdminEventFlag value to be set
  • DKLSCfgDefICM.TRUE
  • DKLSCfgDefICM.FLASE

getSysAdminEventFlag

public short getSysAdminEventFlag()
Gets System Adamin Event Flag
Returns:
  • DKLSCfgDefICM.TRUE
  • DKLSCfgDefICM.FLASE

setSystemFlag

public void setSystemFlag(short sSystemFlag)
Sets System Flag

The value of System Flag should be interpreted in a BIT WISE mode. Use bit operators to set flags ON or OFF.

Supproted bit values are:

Parameters:
sSystemFlag - new sSystemFlag value to be set

getSystemFlag

public short getSystemFlag()
Gets System Flag

Use isTIEEnabled() and isLDAPEnabled() to get the states of the flags

Returns:
System Flag

isTIEEnabled

public boolean isTIEEnabled()
Returns TIE enabled state
Returns:
true if TIE is enabled, flase otherwise

isLDAPEnabled

public boolean isLDAPEnabled()
Returns LDAP enabled state
Returns:
true if LDAP is enabled, flase otherwise

setTIEUserID

public void setTIEUserID(java.lang.String szTIEUserID)
Sets TIE User ID

The User ID has to be defined in the ICMSTUSERS table and has to be a DBMS User ID. The CM uses this value for connecting to database before creating TIE index.

Parameters:
szTIEUserID - new szTIEUserID value to be set

setTIEUserPassword

public void setTIEUserPassword(java.lang.String szTIEUserPassword)
Sets TIE User Password
Parameters:
szTIEUserPassword - new szTIEUserPassword value to be set

getDatabaseName

public java.lang.String getDatabaseName()
Gets Database Name

The database name of the Library Server. It is an installation parameter.

Returns:
Database Name

getDatabaseSchemaName

public java.lang.String getDatabaseSchemaName()
Gets Database Schema Name

The database schema name of the Library Server. It is an installation parameter.

Returns:
Database Schema Name

setTraceFileName

public void setTraceFileName(java.lang.String szTraceFileName)
Sets Trace File Name

The full path name of the trace file used for server trace and log.

Parameters:
szTraceFileName - new szTraceFileName value to be set

getTraceFileName

public java.lang.String getTraceFileName()
Gets Trace File Name
Returns:
Trace File name

setLanguageCode

public void setLanguageCode(java.lang.String szLanguageCode)
Sets Language Code

The default 3-character language code.

Valid values are: "AFR", "ARA", "BEL", "BGR", "CAT", "CHT", "CHS", "CSY", "CZE", "DAN", "DEU", "DES", "ELL", "ENA", "ENG", "ENU", "ENP", "ESP", "FIN", "FRA", "FRB", "FRC", "FRS", "GAE", "HEB", "HRV", "HUN", "ISL", "ITA", "ITS", "JPN", "KOR", "MKD", "NLD", "NLB", "NON", "NOR", "PLK", "PTB", "PTG", "RMS", "ROM", "RUS", "SKY", "SLO", "SQI", "SRB", "SRL", "SVE", "THA", "TRK", "UKR", and "URD".

Parameters:
szLanguageCode - new szLanguageCode value to be set

getLanguageCode

public java.lang.String getLanguageCode()
Gets Language Code
Returns:
Language Code

getDatabaseType

public short getDatabaseType()
Gets Database type

The type of server database.

Possible values are:

Returns:
  • DKLSCfgDefICM.DB2
  • DKLSCfgDefICM.ORACLE

getPlatform

public short getPlatform()
Gets Platform

The platform of the Library Server.

Possible values are:

Returns:
  • DKLSCfgDefICM.WINDOWS
  • DKLSCfgDefICM.AIX
  • DKLSCfgDefICM.SOLARIS
  • DKLSCfgDefICM.OS390

setTrustedLogon

public void setTrustedLogon(short sTrustedLogon)
Sets TrustedLogon

Sets Trusted Logon enabled or disabled.

Valid values are:

Parameters:
sTrustedLogon - new sTrustedLogon value to be set
  • DKLSCfgDefICM.TRUE
  • DKLSCfgDefICM.FLASE

getTrustedLogon

public short getTrustedLogon()
Gets TrustedLogon
Returns:
  • DKLSCfgDefICM.TRUE
  • DKLSCfgDefICM.FLASE

EIP Java APIs

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