org.copperengine.management.ProcessingEngineMXBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of copper-jmx-interface Show documentation

COPPER is an open-source, powerful, light-weight, and easily configurable workflow engine. The power of COPPER is that it uses Java as a description language for workflows.

There is a newer version: 5.5.2

Show newest version

/*
 * Copyright 2002-2015 SCOOP Software GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.copperengine.management;

import java.util.List;

import org.copperengine.management.model.EngineActivity;
import org.copperengine.management.model.EngineType;
import org.copperengine.management.model.WorkflowInfo;
import org.copperengine.management.model.WorkflowInstanceFilter;

public interface ProcessingEngineMXBean {
    public String getState();

    public String getEngineId();

    public EngineType getEngineType();

    /**
     * Query all currently Running instances from memory only, Note it WON'T return instances in WAITING
     * state
     * @return List of workflow information
     */
    public List queryWorkflowInstances();

    /**
     * Query all active instances, this includes instances in ENQUEUED, WAITING and RUNNING state
     * 
     * @param className
     *        - optional, returns workflow instances
     * @param max
     *        - to limit of number of workflows returned
     * @return List of workflow information
     */
    public List queryActiveWorkflowInstances(String className, int max);

    /**
     * query one workflow instance from memory, Note it WON'T return instances in WAITING state
     * 
     * @param id workflow id
     * @return info about this single workflow (Not if workflow is waiting). null if workflow not found.
     */
    public WorkflowInfo queryWorkflowInstance(String id);

    /**
     * query one workflow instance from memory or db regardless of its state
     * 
     * @param id workflow id
     * @return info about this single workflow. null if workflow not found.
     */
    public WorkflowInfo queryActiveWorkflowInstance(String id);

    public int getNumberOfWorkflowInstances();

    public List getProcessorPools();

    public WorkflowRepositoryMXBean getWorkflowRepository();

    public String getDependencyInjectorType();

    public String getStatisticsCollectorType();
    
    public EngineActivity queryEngineActivity(int minutesInHistory);
    
    /**
     * @return a list of all possible workflow instance states
     */
    public List getWorkflowInstanceStates();
    
    public List queryWorkflowInstances(WorkflowInstanceFilter filter);

    public long countWorkflowInstances(WorkflowInstanceFilter filter);
}