jet.server.api.admin.cfg
Interface ConfigurationAdvanced

public interface ConfigurationAdvanced

This interface define methods to manage advanced configuration of server.

Method Summary

int	getAdminPort() Deprecated. Since V8.1 replaced by ConfigurationService.getAdminPort().
boolean	getConnectionKeepAlive() Return true if connect and keep alive otherwise return false.
boolean	getEnableJSP() Deprecated. always return true.
boolean	getEnablePublishTempToVersion() Return true if Enable the publish to version system when view a report, otherwise return false.
boolean	getEnableSecurityCheck() Return if Security Checking.
java.lang.String	getEngineDefaultLanguage() Return the engine default language
int	getEnginePriority() Return Engine Priority.
java.lang.String	getLinkedCatalog() get linked catalog on server level
int	getMaxCompletedRecordCount() return the max complete record count
int	getPermissionAlgorithmType() Get the server permission algorithm.
long	getReportResultLife() Return Report Result Life.
boolean	getScheduleShouldRun() Return true if schedule should run if time has passed during the system crashing otherwise return false.
int	getTaskDurationCheckPeriod()
int	getUserSessionTimeout() Return User Session Timeout.
int	getViewReportTimeout() Return View Report Timeout.
boolean	isEnableDispalyGroupPermissionUI() Return the group's permission setting display UI is display or hide
boolean	isEnableDispalyRolePermissionUI() Return the role's permission setting display UI is display or hide
boolean	isEnableDispalyUserPermissionUI() Return the user's permission setting display UI is display or hide
boolean	isEnableDynamicResource()
boolean	isEnableLinkedCatalog() return whether enable linked catalog on server level
boolean	isEnableMultipleLogin() return the server support same user name login multiple times or not.
boolean	isEnableRoleBasedAuthorization() Indicate whether enable role based authorization or not
boolean	isEnableTaskDuration()
boolean	isPromptActionQueueFull() return whether enable prompt message when action queue is full.
boolean	isPromptTaskQueueFull() return whether enable prompt message when task queue is full.
void	loadProperties() set the properties of server
void	setAdminPort(int adminPort) Deprecated. Since V8.1 replaced by ConfigurationService.setAdminPort(int adminPort).
void	setConnectionKeepAlive(boolean enableKeepAlive) Set if connect and keep alive
void	setEnableDisplayGroupPermissionUI(boolean enableDispaly) Set the groups' permission setting display or hide when customer set permission for other groups in web UI.
void	setEnableDisplayRolePermissionUI(boolean enableDispaly) Set the roles' permission setting display or hide when customer set permission for other roles in web UI.
void	setEnableDisplayUserPermissionUI(boolean enableDispaly) Set the users' permission setting display or hide when customer set permission for other users in web UI.
void	setEnableDynamicResource(boolean enableDynamicResource)
void	setEnableJSP(boolean enableJSP) Deprecated. has no effect.
void	setEnableLinkedCatalog(boolean enableLinkedCatalog) set enable linked catalog on server level
void	setEnableMultipleLogin(boolean enableMultipleLogin) set enable login with same user name or not
void	setEnablePublishTempToVersion(boolean enablePublishTempToVersion) Set if Enable the publish to version system when view a report,
void	setEnableRoleBasedAuthorization(boolean enableRoleBasedAuth) set the server's security mode to role based
void	setEnableSecurityCheck(boolean enableSecurityCheck) Set if Security Checking.
void	setEnableTaskDuration(boolean enableTaskDuration)
void	setEngineDefaultLanguage(java.lang.String useLanguage) Set engine default language
void	setEnginePriority(int enginePriority) Set Engine Priority.
void	setLinkedCatalog(java.lang.String linkedCatalog) set linked catalog on server level
void	setMaxCompletedRecordCount(int maxCompletedRecordCount) set the max complete record count
void	setPermissionAlgorithmType(int algorithmType) Set the server permission algorithm.
void	setPromptActionQueueFull(boolean isSet) Set if enable prompt message when action queue is full.
void	setPromptTaskQueueFull(boolean isSet) Set if enable prompt message when task queue is full.
void	setReportResultLife(long rptResultLife) Set Report Result Life.
void	setScheduleShouldRun(boolean shouldRun) Set if schedule should run if time has passed during the system crashing
void	setTaskDurationCheckPeriod(int checkPeriod)
void	setUserSessionTimeout(int userSessionTimeout) Set User Session Timeout.
void	setViewReportTimeout(int viewReportTimeout) Set View Report Timeout.

Method Detail

setUserSessionTimeout

void setUserSessionTimeout(int userSessionTimeout)

Set User Session Timeout.

Parameters:

userSessionTimeout - Session Timeout.

getUserSessionTimeout

int getUserSessionTimeout()

Return User Session Timeout.

Returns:

User Session Timeout.

setViewReportTimeout

void setViewReportTimeout(int viewReportTimeout)

Set View Report Timeout.

Parameters:

viewReportTimeout - View Report Timeout.

getViewReportTimeout

int getViewReportTimeout()

Return View Report Timeout.

Returns:

View Report Timeout.

setAdminPort

void setAdminPort(int adminPort)

Deprecated. Since V8.1 replaced by ConfigurationService.setAdminPort(int adminPort).

Set Administration Port.

Parameters:

adminPort - Administration Port.

getAdminPort

int getAdminPort()

Deprecated. Since V8.1 replaced by ConfigurationService.getAdminPort().

Return Administration Port.

Returns:

Administration Port.

setReportResultLife

void setReportResultLife(long rptResultLife)

Set Report Result Life.

Parameters:

rptResultLife - Report Result Life.

getReportResultLife

long getReportResultLife()

Return Report Result Life.

Returns:

Report Result Life.

setEnginePriority

void setEnginePriority(int enginePriority)

Set Engine Priority. It has 5 levels: 1 - Lowest Priority 2 - Low Priority 3 - Normal Priority 4 - High Priority 5 - Highest Priority

Parameters:

enginePriority - Engine Priority.

getEnginePriority

int getEnginePriority()

Return Engine Priority. It has 5 levels: 1 - Lowest Priority 2 - Low Priority 3 - Normal Priority 4 - High Priority 5 - Highest Priority

Returns:

Engine Priority.

setEnableJSP

void setEnableJSP(boolean enableJSP)

Deprecated. has no effect.

Set JSP Enable.

Parameters:

enableJSP - JSP Enable;

getEnableJSP

boolean getEnableJSP()

Deprecated. always return true.

Return JSP Enable.

Returns:

boolean JSP Enable;

setEnableSecurityCheck

void setEnableSecurityCheck(boolean enableSecurityCheck)

Set if Security Checking.

Parameters:

enableSecurityCheck - if Security Checking.

getEnableSecurityCheck

boolean getEnableSecurityCheck()

Return if Security Checking.

Returns:

boolean if Security Checking.

setEnablePublishTempToVersion

void setEnablePublishTempToVersion(boolean enablePublishTempToVersion)

Set if Enable the publish to version system when view a report,

Parameters:

enablePublishTempToVersion - if Enable the publish to version system when view a report.

getEnablePublishTempToVersion

boolean getEnablePublishTempToVersion()

Return true if Enable the publish to version system when view a report, otherwise return false.

Returns:

if Enable the publish to version system when view a report.

setConnectionKeepAlive

void setConnectionKeepAlive(boolean enableKeepAlive)

Set if connect and keep alive

Parameters:

enableKeepAlive - connect and keep alive if is "true"

getConnectionKeepAlive

boolean getConnectionKeepAlive()

Return true if connect and keep alive otherwise return false.

Returns:

if Enable connect and keep alive.

setScheduleShouldRun

void setScheduleShouldRun(boolean shouldRun)

Set if schedule should run if time has passed during the system crashing

Parameters:

shouldRun - schedule should run if time has passed during the system crashing if is "true"

getScheduleShouldRun

boolean getScheduleShouldRun()

Return true if schedule should run if time has passed during the system crashing otherwise return false.

Returns:

if schedule should run if time has passed during the system crashing. added by zhangjisheng 20030617

setEngineDefaultLanguage

void setEngineDefaultLanguage(java.lang.String useLanguage)

Set engine default language

Parameters:

useLanguage - is engine use language

getEngineDefaultLanguage

java.lang.String getEngineDefaultLanguage()

Return the engine default language

Returns:

string which is engine default language.

loadProperties

void loadProperties()

set the properties of server

setMaxCompletedRecordCount

void setMaxCompletedRecordCount(int maxCompletedRecordCount)

set the max complete record count

Parameters:

maxCompletedRecordCount - is maxium number of records

getMaxCompletedRecordCount

int getMaxCompletedRecordCount()

return the max complete record count

Returns:

int which is the max complete record count

isEnableMultipleLogin

boolean isEnableMultipleLogin()

return the server support same user name login multiple times or not.

Returns:

boolean enable multiple login with same user name

Since:

server V6

setEnableMultipleLogin

void setEnableMultipleLogin(boolean enableMultipleLogin)

set enable login with same user name or not

Parameters:

enableMultipleLogin - ture is enable, false disable

Since:

server V6

isEnableDynamicResource

boolean isEnableDynamicResource()

Returns:

boolean dynamic resource enable

Since:

v7.1

setEnableDynamicResource

void setEnableDynamicResource(boolean enableDynamicResource)

Parameters:

enableDynamicResource - dynamic resources enable

Since:

v7.1 *

setEnableDisplayUserPermissionUI

void setEnableDisplayUserPermissionUI(boolean enableDispaly)

Set the users' permission setting display or hide when customer set permission for other users in web UI.

Parameters:

enableDispaly - true or false true: display the permission setting UI false: hide the permission setting UI

setEnableDisplayRolePermissionUI

void setEnableDisplayRolePermissionUI(boolean enableDispaly)

Set the roles' permission setting display or hide when customer set permission for other roles in web UI.

Parameters:

enableDispaly - true or false true: display the permission setting UI false: hide the permission setting UI

setEnableDisplayGroupPermissionUI

void setEnableDisplayGroupPermissionUI(boolean enableDispaly)

Set the groups' permission setting display or hide when customer set permission for other groups in web UI.

Parameters:

enableDispaly - true or false true: display the permission setting UI false: hide the permission setting UI

setEnableRoleBasedAuthorization

void setEnableRoleBasedAuthorization(boolean enableRoleBasedAuth)

set the server's security mode to role based

Parameters:

enableRoleBasedAuth - true or false true: hide the "Permission Setting UI Displays" options false: display the "Permission Setting UI Displays" options

isEnableRoleBasedAuthorization

boolean isEnableRoleBasedAuthorization()

Indicate whether enable role based authorization or not

Returns:

true is enable, false is disenable

isEnableDispalyUserPermissionUI

boolean isEnableDispalyUserPermissionUI()

Return the user's permission setting display UI is display or hide

Returns:

display is true, hide is false

isEnableDispalyRolePermissionUI

boolean isEnableDispalyRolePermissionUI()

Return the role's permission setting display UI is display or hide

Returns:

display is true, hide is false

isEnableDispalyGroupPermissionUI

boolean isEnableDispalyGroupPermissionUI()

Return the group's permission setting display UI is display or hide

Returns:

display is true, hide is false

getPermissionAlgorithmType

int getPermissionAlgorithmType()

Get the server permission algorithm. There are two kinds of algorithm type: Type 0: The Permission Accumulation Algorithm Like the algorithm name, the permission algorithm will accumulate all permissions into the user permission according to the user's inherit relationship.

Type 1: The User Permission Replacement Algorithm Like the algorithm name, when the administrator set some permissions on user, the user permissions will replace the permissions calculated result that calculated by inherit relationship.

For example: There is a user named: Sam and he is the member of group: DP

The principal's permission settings: The User: Sam- Schedule The Group: DP- Visible, Read, Write

If using the permission algorithm type 0, the permission calculated result is: Visible, Read, Write, Schedule

If using the permission algorithm type 1, the permissions calculated result is: Schedule.

Returns:

the permission algorithm type.

setPermissionAlgorithmType

void setPermissionAlgorithmType(int algorithmType)

Set the server permission algorithm. There are two kinds of algorithm type: Type 0: The Permission Accumulation Algorithm Like the algorithm name, the permission algorithm will accumulate all permissions into the user permission according to the user's inherit relationship.

Type 1: The User Permission Replacement Algorithm Like the algorithm name, when the administrator set some permissions on user, the user permissions will replace the permissions calculated result that calculated by inherit relationship.

Parameters:

algorithmType - 0 represent algorithem type 0, 1 represent algorithem type 1

isEnableTaskDuration

boolean isEnableTaskDuration()

Returns:

true if enable task duration

Since:

v7.3

setEnableTaskDuration

void setEnableTaskDuration(boolean enableTaskDuration)

Parameters:

enableTaskDuration - true enable task duration, false disable it.

Since:

v7.3

getTaskDurationCheckPeriod

int getTaskDurationCheckPeriod()

Returns:

task duration check period

Since:

v7.3

setTaskDurationCheckPeriod

void setTaskDurationCheckPeriod(int checkPeriod)

Parameters:

checkPeriod - task duration check period

Since:

v7.3

isEnableLinkedCatalog

boolean isEnableLinkedCatalog()

return whether enable linked catalog on server level

Returns:

true if enable linked catalog on server level

Since:

v8.1

setEnableLinkedCatalog

void setEnableLinkedCatalog(boolean enableLinkedCatalog)

set enable linked catalog on server level

Parameters:

enableLinkedCatalog -

Since:

v8.1

getLinkedCatalog

java.lang.String getLinkedCatalog()

get linked catalog on server level

Returns:

the linked catalog on server level

setLinkedCatalog

void setLinkedCatalog(java.lang.String linkedCatalog)

set linked catalog on server level

Parameters:

linkedCatalog -

isPromptTaskQueueFull

boolean isPromptTaskQueueFull()

return whether enable prompt message when task queue is full.

Returns:

true is enable, false is disenable

setPromptTaskQueueFull

void setPromptTaskQueueFull(boolean isSet)

Set if enable prompt message when task queue is full.

Parameters:

isSet - true is enable, false is disenable

isPromptActionQueueFull

boolean isPromptActionQueueFull()

return whether enable prompt message when action queue is full.

Returns:

true is enable, false is disenable

setPromptActionQueueFull

void setPromptActionQueueFull(boolean isSet)

Set if enable prompt message when action queue is full.

Parameters:

isSet - true is enable, false is disenable