Implementing a Task

A task can be added on the fly during runtime. You implement a task class and put that class under Swordfish_installed_directory/custom directory. Then it will be automatically loaded when you open flow designer.

To implement a task, a task class must implement TaskHandler and define an TaskDefinition java annotation.

TaskHandler interface

TaskDefinition annotation

Attributes

FieldDefinition

Attributes

Example implementation - Wait Task

PreviousLogging Configuration NextCustom Class

Last updated 1 year ago

package com.ism.was.flow.entity;

import java.util.Map;
import java.util.Properties;

public interface TaskHandler {
	public boolean initializeTask(Properties props);
	public boolean execute(String flowId, String taskId, String transactionId, FlowTask [] tasks, Map requestData);
	public TaskResult getResult();
	public String getName();
	public boolean finalizeTask();
}

package com.ism.was.flow.annotation;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface TaskDefinition {
	public String name();
	public String description();
	public int arguments();
	public String html() default "";
	public String type() default "java";
	public String icon() default "";
	public FieldDefinition [] fields() default {};
	public FieldDefinition [] outs() default {};
	public boolean test() default false;
	public String testLink() default "";
	public boolean custom() default false;
	public String customPage() default "";
}

package com.ism.was.flow.annotation;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface FieldDefinition {

	public String name();
	public String label() default "";
	public String help() default "";
	public int width() default 0;
	public String type() default "text";
	public int height() default 0;
	public int rows() default 3;
	public int cols() default 80;
	public String selectFrom() default "";
	public String [] options() default {};
	public String [] labels() default {};
}

package com.ism.was.flow.handler;

import java.sql.Connection;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;

import com.ism.common.Common;
import com.ism.common.logger.DefaultLogger;
import com.ism.was.flow.annotation.FieldDefinition;
import com.ism.was.flow.annotation.TaskDefinition;
import com.ism.was.flow.config.FlowConstants;
import com.ism.was.flow.entity.FlowTask;
import com.ism.was.flow.entity.SubFlowExecution;
import com.ism.was.flow.entity.TaskHandler;
import com.ism.was.flow.entity.TaskResult;
import com.ism.was.flow.log.SubFlowExecutionLog;
import com.ism.was.flow.log.SubflowLogManager;
import com.ism.was.flow.util.FlowUtil;

@TaskDefinition(
		name="Wait", description="Wait sub flow completion", arguments=-1,
		custom=false,type="function",
		icon="images/wait.png",
		fields = { 
			@FieldDefinition(name="SubFlowId", width=100, height=30, rows=10, cols=80, type="select", selectFrom="com.ism.projects.jpa.web.flow.FlowProcessor" ),
			@FieldDefinition(name="ExecutionCount", width=100, height=30, rows=10, cols=80, type="text" ),
			@FieldDefinition(name="Timeout", width=100, height=30, rows=10, cols=80, type="text" ),
		},
		outs = { 

		}
	)
public class WaitSubTask implements TaskHandler {

	protected Properties props;
	protected TaskResult result;
	
	protected Properties outprops;
	
	private String resultValueName = null;
	
	public boolean initializeTask(Properties props) {
		// TODO Auto-generated method stub
		this.props = props;
		return true;
	}

	public boolean execute(String flowId, String taskId, String gidSeq, FlowTask[] tasks, Map imap) {
		// TODO Auto-generated method stub
		
		result = new TaskResult(gidSeq);
    	result.setStartTime();
    	
		Vector imaps = new Vector();
    	HashMap omap = new HashMap();
    	omap.putAll(imap);
		
    	result.setSuccess(true);
    	
	String gid = (String)imap.get("GID");
		
	String subFlowId = (String)props.get("SubFlowId");
	String executionCount = (String)props.get("ExecutionCount");
	String timeout = (String)props.get("Timeout");
		
	resultValueName = (String)props.get("out-ResultValue");
	if ( resultValueName == null || resultValueName.trim().length() < 1 ) {
		resultValueName = "ResultValue";
	}
		
	Object rtn = null;

	int completedCount = 0;
    	try {
    		executionCount = (String)FlowUtil.getValue(imap, props, executionCount);
    		if ( executionCount == null ) {
    			throw new Exception("ExecutionCount cannot be null or empty");
    		}
    		int executionCountInt = -1;
    		try {
    			executionCountInt = Integer.parseInt(executionCount.trim());	
    		}catch( Exception e ) {
    			throw new Exception("ExecutionCount value is invalid[" + executionCount + "]");
    		}
    		long start = System.currentTimeMillis();
    		long timeoutLong = Long.parseLong(timeout) * 1000; //30 sec
    		boolean succeeded = false;
    		int interval = 0;
    		while ( true ) {
			String fkey = String.format("%s-%s-%s", flowId, subFlowId, gid);
        			int count = SubflowLogManager.countComplete(fkey);
	    		if ( ++interval % 10 == 0 ) {
        				DefaultLogger.logN("Expected count = {}, logged count = {}, {}, {}, {} ", executionCountInt, count, flowId, subFlowId, gid);
    			}else {
        				DefaultLogger.logV("Expected count = {}, logged count = {}, {}, {}, {} ", executionCountInt, count, flowId, subFlowId, gid);
    			}
	        		if ( count != executionCountInt ) {
        				Thread.sleep(2000);
        			}else {
	        			succeeded = true;
            			SubflowLogManager.removeSubflows(fkey);
        				break;
	        		}
        			if ( Common.shutdown ) {
        				break;
	        		}
        			long now = System.currentTimeMillis();
	        		if ( now > (start + timeoutLong) ) {
        				break;
        			}
    		}
		omap.put(resultValueName, rtn);
    		result.setSuccess(succeeded);
    	}catch( Exception e ) {
    		DefaultLogger.logE(e, "Failed to executing function");
        		result.setErrorMessage(e.getMessage());
        		result.setException(e);
    		result.setSuccess(false);
    	}
	result.setData(omap);
    	result.setEndTime();
    	
    	return result.isSuccess();
	}

	public TaskResult getResult() {
		// TODO Auto-generated method stub
		return result;
	}

	public String getName() {
		// TODO Auto-generated method stub
		return null;
	}

	public boolean finalizeTask() {
		// TODO Auto-generated method stub
		return false;
	}
	
}