com.saperion.ngc.model

Class SettingsClassicConnectorService

java.lang.Object

com.saperion.ngc.model.ClassicConnectorService

com.saperion.ngc.model.SettingsClassicConnectorService

All Implemented Interfaces:

Service, SettingsService

public class SettingsClassicConnectorService
extends ClassicConnectorService
implements SettingsService

Author:

rbo

Constructor Summary

Constructors

Constructor and Description
SettingsClassicConnectorService()
SettingsClassicConnectorService(javax.servlet.http.HttpSession session) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteSetting(String name, String section, boolean longSetting) Deletes a setting in the backend.
DocumentId	fixRevId(DocumentId id, boolean force) Fix the revision id, if it's empty.
String	getActualUser() Reads the actual user name from connector.
List<String>	getAllAcls() Gets all ACL names.
String	getDatabaseType() Convenience method to get the type of the database currently in use.
com.saperion.intf.DDC	getDDC(String definitionName) Retrieves the specified DDC.
Map<String,String>	getFastAccessItems() Retrieves the fast access items.
List<com.saperion.intf.SaFieldDescription>	getFieldDescriptionsList(String definitionName) Retrieves the field descriptions for the specified definition.
List<String>	getLastLaunched() Reads and sort the last launched workflow names.
Map<String,String>	getProperties(String section) Reads the properties stored in the given section in the INI configuration files of Saperion.
com.saperion.ngc.iform.xml.ResultType	getResultType(String formName, int id, int rev, String ddc) Deprecated. use getSetting instead
String	getSetting(String name, String section, boolean longSetting) Retrieves a setting from the backend.
Map<String,String>	getUtf8Properties(String section) Reads the properties stored in the given section in the INI configuration files of Saperion.
boolean	hasLicence(com.saperion.rmi.SaFeature.FeatureKind kind) Checks, if the feature is supported.
boolean	isAlive() Check the backend connector.
boolean	isLookupTable(String ddcName) Checks, if the given ddc is a lookup table.
boolean	isReleaseActive() Checks if release feature active.
void	setFastAccessItems(Map<String,String> items) Stores the fast access items.
void	setLastLaunched(String lastName) Set the last lauched workflow name.
void	setProperties(Map<String,String> props, String section) Writes the given properties to the given section.
void	setResultType(String formName, int id, int rev, com.saperion.ngc.iform.xml.ResultType resultType, String ddc) Deprecated. use setSetting instead
void	setSetting(String value, String name, String section, boolean longSetting) Stores a setting in the backend.
void	setUtf8Properties(Map<String,String> props, String section, boolean cleanSection) Writes the given properties with UTF-8 encoded values to the given section.

Methods inherited from class com.saperion.ngc.model.ClassicConnectorService

convertAuthenticationException, getConnectionProvider, getSession, getWfConnectionProvider, isActive

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SettingsClassicConnectorService

public SettingsClassicConnectorService()

SettingsClassicConnectorService

public SettingsClassicConnectorService(javax.servlet.http.HttpSession session)

Constructor.

Parameters:

session - Session

Method Detail

getActualUser

public String getActualUser()

Reads the actual user name from connector.

Specified by:

getActualUser in interface SettingsService

Returns:

Actual user name

See Also:

SettingsService.getActualUser()

isAlive

public boolean isAlive()
                throws com.saperion.exception.SaSystemException

Check the backend connector.

Specified by:

isAlive in interface SettingsService

Returns:

Connector is alive

Throws:

com.saperion.exception.SaSystemException - System exception

See Also:

SettingsService.isAlive()

hasLicence

public boolean hasLicence(com.saperion.rmi.SaFeature.FeatureKind kind)
                   throws SystemException

Checks, if the feature is supported.

Specified by:

hasLicence in interface SettingsService

Parameters:

kind - Feature kind

Returns:

True, if feature exists

Throws:

SystemException

See Also:

SettingsService.hasLicence(com.saperion.rmi.SaFeature.FeatureKind)

isReleaseActive

public boolean isReleaseActive()
                        throws SystemException,
                               AuthenticationException

Checks if release feature active.

Specified by:

isReleaseActive in interface SettingsService

Returns:

true, if release feature active

Throws:

SystemException - the system exception

AuthenticationException - the authentication exception

See Also:

SettingsService.isReleaseActive()

getProperties

public Map<String,String> getProperties(String section)
                                 throws AuthenticationException,
                                        SystemException

Reads the properties stored in the given section in the INI configuration files of Saperion. Tenant-specific settings will not be resolved automatically. To read a tenant-specific setting, the section name must include the tenant-ID. Consider using SaperionIniSettings instead for automatic tenant handling.

Specified by:

getProperties in interface SettingsService

Parameters:

section - Section

Returns:

Properties

Throws:

AuthenticationException - authentication exception

SystemException - system exception

See Also:

SettingsService.getProperties(java.lang.String)

getUtf8Properties

public Map<String,String> getUtf8Properties(String section)
                                     throws AuthenticationException,
                                            SystemException

Reads the properties stored in the given section in the INI configuration files of Saperion. The content of the section must be UTF-8 encoded. enant-specific settings will not be resolved automatically. To read a tenant-specific setting, the section name must include the tenant-ID.

Specified by:

getUtf8Properties in interface SettingsService

Parameters:

section - Section

Returns:

Properties

Throws:

AuthenticationException - authentication exception

SystemException - system exception

See Also:

SettingsService.getUtf8Properties(java.lang.String)

setProperties

public void setProperties(Map<String,String> props,
                 String section)
                   throws AuthenticationException,
                          SystemException

Writes the given properties to the given section.

Specified by:

setProperties in interface SettingsService

Parameters:

props - Properties

section - Section

Throws:

AuthenticationException - authentication exception

SystemException - system exception

See Also:

SettingsService.setProperties(java.util.Map, java.lang.String)

setUtf8Properties

public void setUtf8Properties(Map<String,String> props,
                     String section,
                     boolean cleanSection)
                       throws AuthenticationException,
                              SystemException

Writes the given properties with UTF-8 encoded values to the given section.

Specified by:

setUtf8Properties in interface SettingsService

Parameters:

props - Properties

section - Section

cleanSection - Clean section

Throws:

AuthenticationException - authentication exception

SystemException - system exception

See Also:

SettingsService.setUtf8Properties(java.util.Map, java.lang.String, boolean)

getLastLaunched

public List<String> getLastLaunched()
                             throws AuthenticationException,
                                    SystemException

Reads and sort the last launched workflow names.

Specified by:

getLastLaunched in interface SettingsService

Returns:

Last launched items

Throws:

AuthenticationException - authentication exception

SystemException - system exception

See Also:

SettingsService.getLastLaunched()

setLastLaunched

public void setLastLaunched(String lastName)
                     throws AuthenticationException,
                            SystemException

Set the last lauched workflow name.

Specified by:

setLastLaunched in interface SettingsService

Parameters:

lastName - Last name

Throws:

AuthenticationException - authentication exception

SystemException - system exception

See Also:

SettingsService.setLastLaunched(java.lang.String)

getFieldDescriptionsList

public final List<com.saperion.intf.SaFieldDescription> getFieldDescriptionsList(String definitionName)
                                                                          throws SystemException,
                                                                                 AuthenticationException

Retrieves the field descriptions for the specified definition.

Specified by:

getFieldDescriptionsList in interface SettingsService

Parameters:

definitionName - definition name

Returns:

field descriptions

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

SettingsService.getFieldDescriptionsList(java.lang.String)

getDDC

public com.saperion.intf.DDC getDDC(String definitionName)
                             throws SystemException,
                                    AuthenticationException

Retrieves the specified DDC.

Specified by:

getDDC in interface SettingsService

Parameters:

definitionName - name of the DDC to retrieve

Returns:

information about the requested DDC

Throws:

SystemException - system error when retrieving DDC

AuthenticationException - authentication error when retrieving DDC

See Also:

SettingsService.getDDC(java.lang.String)

isLookupTable

public boolean isLookupTable(String ddcName)
                      throws SystemException,
                             AuthenticationException

Checks, if the given ddc is a lookup table.

Specified by:

isLookupTable in interface SettingsService

Parameters:

ddcName - DDC name

Returns:

True, if it is a lookup table

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

SettingsService.isLookupTable(java.lang.String)

fixRevId

public DocumentId fixRevId(DocumentId id,
                  boolean force)
                    throws SystemException,
                           AuthenticationException

Fix the revision id, if it's empty.

Specified by:

fixRevId in interface SettingsService

Parameters:

id - Document id

force - Force the renew

Returns:

New document id

Throws:

SystemException - System exception

AuthenticationException - authentication exception

See Also:

SettingsService.fixRevId(com.saperion.ngc.model.document.DocumentId, boolean)

getAllAcls

public final List<String> getAllAcls()
                              throws SystemException,
                                     AuthenticationException

Gets all ACL names.

Specified by:

getAllAcls in interface SettingsService

Returns:

list of ACL names

Throws:

AuthenticationException

SystemException

See Also:

SettingsService.getAllAcls()

setResultType

@Deprecated
public final void setResultType(String formName,
                            int id,
                            int rev,
                            com.saperion.ngc.iform.xml.ResultType resultType,
                            String ddc)
                         throws SystemException,
                                AuthenticationException

Deprecated. use setSetting instead

Save the resultset format to backend.

Specified by:

setResultType in interface SettingsService

Parameters:

formName - Form name

id - Frame id

rev - Revision number

resultType - Result type instance

ddc - DDC name

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

SettingsService.setResultType(java.lang.String, int, int, com.saperion.ngc.iform.xml.ResultType, java.lang.String)

getResultType

@Deprecated
public final com.saperion.ngc.iform.xml.ResultType getResultType(String formName,
                                                             int id,
                                                             int rev,
                                                             String ddc)
                                                          throws SystemException,
                                                                 AuthenticationException

Deprecated. use getSetting instead

Reads the resultset format from backend.

Specified by:

getResultType in interface SettingsService

Parameters:

formName - Form name

id - Frame id

rev - Revision number

ddc - DDC name

Returns:

Result type instance

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

SettingsService.getResultType(java.lang.String, int, int, java.lang.String)

getSetting

public String getSetting(String name,
                String section,
                boolean longSetting)
                  throws SystemException,
                         AuthenticationException

Retrieves a setting from the backend.

Specified by:

getSetting in interface SettingsService

Parameters:

name - the name of the setting

section - the section of the setting

longSetting - whether the value of the setting is allowed to be longer than 2KB or not

Returns:

the setting's value as a string. Note that long settings cannot hold unicode chararacters

Throws:

SystemException - system error when retrieving the setting

AuthenticationException - authentication error when retrieving the setting

See Also:

SettingsService.getSetting(java.lang.String, java.lang.String, boolean)

setSetting

public void setSetting(String value,
              String name,
              String section,
              boolean longSetting)
                throws SystemException,
                       AuthenticationException

Stores a setting in the backend.

Specified by:

setSetting in interface SettingsService

Parameters:

value - the setting's value. If longSetting is false, this is limited to 2KB. If longSetting is true, the string must not contain unicode characters.

name - the name of the setting

section - the section of the setting

longSetting - whether the value is allowed to be longer than 2KB or not

Throws:

SystemException - system error when storing the setting

AuthenticationException - authentication error when storing the setting

See Also:

SettingsService.setSetting(java.lang.String, java.lang.String, java.lang.String, boolean)

deleteSetting

public boolean deleteSetting(String name,
                    String section,
                    boolean longSetting)
                      throws SystemException,
                             AuthenticationException

Deletes a setting in the backend.

Specified by:

deleteSetting in interface SettingsService

Parameters:

name - the name of the setting

section - the section of the setting

longSetting - whether the setting's value is allowed to be longer than 2KB or not

Returns:

true if setting was deleted

Throws:

SystemException - system error when deleting the setting

AuthenticationException - authentication error when deleting the setting

See Also:

SettingsService.deleteSetting(java.lang.String, java.lang.String, boolean)

getFastAccessItems

public Map<String,String> getFastAccessItems()
                                      throws AuthenticationException,
                                             SystemException

Retrieves the fast access items.

Specified by:

getFastAccessItems in interface SettingsService

Returns:

fast access items

Throws:

AuthenticationException - authentication exception

SystemException - system exception

See Also:

SettingsService.getFastAccessItems()

setFastAccessItems

public void setFastAccessItems(Map<String,String> items)
                        throws AuthenticationException,
                               SystemException

Stores the fast access items.

Specified by:

setFastAccessItems in interface SettingsService

Parameters:

items - fast access items as pairs of name and path

Throws:

AuthenticationException - authentication exception

SystemException - system exception

See Also:

SettingsService.setFastAccessItems(java.util.Map)

getDatabaseType

public String getDatabaseType()
                       throws AuthenticationException,
                              SystemException

Convenience method to get the type of the database currently in use.

Specified by:

getDatabaseType in interface SettingsService

Returns:

type of the database

Throws:

AuthenticationException - authentication exception

SystemException - system exception

See Also:

SettingsService.getDatabaseType()