TaskEvent.java example

Explorer
midpoint-master
/*
 * Copyright (c) 2010-2016 Evolveum
 *
 * 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 com.evolveum.midpoint.notifications.api.events;

import com.evolveum.midpoint.prism.path.ItemPath;
import com.evolveum.midpoint.schema.result.OperationResult;
import com.evolveum.midpoint.schema.result.OperationResultStatus;
import com.evolveum.midpoint.task.api.LightweightIdentifierGenerator;
import com.evolveum.midpoint.task.api.Task;
import com.evolveum.midpoint.task.api.TaskRunResult;
import com.evolveum.midpoint.util.logging.Trace;
import com.evolveum.midpoint.util.logging.TraceManager;
import com.evolveum.midpoint.xml.ns._public.common.common_3.*;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * @author mederly
 */
public class TaskEvent extends BaseEvent {

    private static final Trace LOGGER = TraceManager.getTrace(TaskEvent.class);

	@NotNull private final Task task;
	@Nullable private final TaskRunResult taskRunResult;			// nullable only if operationType == ADD
	@NotNull private final EventOperationType operationType;		// only ADD or DELETE

    public TaskEvent(LightweightIdentifierGenerator lightweightIdentifierGenerator, @NotNull Task task, @Nullable TaskRunResult runResult,
			@NotNull EventOperationType operationType, String channel) {
        super(lightweightIdentifierGenerator);
		this.task = task;
		this.taskRunResult = runResult;
		this.operationType = operationType;
		setChannel(channel);
    }

	@NotNull
	public Task getTask() {
		return task;
	}

	@Nullable
	public TaskRunResult getTaskRunResult() {
		return taskRunResult;
	}

	@NotNull
	public EventOperationType getOperationType() {
		return operationType;
	}

	public boolean isTemporaryError() {
		return taskRunResult != null && taskRunResult.getRunResultStatus() == TaskRunResult.TaskRunResultStatus.TEMPORARY_ERROR;
	}

	public boolean isPermanentError() {
		return taskRunResult != null && taskRunResult.getRunResultStatus() == TaskRunResult.TaskRunResultStatus.PERMANENT_ERROR;
	}

	public boolean isFinished() {
		return taskRunResult != null &&
				(taskRunResult.getRunResultStatus() == TaskRunResult.TaskRunResultStatus.FINISHED ||
						taskRunResult.getRunResultStatus() == TaskRunResult.TaskRunResultStatus.FINISHED_HANDLER);
	}

	public boolean isInterrupted() {
		return taskRunResult != null && taskRunResult.getRunResultStatus() == TaskRunResult.TaskRunResultStatus.INTERRUPTED;
	}

	public boolean isRestartRequested() {
		return taskRunResult != null && taskRunResult.getRunResultStatus() == TaskRunResult.TaskRunResultStatus.RESTART_REQUESTED;
	}

    @Override
    public boolean isStatusType(EventStatusType eventStatusType) {
		if (eventStatusType == null) {
			return false;
		}
		if (taskRunResult == null) {
			return eventStatusType == EventStatusType.SUCCESS || eventStatusType == EventStatusType.ALSO_SUCCESS || eventStatusType == EventStatusType.IN_PROGRESS;
		}
		OperationResult result = taskRunResult.getOperationResult();
		switch (eventStatusType) {
			case SUCCESS:
			case ALSO_SUCCESS: return result.isSuccess() || result.isHandledError() || result.isWarning();
			case IN_PROGRESS: return false;
			case FAILURE: return result.isError();
			case ONLY_FAILURE: return result.isFatalError();
			default: throw new IllegalStateException("Invalid eventStatusType: " + eventStatusType);
		}
    }

    @Override
    public boolean isOperationType(EventOperationType eventOperationType) {
		return this.operationType == eventOperationType;
    }

    @Override
    public boolean isCategoryType(EventCategoryType eventCategoryType) {
        return eventCategoryType == EventCategoryType.TASK_EVENT;
    }

    @Override
    public boolean isRelatedToItem(ItemPath itemPath) {
        return false;
    }

    @Override
    public boolean isUserRelated() {
        return false;
    }

	public OperationResultStatus getOperationResultStatus() {
		return taskRunResult != null && taskRunResult.getOperationResult() != null ? taskRunResult.getOperationResult().getStatus() : null;
	}

	public String getMessage() {
		return taskRunResult != null && taskRunResult.getOperationResult() != null ? taskRunResult.getOperationResult().getMessage() : null;
	}

	public long getProgress() {
		return taskRunResult != null ? taskRunResult.getProgress() : task.getProgress();
	}
}