|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKLSCfgDefICM
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.
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 |
public static final int TIE_ENABLED
public static final int WORKFLOW_ENABLED
public static final int IM_ENABLED
public static final int LDAP_ENABLED
public static final int ADMIN_DOMAIN_ENABLED
public static final short SMS_USER_USER
public static final short SMS_ITEMTYPE_ITEMTYPE
public static final short SMS_ITEMTYPE_USER
public static final short SMS_USER_ITEMTYPE
public static final int ITEMTYPE_ACL_BINDING
public static final int ITEM_ACL_BINDING
public static final int MIXED_ACL_BINDING
public static final int LIBRARY_ACL_BINDING
public static final int ITEM_TYPE_ACL
public static final int USER_PROFILE_ACL
public static final int LIBRARY_ACL
public static final int FALSE
public static final int TRUE
public static final int BASIC_TRACE
public static final int DETAILED_TRACE
public static final int DATA_TRACE
public static final int PERFORMANCE_TRACE
public static final int ALLOW_LOGON_W_WARNING
public static final int REJECT_LOGON
public static final int ALLOW_LOGON_W_NO_WARNING
public static final int SUPER_USER_ACL
public static final int NO_ACCESS_ACL
public static final int PUBLIC_READ_ACL
public static final int DOC_ROUTE_ACL
public static final int WINDOWS
public static final int AIX
public static final int SOLARIS
public static final int OS390
public static final int DB2
public static final int ORACLE
Constructor Detail |
public DKLSCfgDefICM()
DKLSCfgDefICM
class with owner datastore objectpublic DKLSCfgDefICM(dkDatastore ds)
DKLSCfgDefICM
class with owner datastore objectds
- reference to owner dkDatastore
objectMethod Detail |
public void setDatastore(dkDatastore ds)
ds
- reference to owner dkDatastore
objectpublic dkDatastore getDatastore()
dkDatastore
objectpublic java.lang.String datastoreType() throws java.lang.Exception
DKException
- if error occurspublic int getLibraryServerID()
public void setLibraryServerName(java.lang.String szLibraryServerName)
szLibraryServerName
- new szLibraryServerName value to be setpublic java.lang.String getLibraryServerName()
public void setLibraryServerDesc(java.lang.String szLibraryServerDesc)
szLibraryServerDesc
- new szLibraryServerDesc value to be setpublic java.lang.String getLibraryServerDesc()
public void setACLBindingLevel(short sACLBindingLevel)
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:
sACLBindingLevel
- new sACLBindingLevel value to be set
DKLSCfgDefICM.ITEMTYPE_ACL_BINDING
DKLSCfgDefICM.ITEM_ACL_BINDING
DKLSCfgDefICM.MIXED_ACL_BINDING
DKLSCfgDefICM.LIBRARY_ACL_BINDING
public short getACLBindingLevel()
Gets the level of access control for Content Manager's controlled entities.
DKLSCfgDefICM.ITEMTYPE_ACL_BINDING
DKLSCfgDefICM.ITEM_ACL_BINDING
DKLSCfgDefICM.MIXED_ACL_BINDING
DKLSCfgDefICM.LIBRARY_ACL_BINDING
public void setLibraryACLCode(int lLibraryACLCode)
Library Server ACL code stores the ACL setting for the Library Server.
Possible values are:
DKLSCfgDefICM.SUPER_USER_ACL
DKLSCfgDefICM.NO_ACCESS_ACL
DKLSCfgDefICM.PUBLIC_READ_ACL
DKLSCfgDefICM.DOC_ROUTE_ACL
lLibraryACLCode
- new lLibraryACLCode value to be set
DKLSCfgDefICM.SUPER_USER_ACL
DKLSCfgDefICM.NO_ACCESS_ACL
DKLSCfgDefICM.PUBLIC_READ_ACL
DKLSCfgDefICM.DOC_ROUTE_ACL
public int getLibraryACLCode()
Library Server ACL code stores the ACL setting for the Library Server.
DKLSCfgDefICM.SUPER_USER_ACL
DKLSCfgDefICM.NO_ACCESS_ACL
DKLSCfgDefICM.PUBLIC_READ_ACL
DKLSCfgDefICM.DOC_ROUTE_ACL
public java.lang.String getLibraryACLName()
public void setPublicAccessEnabled(short sPubAccessEnabled)
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:
DKLSCfgDefICM.TRUE
DKLSCfgDefICM.FLASE
sPubAccessEnabled
- new sPubAccessEnabled value to be set
DKLSCfgDefICM.TRUE
DKLSCfgDefICM.FLASE
public short getPublicAccessEnabled()
DKLSCfgDefICM.TRUE
DKLSCfgDefICM.FLASE
public void setDefaultACLChoice(short sDfltACLChoice)
Default ACL Choice is the default ACL choice being used.
Valid values are:
DKLSCfgDefICM.ITEM_TYPE_ACL
DKLSCfgDefICM.USER_PROFILE_ACL
DKLSCfgDefICM.LIBRARY_ACL
sDfltACLChoice
- new sDfltACLChoice value to be set
DKLSCfgDefICM.ITEM_TYPE_ACL
DKLSCfgDefICM.USER_PROFILE_ACL
DKLSCfgDefICM.LIBRARY_ACL
public short getDefaultACLChoice()
DKLSCfgDefICM.ITEM_TYPE_ACL
DKLSCfgDefICM.USER_PROFILE_ACL
DKLSCfgDefICM.LIBRARY_ACL
public void setSMSChoice(short sSMSChoice)
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:
DKLSCfgDefICM.SMS_USER_USER
- Uses the defaults associated with the user for both the collection name and the object server.DKLSCfgDefICM.SMS_ITEMTYPE_ITEMTYPE
- Uses the defaults associated with the item type for both the collection name and the object server.DKLSCfgDefICM.SMS_ITEMTYPE_USER
- Uses the defaults associated with the item type for the collection name and defaults associated with the user for the object server.DKLSCfgDefICM.SMS_USER_ITEMTYPE
- Uses the defaults associated with the user for the collection name and defaults associated with the item type for the object server.sSMSChoice
- new sSMSChoice value to be set
DKLSCfgDefICM.SMS_USER_USER
DKLSCfgDefICM.SMS_ITEMTYPE_ITEMTYPE
DKLSCfgDefICM.SMS_ITEMTYPE_USER
DKLSCfgDefICM.SMS_USER_ITEMTYPE
public short getSMSChoice()
DKLSCfgDefICM.SMS_USER_USER
DKLSCfgDefICM.SMS_ITEMTYPE_ITEMTYPE
DKLSCfgDefICM.SMS_ITEMTYPE_USER
DKLSCfgDefICM.SMS_USER_ITEMTYPE
public void setSystemTraceLevel(short sSTTraceLevel)
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:
DKLSCfgDefICM.BASIC_TRACE
- logs entry and exit from all stored procedures, plus many lower level functions.DKLSCfgDefICM.DETAILED_TRACE
- logs interesting points through the stored procedure execution.DKLSCfgDefICM.DATA_TRACE
- logs input parameters and large quantities of data through the execution.DKLSCfgDefICM.PERFORMANCE_TRACE
- logs one line per SP showing msec elapsed time.sSTTraceLevel
- new sSTTraceLevel value to be set
DKLSCfgDefICM.BASIC_TRACE
DKLSCfgDefICM.DETAILED_TRACE
DKLSCfgDefICM.DATA_TRACE
DKLSCfgDefICM.PERFORMANCE_TRACE
public short getSystemTraceLevel()
DKLSCfgDefICM.BASIC_TRACE
DKLSCfgDefICM.DETAILED_TRACE
DKLSCfgDefICM.DATA_TRACE
DKLSCfgDefICM.PERFORMANCE_TRACE
public void setMaxUsers(int lMaxUsers)
The maximum number of concurrent users. Set 0 for no limit. No checking will be done, and user counts will not be maintained.
lMaxUsers
- new lMaxUsers value to be setpublic int getMaxUsers()
public void setMaxUserAction(short sMaxUserAction)
The action to take when maximum number of concurrent users is reached.
Valid values are:
DKLSCfgDefICM.ALLOW_LOGON_W_WARNING
- allow logon with a warning messageDKLSCfgDefICM.REJECT_LOGON
- reject logonDKLSCfgDefICM.ALLOW_LOGON_W_NO_WARNING
- allow logon without a warning messagesMaxUserAction
- new sMaxUserAction value to be set
DKLSCfgDefICM.ALLOW_LOGON_W_WARNING
DKLSCfgDefICM.REJECT_LOGON
DKLSCfgDefICM.ALLOW_LOGON_W_NO_WARNING
public short getMaxUserAction()
DKLSCfgDefICM.ALLOW_LOGON_W_WARNING
DKLSCfgDefICM.REJECT_LOGON
DKLSCfgDefICM.ALLOW_LOGON_W_NO_WARNING
public int getCurrentUsers()
An estimate of the number of users currently logged on.
public void setMaxLogonRetry(short sMaxLogonRetry)
The maximum number of logon failures allowed due to an invalid password. Set 0 for no limit.
sMaxLogonRetry
- new sMaxLogonRetry value to be setpublic short getMaxLogonRetry()
public void setPasswordDuration(short sPasswordDuration)
The number of days that a password is valid. Set 0 for no limit.
sPasswordDuration
- new sPasswordDuration value to be setpublic short getPasswordDuration()
public void setSysAdminEventFlag(short sSysAdminEventFlag)
System Admin Event Flag indicates whether the logging of SystemAdmin events is enabled.
Valid values are:
DKLSCfgDefICM.TRUE
DKLSCfgDefICM.FLASE
sSysAdminEventFlag
- new sSysAdminEventFlag value to be set
DKLSCfgDefICM.TRUE
DKLSCfgDefICM.FLASE
public short getSysAdminEventFlag()
DKLSCfgDefICM.TRUE
DKLSCfgDefICM.FLASE
public void setSystemFlag(short sSystemFlag)
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:
DKLSCfgDefICM.TIE_ENABLED
DKLSCfgDefICM.LDAP_ENABLED
sSystemFlag
- new sSystemFlag value to be setpublic short getSystemFlag()
Use isTIEEnabled()
and isLDAPEnabled()
to get the states of the flags
public boolean isTIEEnabled()
public boolean isLDAPEnabled()
public void setTIEUserID(java.lang.String szTIEUserID)
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.
szTIEUserID
- new szTIEUserID value to be setpublic void setTIEUserPassword(java.lang.String szTIEUserPassword)
szTIEUserPassword
- new szTIEUserPassword value to be setpublic java.lang.String getDatabaseName()
The database name of the Library Server. It is an installation parameter.
public java.lang.String getDatabaseSchemaName()
The database schema name of the Library Server. It is an installation parameter.
public void setTraceFileName(java.lang.String szTraceFileName)
The full path name of the trace file used for server trace and log.
szTraceFileName
- new szTraceFileName value to be setpublic java.lang.String getTraceFileName()
public void setLanguageCode(java.lang.String szLanguageCode)
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".
szLanguageCode
- new szLanguageCode value to be setpublic java.lang.String getLanguageCode()
public short getDatabaseType()
The type of server database.
Possible values are:
DKLSCfgDefICM.DB2
DKLSCfgDefICM.ORACLE
DKLSCfgDefICM.DB2
DKLSCfgDefICM.ORACLE
public short getPlatform()
The platform of the Library Server.
Possible values are:
DKLSCfgDefICM.WINDOWS
DKLSCfgDefICM.AIX
DKLSCfgDefICM.SOLARIS
DKLSCfgDefICM.OS390
DKLSCfgDefICM.WINDOWS
DKLSCfgDefICM.AIX
DKLSCfgDefICM.SOLARIS
DKLSCfgDefICM.OS390
public void setTrustedLogon(short sTrustedLogon)
Sets Trusted Logon enabled or disabled.
Valid values are:
DKLSCfgDefICM.TRUE
DKLSCfgDefICM.FLASE
sTrustedLogon
- new sTrustedLogon value to be set
DKLSCfgDefICM.TRUE
DKLSCfgDefICM.FLASE
public short getTrustedLogon()
DKLSCfgDefICM.TRUE
DKLSCfgDefICM.FLASE
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |