psdi.app.system

Class SystemService

    • Constructor Detail

      • SystemService

        public SystemService()
                      throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • SystemService

        public SystemService(MXServer mxServer)
                      throws java.rmi.RemoteException
        Parameters:
        mxServer - The "Server Environment" this Service is being created in.
        Throws:
        java.rmi.RemoteException
    • Method Detail

      • getLookupKeyMap

        public java.lang.Object[] getLookupKeyMap(java.lang.String target,
                                                  java.lang.String source,
                                                  java.lang.String attr,
                                                  UserInfo ui)
                                           throws MXException,
                                                  java.rmi.RemoteException
        Get the lookup key map. If the map is not defined in maxlookupmap, null will be returned.
        Specified by:
        getLookupKeyMap in interface SystemServiceRemote
        Parameters:
        target - targetMbo
        source -
        attr -
        ui - UserInfo
        Returns:
        Lookup key map
        Throws:
        MXException
        java.rmi.RemoteException
      • getLookupKeyMap

        public java.lang.Object[] getLookupKeyMap(java.lang.String target,
                                                  java.lang.String attr,
                                                  UserInfo ui)
                                           throws MXException,
                                                  java.rmi.RemoteException
        Get the lookup key map. If the map is not defined in maxlookupmap, null will be returned.
        Specified by:
        getLookupKeyMap in interface SystemServiceRemote
        Parameters:
        target - targetMbo
        attr -
        ui - UserInfo
        Returns:
        Lookup key map
        Throws:
        MXException
        java.rmi.RemoteException
      • init

        public void init()
        Overwrite the init() to include initializing the maxlookupMap cache and the condition cache
        Specified by:
        init in interface Service
        Overrides:
        init in class AppService
        See Also:
        Service
      • destroy

        public void destroy()
        Description copied from interface: Service
        Release system resources. The object should release all system resources. This will be called only once and is called to prepare the object for finalization.
        Specified by:
        destroy in interface Service
        Overrides:
        destroy in class AppService
        See Also:
        Service
      • getMXServerVersion

        public java.lang.String[] getMXServerVersion(UserInfo userInfo)
                                              throws java.rmi.RemoteException
        Return the version for MXServer and any add-ons.
        Parameters:
        userInfo - UserInfo making the request
        Returns:
        Version info
        Throws:
        java.rmi.RemoteException
        See Also:
        MXServer.getMXServerVersion()
      • getDate

        public java.util.Date getDate()
                               throws java.rmi.RemoteException
        Get current date from MXServer.
        Returns:
        Current date
        Throws:
        java.rmi.RemoteException
        See Also:
        MXServer.getDate()
      • getProperty

        public java.lang.String getProperty(java.lang.String propName,
                                            UserInfo userInfo)
                                     throws java.rmi.RemoteException
        Return the cached property value for a property not flagged as "private". If the property is not defined, this will return null. If the property is defined but has no value, this will return the empty string. If userInfo is null, this will return only public properties.
        Parameters:
        propName - Property name
        userInfo - UserInfo making the request
        Returns:
        Property value
        Throws:
        java.rmi.RemoteException
        See Also:
        MXServer.getProperty(String, UserInfo)
      • getProperties

        public java.util.Map getProperties(java.util.List propNames,
                                           UserInfo userInfo)
                                    throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • getPropertyNames

        public java.util.List getPropertyNames(UserInfo userInfo)
                                        throws java.rmi.RemoteException
        Return all the current non-private property names of MXServer. If userInfo is null, this will return null.
        Parameters:
        userInfo - UserInfo making the request
        Returns:
        Set of property names (String)
        Throws:
        java.rmi.RemoteException
        See Also:
        MXServer.getConfig(UserInfo)
      • setProperty

        public void setProperty(java.lang.String propName,
                                java.lang.String serverName,
                                java.lang.String serverHost,
                                java.lang.String propValue,
                                UserInfo userInfo)
                         throws MXException,
                                java.rmi.RemoteException
        Set value for a property and initiate cache update to synchronize the new value across all servers using this database. An error will be thrown if any of the following is true:
        • Property does not exist (invalid property name).
        • Access is not allowed to this property (based on maxprop.securelevel).
        • The property does not permit updates while MXServer is up.
        • The property does not permit cache refresh while MXServer is up.
        • The current cached property value was loaded from the properties file (not from the database).
        • There is no row in MaxPropValue (servername and/or serverHost are not valid).
        • The requested new value is not valid for any reason.
        Parameters:
        propName - Property name (maxprop, maxpropvalue)
        serverName - Server name (maxpropvalue)
        serverHost - Can be null (maxpropvalue)
        propValue - The new value for this property
        userInfo - The userInfo making this request.
        Throws:
        MXException
        java.rmi.RemoteException
      • setPropertyAndRefresh

        public void setPropertyAndRefresh(java.lang.String propName,
                                          java.lang.String serverName,
                                          java.lang.String serverHost,
                                          java.lang.String propValue,
                                          UserInfo userInfo,
                                          boolean refresh)
                                   throws MXException,
                                          java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • liveRefreshProperty

        public void liveRefreshProperty(java.lang.String propName)
                                 throws java.rmi.RemoteException,
                                        MXException
        Throws:
        java.rmi.RemoteException
        MXException
      • deleteTaskScheduleFor

        public int deleteTaskScheduleFor(java.lang.String cronTaskName,
                                         java.lang.String cronInstanceName,
                                         UserInfo userInfo)
                                  throws java.rmi.RemoteException,
                                         MXException
        Throws:
        java.rmi.RemoteException
        MXException
      • getDeploymentMgrURL

        public java.lang.String getDeploymentMgrURL()
                                             throws java.rmi.RemoteException
        Specified by:
        getDeploymentMgrURL in interface SystemServiceRemote
        Throws:
        java.rmi.RemoteException
      • isManage

        public boolean isManage()
                         throws MXException,
                                java.rmi.RemoteException
        Return the boolean value of isManage() from MXServer.
        Returns:
        True or False
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        MXServer.isManage()