ResumableTestWorkflowOperationHandler.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community 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://opensource.org/licenses/ecl2.txt
 *
 * 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.opencastproject.workflow.impl;

import org.opencastproject.job.api.JobContext;
import org.opencastproject.workflow.api.AbstractWorkflowOperationHandler;
import org.opencastproject.workflow.api.ResumableWorkflowOperationHandler;
import org.opencastproject.workflow.api.WorkflowInstance;
import org.opencastproject.workflow.api.WorkflowOperationException;
import org.opencastproject.workflow.api.WorkflowOperationResult;
import org.opencastproject.workflow.api.WorkflowOperationResult.Action;

import java.util.Map;

/**
 * Implementation to be used by test cases.
 */
public class ResumableTestWorkflowOperationHandler extends AbstractWorkflowOperationHandler implements
        ResumableWorkflowOperationHandler {

  protected Action startAction = null;

  protected Action resumeAction = null;

  /** True if the start() method has been called */
  private boolean started = false;

  /** True if the resume() method has been called */
  private boolean resumed = false;

  /** The properties used to resume the workflow, or null */
  private Map<String, String> properties;

  /**
   * Creates a new workflow operation handler that will pause on <code>start()</code> and continue on
   * <code>resume()</code>.
   */
  public ResumableTestWorkflowOperationHandler() {
    this("test", Action.PAUSE, Action.CONTINUE);
  }

  /**
   * Creates a new workflow operation handler that will return <code>startAction</code> on <code>start()</code> and
   * <code>resumeAction</code> on <code>resume()</code>.
   */
  public ResumableTestWorkflowOperationHandler(Action startAction, Action resumeAction) {
    this("test", startAction, resumeAction);
  }

  /**
   * Creates a new workflow operation handler that will return <code>startAction</code> on <code>start()</code> and
   * <code>resumeAction</code> on <code>resume()</code>.
   */
  public ResumableTestWorkflowOperationHandler(String id, Action startAction, Action resumeAction) {
    super.id = id;
    this.startAction = startAction;
    this.resumeAction = resumeAction;
  }

  /**
   * Sets the action that is returned on {@link #start(WorkflowInstance, JobContext)}.
   *
   * @param startAction
   *          the start action
   */
  void setStartAction(Action startAction) {
    this.startAction = startAction;
  }

  /**
   * Sets the action that is returned on {@link #resume(WorkflowInstance, JobContext, Map)}.
   *
   * @param resumeAction
   *          the resume action
   */
  void setResumeAction(Action resumeAction) {
    this.resumeAction = resumeAction;
  }

  /**
   * Returns <code>true</code> if the resume() method has been called.
   *
   * @return <code>true</code> if the handler was resumed
   */
  public boolean isResumed() {
    return resumed;
  }

  /**
   * Returns <code>true</code> if the start() method has been called.
   *
   * @return <code>true</code> if the handler was started
   */
  public boolean isStarted() {
    return started;
  }

  /**
   * Resets the state of this handler.
   */
  public void clear() {
    resumed = false;
    started = false;
    this.properties = null;
  }

  /**
   * {@inheritDoc}
   *
   * @see org.opencastproject.workflow.api.AbstractWorkflowOperationHandler#start(org.opencastproject.workflow.api.WorkflowInstance,
   *      JobContext)
   */
  @Override
  public WorkflowOperationResult start(WorkflowInstance workflowInstance, JobContext context)
          throws WorkflowOperationException {
    this.started = true;
    return createResult(startAction);
  }

  /**
   * {@inheritDoc}
   *
   * @see org.opencastproject.workflow.api.ResumableWorkflowOperationHandler#resume(org.opencastproject.workflow.api.WorkflowInstance,
   *      JobContext, java.util.Map)
   */
  @Override
  public WorkflowOperationResult resume(WorkflowInstance workflowInstance, JobContext context,
          Map<String, String> properties) throws WorkflowOperationException {
    this.resumed = true;
    this.properties = properties;
    return createResult(resumeAction);
  }

  /**
   * {@inheritDoc}
   *
   * @see org.opencastproject.workflow.api.ResumableWorkflowOperationHandler#getHoldStateUserInterfaceURL(org.opencastproject.workflow.api.WorkflowInstance)
   */
  @Override
  public String getHoldStateUserInterfaceURL(WorkflowInstance workflowInstance) throws WorkflowOperationException {
    return null;
  }

  /**
   * {@inheritDoc}
   *
   * @see org.opencastproject.workflow.api.ResumableWorkflowOperationHandler#getHoldActionTitle()
   */
  @Override
  public String getHoldActionTitle() {
    return "Test action";
  }

  /**
   * @return the properties
   */
  public Map<String, String> getProperties() {
    return properties;
  }

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

}