Package com.redwood.scheduler.api.model

Interface ProcessServer

    • Method Detail

      • getStatus

        ProcessServerStatus getStatus()
        Get the value for Status. (The process server status.) 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.

      • isStartOnStartup

        boolean isStartOnStartup()
        Get the value for StartOnStartup. (Start this process server at system startup.)
        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.

      • getExecutionSize

        Long getExecutionSize()
        Get the value for ExecutionSize. (ExecutionSize is the maximum number of concurrent executing jobs allowed for this ProcessServer. If IncludeWaitingJobs is true this includes jobs in Executing and Idle JobStatusStates. If IncludeWaitingJobs is false then this only includes the jobs in the Executing JobStatusState.)
        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.

      • isInclusive

        boolean isInclusive()
        Get the value for Inclusive. (Does ExecutionSize include waiting jobs?)
        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.

      • 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 Process Server. If the ProcessServer is running (in ProcessServerStatus.RUNNING || ProcessServerStatus.OVERLOADED), this aggregates the load of each LoadFactor, otherwise return null.) 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.

      • isMonitorOnDashboard

        boolean isMonitorOnDashboard()
        Get the value for MonitorOnDashboard. (Should the process server be monitored on the dashboard? This is a calculated field, stored in an object tag, and may be deleted in the future.)
        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.

      • isOverloaded

        boolean isOverloaded()
        Get the value for Overloaded. (Return if the process server is currently overloaded 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.

      • isSecureGatewayCandidate

        boolean isSecureGatewayCandidate()
        Get the value for SecureGatewayCandidate. (Is this process server allowed to be the Secure Gateway.)
        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.

      • isSecureGateway

        boolean isSecureGateway()
        Get the value for SecureGateway. (Return if the process server is the current Secure Gateway.)
        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.

      • setStartOnStartup

        void setStartOnStartup​(boolean newStartOnStartup)
        Set the value for StartOnStartup. (Start this process server at system startup.)
        Parameters:
        newStartOnStartup - the new value for StartOnStartup.
        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.

      • setExecutionSize

        void setExecutionSize​(Long newExecutionSize)
        Set the value for ExecutionSize. (ExecutionSize is the maximum number of concurrent executing jobs allowed for this ProcessServer. If IncludeWaitingJobs is true this includes jobs in Executing and Idle JobStatusStates. If IncludeWaitingJobs is false then this only includes the jobs in the Executing JobStatusState.) This value is optional.
        Parameters:
        newExecutionSize - the new value for ExecutionSize.
        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.

      • setMonitorOnDashboard

        void setMonitorOnDashboard​(boolean newMonitorOnDashboard)
        Set the value for MonitorOnDashboard. (Should the process server be monitored on the dashboard? This is a calculated field, stored in an object tag, and may be deleted in the future.)
        Parameters:
        newMonitorOnDashboard - the new value for MonitorOnDashboard.
        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.

      • setSecureGatewayCandidate

        void setSecureGatewayCandidate​(boolean newSecureGatewayCandidate)
        Set the value for SecureGatewayCandidate. (Is this process server allowed to be the Secure Gateway.)
        Parameters:
        newSecureGatewayCandidate - the new value for SecureGatewayCandidate.
        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.

      • getParametersLOV

        LOVCollection getParametersLOV​(String query)
        Get a List of Values (LOV) for process server parameter names, using the specified query (if present).
        Parameters:
        query - Part of the parameter name to query for. Treated as a case-insensitive substring.
        Returns:
        The list of possible process server parameter names.

      • getBrowseableProcessServerService

        ProcessServerService getBrowseableProcessServerService()
                                                throws com.redwood.scheduler.api.exception.AmbiguousBrowseableProcessServerServiceException
        Get ProcessServerService which allows file browsing
        Returns:
        The ProcessServerService which allows file browsing.
        Throws:
        com.redwood.scheduler.api.exception.AmbiguousBrowseableProcessServerServiceException - ProcessServers can never have multiple browsable ProcessServerServices.

      • createProcessServerJobDefinitionTypesByOSFamily

        void createProcessServerJobDefinitionTypesByOSFamily​(String osFamily)
        Create the default process servers by the OS Family
        Parameters:
        osFamily - The OS Family to create the ProcessServerJobDefinitionTypes for.

      • getMonitorRootPath

        String getMonitorRootPath()
        Get the root path label to use for the process server in the monitor tree. Depends on the configuration/Monitoring/MonitorRootPath registry key: (a) KeyValue = PartitionColonNonGlobal (default) -> if partition is GLOBAL return ProcessServerName else return Partition:ProcessServerName. (b) KeyValue = PartitionColonAlways -> Always return Partition:ProcessServerName. (c) KeyValue = PartitionPathAlways -> Always return Partition/ProcessServerName.
        Returns:
        The String to use as the root path in the monitor tree

      • getValidCheckStyles

        Set<ProcessServerCheckStyle> getValidCheckStyles()
        Returns the ProcessServerCheckStyles that can be run for this process server
        Returns:
        A Set of ProcessServerCheckStyle objects

      • restart

        void restart​(Long timeout)
        Restart the ProcessServer, calling stop and then start, waiting for the defined timeout before aborting.
        Parameters:
        timeout - The timeout (milliseconds) before aborting the restart attempt.

      • isAllowedJobDefinition

        boolean isAllowedJobDefinition​(JobDefinition jobDefinition)
        Check a JobDefinition's compatibility (resources and type) with this ProcessServer
        Parameters:
        jobDefinition - The JobDefinition to check
        Returns:
        True for a compatible JobDefinition

      • start

        void start()
        Start the ProcessServer.

      • stop

        void stop()
        Stop the ProcessServer normally.

      • restart

        void restart()
        Restart the ProcessServer, calling stop and then start. This uses the default timeout ProcessServer.RESTART_TIMEOUT if it cannot be restarted.

      • getDefaultJobTimeZone

        TimeZone getDefaultJobTimeZone()
        Get the DefaultJobTimeZone.
        Returns:
        DefaultJobTimeZone
        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.

      • setDefaultJobTimeZone

        void setDefaultJobTimeZone​(TimeZone newDefaultJobTimeZone)
        Set the value for DefaultJobTimeZone. This value is mandatory.
        Parameters:
        newDefaultJobTimeZone - is the object to set DefaultJobTimeZone to. Which TimeZone will be ascribed to the Jobs DateTimeZone fields by default @deprecated This relationship has been deprecated and should not be set. It is not used by the product If this is null, then the object cannot be persisted.

      • getProcessServerStatusLogByCreationTime

        ProcessServerStatusLog getProcessServerStatusLogByCreationTime​(DateTimeZone creationTime)
        Get the ProcessServerStatusLog by ProcessServerStatusCreationTime.
        Parameters:
        creationTime -
        Returns:
        the ProcessServerStatusLog, or null if it could not be found

      • getProcessServerJobDefinitionTypeByJobDefinitionType

        ProcessServerJobDefinitionType getProcessServerJobDefinitionTypeByJobDefinitionType​(JobDefinitionType jobDefinitionType)
        Get the ProcessServerJobDefinitionType by Association.
        Parameters:
        jobDefinitionType -
        Returns:
        the ProcessServerJobDefinitionType, or null if it could not be found

      • getProcessServerParameterByNameType

        ProcessServerParameter getProcessServerParameterByNameType​(String name,
                                                           ProcessServerParameterType type)
        Get the ProcessServerParameter by Name.
        Parameters:
        name -
        type -
        Returns:
        the ProcessServerParameter, or null if it could not be found

      • getProcessServerResourceByResource

        ProcessServerResource getProcessServerResourceByResource​(Resource resource)
        Get the ProcessServerResource by Association.
        Parameters:
        resource -
        Returns:
        the ProcessServerResource, or null if it could not be found

      • getProcessServerServiceByService

        ProcessServerService getProcessServerServiceByService​(Service service)
        Get the ProcessServerService by Association.
        Parameters:
        service -
        Returns:
        the ProcessServerService, or null if it could not be found

      • getQueueProviderByQueue

        QueueProvider getQueueProviderByQueue​(Queue queue)
        Get the QueueProvider by QueueProvider.
        Parameters:
        queue -
        Returns:
        the QueueProvider, or null if it could not be found

      • checkCreatePrivilege

        RequiredPermission checkCreatePrivilege()
        Check whether or not the create action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkViewPrivilege

        RequiredPermission checkViewPrivilege()
        Check whether or not the view action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkViewJobsPrivilege

        RequiredPermission checkViewJobsPrivilege()
        Check whether or not the viewJobs action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkControlPrivilege

        RequiredPermission checkControlPrivilege()
        Check whether or not the control action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkEditPrivilege

        RequiredPermission checkEditPrivilege()
        Check whether or not the edit action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkDeletePrivilege

        RequiredPermission checkDeletePrivilege()
        Check whether or not the delete action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.