Interface SAPApplicationServer

    • Method Detail

      • getLoadThreshold

        Long getLoadThreshold()
        Get the value for LoadThreshold. (The maximum load the server can support before being marked as overloaded.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getLoad

        Long getLoad()
        Get the value for Load. (Get the current load of the SAP Application Server.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isActive

        boolean isActive()
        Get the value for Active. (Whether this application server is currently up and running or not.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isEnabled

        boolean isEnabled()
        Get the value for Enabled. (Whether this application server is currently enabled for load balancing or not.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getNumberOfWorkProcesses

        Long getNumberOfWorkProcesses()
        Get the value for NumberOfWorkProcesses. (Total number of work processes.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getNumberOfClassAWorkProcesses

        Long getNumberOfClassAWorkProcesses()
        Get the value for NumberOfClassAWorkProcesses. (Number of class A work processes.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setLoadThreshold

        void setLoadThreshold​(Long newLoadThreshold)
        Set the value for LoadThreshold. (The maximum load the server can support before being marked as overloaded.) This value is optional.
        Parameters:
        newLoadThreshold - the new value for LoadThreshold.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setEnabled

        void setEnabled​(boolean newEnabled)
        Set the value for Enabled. (Whether this application server is currently enabled for load balancing or not.)
        Parameters:
        newEnabled - the new value for Enabled.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setNumberOfWorkProcesses

        void setNumberOfWorkProcesses​(Long newNumberOfWorkProcesses)
        Set the value for NumberOfWorkProcesses. (Total number of work processes.) This value is mandatory.
        Parameters:
        newNumberOfWorkProcesses - the new value for NumberOfWorkProcesses. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setNumberOfClassAWorkProcesses

        void setNumberOfClassAWorkProcesses​(Long newNumberOfClassAWorkProcesses)
        Set the value for NumberOfClassAWorkProcesses. (Number of class A work processes.) This value is mandatory.
        Parameters:
        newNumberOfClassAWorkProcesses - the new value for NumberOfClassAWorkProcesses. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isOverloaded

        boolean isOverloaded()
        Return if the SAPApplicationServer is currently overloaded or not. Return if the SAPApplicationServer is currently overloaded or not. This is calculated from the SAPApplicationServerLoadFactors whenever a call to the getLoad function is made.
        Returns:
        The overloaded status of the SAPApplicationServer.
      • getSAPSystem

        SAPSystem getSAPSystem()
        Get the SAPSystem.
        Returns:
        SAPSystem
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
      • getSAPApplicationServerProviderBySAPApplicationServerGroup

        SAPApplicationServerProvider getSAPApplicationServerProviderBySAPApplicationServerGroup​(SAPApplicationServerGroup sAPApplicationServerGroup)
        Get the SAPApplicationServerProvider by SAPAppSrvProvider.
        Parameters:
        sAPApplicationServerGroup -
        Returns:
        the SAPApplicationServerProvider, or null if it could not be found