com.saperion.rmi.common

Interface SaRMISystemCommand

All Superinterfaces:

Remote

public interface SaRMISystemCommand
extends Remote

RMI remote interface for the Saperion system commands.
The system commands are provided by the RMI server.

Author:

rbo

Method Summary

Modifier and Type	Method and Description
List<String>	getAllACLs(String mandant) Reads all existing ACL names.
com.saperion.jni.SaJNIFeatures	getFeatures() Reads the features from backend.
SaFieldDescription[]	getFieldDescriptions(String ddcName, String mandant) Reads the field descriptions for a given DDC.
Map<String,String>	getHibernateEntitymap() Returns the hibernate entity map.
int	getLicenseCount(int type) Read the licence count for the given user.
List<String>	getLocks(String ddcName) Reads all locks from the given DDC.
List<String>	getLocks(String ddcName, String mandant) Reads all locks from the given DDC.
int	getMandantIdForDDC(String mandant, String ddcName) Reads the mandant ID for the given DDC.
String	getRealDBName(String ddcName, String field, String mandant) real table name for a given DDC.
SaSystemSetting	getSetting(String key, String mandant) Reads the system settings for the given key.
SaSystemInfo	getSystemInfo()
boolean	isInitialized() This method returns whether this java core server is already initialized or still in the process of start up.
String[]	loadDDCNames(String mandant) Retrieves the avaiable DDC names.
String[]	loadFolderDDCNames(String mandant) Retrieves the avaiable folder DDC names.
Properties	loadSettings(String section) Loads the settings from saperion.
void	setSetting(SaConstants.IniKind iniKind, String section, String name, String value) Sets a value with the given name, section and ini kind to backend profile.
boolean	setUsedLicense(int type, int count) Set the count of used licenses.

Method Detail

loadSettings

Properties loadSettings(String section)
                 throws RemoteException,
                        com.lexmark.saperion.exceptions.system.BackendSystemException

Loads the settings from saperion.

Parameters:

section - Section in the archief.ini

Returns:

Properties stored in programm.ini in this section

Throws:

RemoteException - Error on the saperion system

com.lexmark.saperion.exceptions.system.BackendSystemException

setSetting

void setSetting(SaConstants.IniKind iniKind,
                String section,
                String name,
                String value)
         throws RemoteException

Sets a value with the given name, section and ini kind to backend profile.

Parameters:

iniKind - IniKind

section - Section

name - Name

value - Value

Throws:

RemoteException - Error on the saperion system

getSetting

SaSystemSetting getSetting(String key,
                           String mandant)
                    throws RemoteException

Reads the system settings for the given key.

Parameters:

key - Dot-delimited key

mandant - saperion mandant

Returns:

SaSystemSetting

Throws:

RemoteException - Error on the saperion system

isInitialized

boolean isInitialized()
               throws RemoteException

This method returns whether this java core server is already initialized or still in the process of start up.

Returns:

whether this java core server is already initialized or still in the process of start up

Throws:

RemoteException

loadDDCNames

String[] loadDDCNames(String mandant)
               throws RemoteException

Retrieves the avaiable DDC names.

Parameters:

mandant - saperion mandant number

Returns:

Array of DDC names

Throws:

RemoteException - Error on the saperion system

loadFolderDDCNames

String[] loadFolderDDCNames(String mandant)
                     throws RemoteException

Retrieves the avaiable folder DDC names.

Parameters:

mandant - saperion mandant number

Returns:

Array of folder DDC names

Throws:

RemoteException - Error on the saperion system

getFieldDescriptions

SaFieldDescription[] getFieldDescriptions(String ddcName,
                                          String mandant)
                                   throws RemoteException

Reads the field descriptions for a given DDC.

Parameters:

ddcName - DDC name

mandant - internal saperion number of the current mandant

Returns:

Array of field description objects

Throws:

RemoteException - Error on the saperion system

getRealDBName

String getRealDBName(String ddcName,
                     String field,
                     String mandant)
              throws RemoteException

real table name for a given DDC.

Parameters:

ddcName - DDC name

field - ddc field

mandant - internal saperion number of the current mandant

Returns:

Array of field description objects

Throws:

RemoteException - Error on the saperion system

getHibernateEntitymap

Map<String,String> getHibernateEntitymap()
                                  throws RemoteException

Returns the hibernate entity map.

Returns:

hibernate entity map

Throws:

RemoteException - Error on the saperion system

getLocks

List<String> getLocks(String ddcName)
               throws RemoteException

Reads all locks from the given DDC.

Parameters:

ddcName - DDC name

Returns:

Locks as list

Throws:

RemoteException - Remote exception

getLocks

List<String> getLocks(String ddcName,
                      String mandant)
               throws RemoteException

Reads all locks from the given DDC.

Parameters:

ddcName - DDC name

mandant - internal saperion name of the current mandant

Returns:

Locks as list

Throws:

RemoteException - Remote exception

getAllACLs

List<String> getAllACLs(String mandant)
                 throws RemoteException

Reads all existing ACL names.

Parameters:

mandant - internal saperion name of the current mandant

Returns:

List of ACL names

Throws:

RemoteException - Remote exception

getSystemInfo

SaSystemInfo getSystemInfo()
                    throws RemoteException

Returns:

System info

Throws:

RemoteException - Remote exception

getMandantIdForDDC

int getMandantIdForDDC(String mandant,
                       String ddcName)
                throws RemoteException

Reads the mandant ID for the given DDC.

Parameters:

mandant - Mandant

ddcName - DDC

Returns:

Mandant ID

Throws:

RemoteException - Remote exception

getFeatures

com.saperion.jni.SaJNIFeatures getFeatures()
                                    throws RemoteException

Reads the features from backend.

Returns:

Features

Throws:

RemoteException - Remote exception

getLicenseCount

int getLicenseCount(int type)
             throws RemoteException

Read the licence count for the given user.

Parameters:

type - Client type

Returns:

License count

Throws:

RemoteException - Error on the saperion system

setUsedLicense

boolean setUsedLicense(int type,
                       int count)
                throws RemoteException

Set the count of used licenses.

Parameters:

type - Client type

count - Number of licenses

Returns:

True, if it was possible

Throws:

RemoteException - Error on the saperion system