HTTaskStatusMonitor.java

/*
 *
 *   Copyright (c) 2015, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 *   WSO2 Inc. licenses this file to you 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.wso2.carbon.humantask.core.integration.jmx;

import org.apache.axis2.databinding.types.URI;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.wso2.carbon.humantask.client.api.IllegalAccessFault;
import org.wso2.carbon.humantask.client.api.IllegalArgumentFault;
import org.wso2.carbon.humantask.client.api.IllegalOperationFault;
import org.wso2.carbon.humantask.client.api.IllegalStateFault;
import org.wso2.carbon.humantask.core.api.mgt.HTQueryBuildHelper;
import org.wso2.carbon.humantask.core.api.mgt.HTQueryBuildHelperImpl;
import org.wso2.carbon.humantask.skeleton.mgt.services.PackageManagementException;
import org.wso2.carbon.humantask.types.TPredefinedStatus;

/**
 * implementation of  HTTaskStatusMonitorMXBean.
 */
public class HTTaskStatusMonitor implements HTTaskStatusMonitorMXBean {

    private static final Log log = LogFactory.getLog(HTTaskStatusMonitor.class);
    private final String name = "HTTaskStatusMonitor";
    private HTQueryBuildHelper queryBuilderHelper = new HTQueryBuildHelperImpl();

    /**
     * @return String[] contains all deployed tasks details (task instances count, tenant ID, task def name, task name, operation, port name) for all tenants
     * @throws IllegalAccessFault
     * @throws IllegalArgumentFault
     * @throws IllegalStateFault
     * @throws IllegalOperationFault
     */
    public String[] showAllTaskDefinitions()
            throws IllegalAccessFault, IllegalArgumentFault, IllegalStateFault,
                   IllegalOperationFault, PackageManagementException {
        String[] result = {"No task deployed yet in all the available tenants"};
        String[] resultTemp = new String[0];
        try {
            resultTemp = queryBuilderHelper.getAllDeployedTasks();
        } catch (Exception e) {
            log.error(e.getMessage(), e);
        }
        if (resultTemp != null && resultTemp.length > 0) {
            result = resultTemp;
        }
        return result;
    }

    /**
     * @param taskName : can be a task name or task def name, based on that the result will be given, preferred: task def name
     * @return String[] of task instances' details ( task instances count for each  status)
     * @throws IllegalAccessFault
     * @throws IllegalArgumentFault
     * @throws IllegalStateFault
     * @throws IllegalOperationFault
     */
    public String[] getInstanceCountForTaskDefinition(String taskName)
            throws IllegalAccessFault, IllegalArgumentFault, IllegalStateFault,
                   IllegalOperationFault {
        String[] result = {"No task deployed yet in all the available tenants"};
        try {
            String[] resultTemp = queryBuilderHelper.getTaskInstanceCountsByState(taskName);
            if (resultTemp != null && resultTemp.length > 0) {
                result = resultTemp;
            }
        } catch (Exception e) {
            log.error(e.getMessage(), e);
        }
        return result;
    }

    /**
     * @param status give a valid status to search the task instances in that status
     * @return String[] of all task instances for the given status
     * @throws IllegalStateFault
     * @throws IllegalOperationFault
     * @throws IllegalArgumentFault
     * @throws IllegalAccessFault
     */
    public String[] getInstancesListForTaskState(String status)
            throws IllegalStateFault, IllegalOperationFault, IllegalArgumentFault,
                   IllegalAccessFault {
        String[] taskInstances = {"There are 0 task instances in the system "};
        String[] invalidTaskStatusMessage = {"Invalid Task status provided"};

        if(status == null || status.isEmpty()) {
            return invalidTaskStatusMessage;
        } else {
            try {
                TPredefinedStatus.Enum statusEnumValue = null;
                statusEnumValue = TPredefinedStatus.Enum.forString(status.toUpperCase());
                if(null != statusEnumValue) {
                    return queryBuilderHelper.getTaskInstances(statusEnumValue);
                } else  {
                    return invalidTaskStatusMessage;
                }
            } catch (Exception e) {
                taskInstances = invalidTaskStatusMessage;
                log.error(e.getMessage(), e);
            }
        }
        return taskInstances;
    }

    /**
     * @param taskID taskId of the task instance which details should be displayed
     * @return all the available details of the task instance
     * @throws IllegalAccessFault
     * @throws IllegalArgumentFault
     * @throws IllegalStateFault
     * @throws IllegalOperationFault
     * @throws URI.MalformedURIException
     */

    public String[] getTaskInstanceDetails(String taskID)
            throws IllegalAccessFault, IllegalArgumentFault, IllegalStateFault,
                   IllegalOperationFault, URI.MalformedURIException {
        String[] taskInstances = {"No task found with the given ID in all the available tenants"};
        String[] invalidTaskIDMessage = {"Invalid task id provided, please specify a valid task id"};
        if(null == taskID || taskID.isEmpty()) {
            return invalidTaskIDMessage;
        }
        try {
            taskInstances = queryBuilderHelper.getTaskDataById(taskID);
        } catch (Exception e) {
            log.error(e.getMessage(), e);
        }
        return taskInstances;
    }

    /**
     * @return value of name variable
     */
    public String getName() {
        return name;
    }
}