Package com.saperion.connector.rmi

Class SaRMISystemConnector

java.lang.Object

com.saperion.connector.rmi.SaRMISystemConnector

public class SaRMISystemConnector
extends java.lang.Object

System-level connector.

Constructor Summary

Constructors

Constructor	Description
SaRMISystemConnector(SaRMIServerInfo serverInfo)	Constructor.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getAllACLs(java.lang.String mandant)	Reads all existing ACL names.
java.lang.String	getBrokerName()
int	getBrokerPort()
SaFeature	getFeatures()
SaFieldDescription[]	getFieldDescriptions(java.lang.String ddcName, java.lang.String mandant)
java.util.Map<java.lang.String,SaFieldDescription[]>	getFieldsDescriptionList()	ddc fields descriptions.
java.util.Map<java.lang.String,java.lang.String>	getHibernateEntitymap()	The XML Hibernate configuration.
int	getLicenseCount(int type)	Read the licence count for the given user.
int	getMandantIdForDDC(java.lang.String mandant, java.lang.String ddcName)	Reads the mandant ID.
java.lang.String	getRealDBName(java.lang.String ddcName, java.lang.String field, java.lang.String mandant)
java.rmi.registry.Registry	getRegistry()
SaRMISystemCommand	getSaSystemCommand()	Returns the system application instance.
SaRMIServerInfo	getServerInfo()
java.rmi.server.RMIClientSocketFactory	getSocketFactory()
SaSystemSetting	getSystemSetting(java.lang.String key, java.lang.String mandant)	Retrieves system settings based on a given key.
java.lang.String[]	loadDDCNames(java.lang.String mandant)
java.util.Properties	loadSettings()
java.util.Properties	loadSettings(java.lang.String section)
void	setStopped()	Set the info to stopped.
boolean	setUsedLicense(int type, int count)	Set the count of used licenses.

Methods inherited from class java.lang.Object

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

Constructor Detail

SaRMISystemConnector

public SaRMISystemConnector(SaRMIServerInfo serverInfo)
                     throws SaSystemException,
                            com.lexmark.saperion.exceptions.system.BackendSystemException

Constructor.

Parameters:

serverInfo - Server Info

Throws:

SaSystemException - SaRMICommandException

com.lexmark.saperion.exceptions.system.BackendSystemException

Method Detail

getFieldsDescriptionList

public java.util.Map<java.lang.String,SaFieldDescription[]> getFieldsDescriptionList()

ddc fields descriptions.

Returns:

Map of fields descriptions

getFieldDescriptions

public SaFieldDescription[] getFieldDescriptions(java.lang.String ddcName,
                                                 java.lang.String mandant)
                                          throws java.rmi.RemoteException

Parameters:

ddcName - DDC name

mandant - saperion mandant name

Returns:

Fielddescription

Throws:

java.rmi.RemoteException - Remote exception

getRealDBName

public java.lang.String getRealDBName(java.lang.String ddcName,
                                      java.lang.String field,
                                      java.lang.String mandant)
                               throws java.rmi.RemoteException

Parameters:

ddcName - DDC name

field - field name.

mandant - saperion mandant name

Returns:

Fielddescription

Throws:

java.rmi.RemoteException - Remote exception

loadDDCNames

public java.lang.String[] loadDDCNames(java.lang.String mandant)
                                throws java.rmi.RemoteException

Parameters:

mandant - saperion mandant name

Returns:

DDC names

Throws:

java.rmi.RemoteException - Remote exception

getSystemSetting

public final SaSystemSetting getSystemSetting(java.lang.String key,
                                              java.lang.String mandant)
                                       throws java.rmi.RemoteException

Retrieves system settings based on a given key.

Parameters:

key - the key

mandant - Mandant

Returns:

SaSystemSetting

Throws:

java.rmi.RemoteException - Error on the saperion system

loadSettings

public java.util.Properties loadSettings()
                                  throws java.rmi.RemoteException,
                                         com.lexmark.saperion.exceptions.system.BackendSystemException

Returns:

Settings

Throws:

java.rmi.RemoteException - Remote exception

com.lexmark.saperion.exceptions.system.BackendSystemException

loadSettings

public java.util.Properties loadSettings(java.lang.String section)
                                  throws java.rmi.RemoteException,
                                         com.lexmark.saperion.exceptions.system.BackendSystemException

Parameters:

section - Section

Returns:

Settings

Throws:

java.rmi.RemoteException - Exception

com.lexmark.saperion.exceptions.system.BackendSystemException

getHibernateEntitymap

public java.util.Map<java.lang.String,java.lang.String> getHibernateEntitymap()
                                                                             throws java.rmi.RemoteException

The XML Hibernate configuration.

Returns:

The XML Hibernate configuration

Throws:

java.rmi.RemoteException - The RemoteException

getSaSystemCommand

public SaRMISystemCommand getSaSystemCommand()

Returns the system application instance.

Returns:

System application instance

getAllACLs

public java.util.List<java.lang.String> getAllACLs(java.lang.String mandant)
                                            throws java.rmi.RemoteException

Reads all existing ACL names.

Parameters:

mandant - saperion mandant name

Returns:

List of ACL names

Throws:

java.rmi.RemoteException - Remote exception

getMandantIdForDDC

public int getMandantIdForDDC(java.lang.String mandant,
                              java.lang.String ddcName)
                       throws java.rmi.RemoteException

Reads the mandant ID.

Parameters:

mandant - Mandant name

ddcName - DDC name

Returns:

Mandant ID

Throws:

java.rmi.RemoteException - Remote exception

getBrokerName

public java.lang.String getBrokerName()

Returns:

Broker name

getBrokerPort

public int getBrokerPort()

Returns:

Broker port

getSocketFactory

public java.rmi.server.RMIClientSocketFactory getSocketFactory()

Returns:

Socket factory

getRegistry

public java.rmi.registry.Registry getRegistry()

Returns:

Registry

setStopped

public void setStopped()

Set the info to stopped.

getServerInfo

public SaRMIServerInfo getServerInfo()

Returns:

Connected server info

getFeatures

public SaFeature getFeatures()

Returns:

Features

getLicenseCount

public int getLicenseCount(int type)
                    throws java.rmi.RemoteException

Read the licence count for the given user.

Parameters:

type - Client type

Returns:

License count

Throws:

java.rmi.RemoteException - Error on the saperion system

setUsedLicense

public boolean setUsedLicense(int type,
                              int count)
                       throws java.rmi.RemoteException

Set the count of used licenses.

Parameters:

type - Client type

count - Number of licenses

Throws:

java.rmi.RemoteException - Error on the saperion system