Package com.saperion.rmi.common

Interface SaRMISystemCommand

  • All Superinterfaces:
    java.rmi.Remote
    public interface SaRMISystemCommand
extends java.rmi.Remote
    RMI remote interface for the Saperion system commands.
    The system commands are provided by the RMI server.
    Author:
    rbo

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> getAllACLs​(java.lang.String mandant)
      Reads all existing ACL names.
      com.saperion.jni.SaJNIFeatures getFeatures()
      Reads the features from backend.
      SaFieldDescription[] getFieldDescriptions​(java.lang.String ddcName, java.lang.String mandant)
      Reads the field descriptions for a given DDC.
      java.util.Map<java.lang.String,​java.lang.String> getHibernateEntitymap()
      Returns the hibernate entity map.
      int getLicenseCount​(int type)
      Read the licence count for the given user.
      java.util.List<java.lang.String> getLocks​(java.lang.String ddcName)
      Reads all locks from the given DDC.
      java.util.List<java.lang.String> getLocks​(java.lang.String ddcName, java.lang.String mandant)
      Reads all locks from the given DDC.
      int getMandantIdForDDC​(java.lang.String mandant, java.lang.String ddcName)
      Reads the mandant ID for the given DDC.
      java.lang.String getRealDBName​(java.lang.String ddcName, java.lang.String field, java.lang.String mandant)
      real table name for a given DDC.
      SaSystemSetting getSetting​(java.lang.String key, java.lang.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.
      java.lang.String[] loadDDCNames​(java.lang.String mandant)
      Retrieves the avaiable DDC names.
      java.lang.String[] loadFolderDDCNames​(java.lang.String mandant)
      Retrieves the avaiable folder DDC names.
      java.util.Properties loadSettings​(java.lang.String section)
      Loads the settings from saperion.
      void setSetting​(SaConstants.IniKind iniKind, java.lang.String section, java.lang.String name, java.lang.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

        java.util.Properties loadSettings​(java.lang.String section)
                           throws java.rmi.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:
        java.rmi.RemoteException - Error on the saperion system
        com.lexmark.saperion.exceptions.system.BackendSystemException

      • setSetting

        void setSetting​(SaConstants.IniKind iniKind,
                java.lang.String section,
                java.lang.String name,
                java.lang.String value)
         throws java.rmi.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:
        java.rmi.RemoteException - Error on the saperion system

      • getSetting

        SaSystemSetting getSetting​(java.lang.String key,
                           java.lang.String mandant)
                    throws java.rmi.RemoteException
        Reads the system settings for the given key.
        Parameters:
        key - Dot-delimited key
        mandant - saperion mandant
        Returns:
        SaSystemSetting
        Throws:
        java.rmi.RemoteException - Error on the saperion system

      • isInitialized

        boolean isInitialized()
               throws java.rmi.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:
        java.rmi.RemoteException

      • loadDDCNames

        java.lang.String[] loadDDCNames​(java.lang.String mandant)
                         throws java.rmi.RemoteException
        Retrieves the avaiable DDC names.
        Parameters:
        mandant - saperion mandant number
        Returns:
        Array of DDC names
        Throws:
        java.rmi.RemoteException - Error on the saperion system

      • loadFolderDDCNames

        java.lang.String[] loadFolderDDCNames​(java.lang.String mandant)
                               throws java.rmi.RemoteException
        Retrieves the avaiable folder DDC names.
        Parameters:
        mandant - saperion mandant number
        Returns:
        Array of folder DDC names
        Throws:
        java.rmi.RemoteException - Error on the saperion system

      • getFieldDescriptions

        SaFieldDescription[] getFieldDescriptions​(java.lang.String ddcName,
                                          java.lang.String mandant)
                                   throws java.rmi.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:
        java.rmi.RemoteException - Error on the saperion system

      • getRealDBName

        java.lang.String getRealDBName​(java.lang.String ddcName,
                               java.lang.String field,
                               java.lang.String mandant)
                        throws java.rmi.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:
        java.rmi.RemoteException - Error on the saperion system

      • getHibernateEntitymap

        java.util.Map<java.lang.String,​java.lang.String> getHibernateEntitymap()
                                                                      throws java.rmi.RemoteException
        Returns the hibernate entity map.
        Returns:
        hibernate entity map
        Throws:
        java.rmi.RemoteException - Error on the saperion system

      • getLocks

        java.util.List<java.lang.String> getLocks​(java.lang.String ddcName)
                                   throws java.rmi.RemoteException
        Reads all locks from the given DDC.
        Parameters:
        ddcName - DDC name
        Returns:
        Locks as list
        Throws:
        java.rmi.RemoteException - Remote exception

      • getLocks

        java.util.List<java.lang.String> getLocks​(java.lang.String ddcName,
                                          java.lang.String mandant)
                                   throws java.rmi.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:
        java.rmi.RemoteException - Remote exception

      • getAllACLs

        java.util.List<java.lang.String> getAllACLs​(java.lang.String mandant)
                                     throws java.rmi.RemoteException
        Reads all existing ACL names.
        Parameters:
        mandant - internal saperion name of the current mandant
        Returns:
        List of ACL names
        Throws:
        java.rmi.RemoteException - Remote exception

      • getSystemInfo

        SaSystemInfo getSystemInfo()
                    throws java.rmi.RemoteException
        Returns:
        System info
        Throws:
        java.rmi.RemoteException - Remote exception

      • getMandantIdForDDC

        int getMandantIdForDDC​(java.lang.String mandant,
                       java.lang.String ddcName)
                throws java.rmi.RemoteException
        Reads the mandant ID for the given DDC.
        Parameters:
        mandant - Mandant
        ddcName - DDC
        Returns:
        Mandant ID
        Throws:
        java.rmi.RemoteException - Remote exception

      • getFeatures

        com.saperion.jni.SaJNIFeatures getFeatures()
                                    throws java.rmi.RemoteException
        Reads the features from backend.
        Returns:
        Features
        Throws:
        java.rmi.RemoteException - Remote exception

      • getLicenseCount

        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

        boolean setUsedLicense​(int type,
                       int count)
                throws java.rmi.RemoteException
        Set the count of used licenses.
        Parameters:
        type - Client type
        count - Number of licenses
        Returns:
        True, if it was possible
        Throws:
        java.rmi.RemoteException - Error on the saperion system