org.openbp.cockpit.plugins.debugger.DebuggerServerEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openbp-cockpit Show documentation
OpenBP Cockpit (graphical process modeler)
The newest version!
/*
 *   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.openbp.cockpit.plugins.debugger;

import org.openbp.core.engine.debugger.DebuggerEvent;
import org.openbp.core.model.ModelQualifier;
import org.openbp.jaspira.event.JaspiraEvent;
import org.openbp.jaspira.plugin.Plugin;

/**
 * Client event that wraps a debugger server event.
 * The event information is contained in the server event class
 * {@link org.openbp.core.engine.debugger.DebuggerEvent}

 * The event name is the same as defined in the
 * the EngineTraceEvent class.
 *
 * @author Stephan Moritz
 */
public class DebuggerServerEvent extends JaspiraEvent
{
	/** Basename for events */
	public static final String BASE = "debugger.server.";

	/** Event */
	private DebuggerEvent debuggerEvent;

	/**
	 * Constructor.
	 *
	 * @param source Source plugin
	 * @param debuggerEvent Debugger event from the server that initiated this event
	 */
	public DebuggerServerEvent(Plugin source, DebuggerEvent debuggerEvent)
	{
		super(source, BASE + debuggerEvent.getEventType());

		this.debuggerEvent = debuggerEvent;
	}

	/**
	 * Gets the underlying debugger event.
	 */
	public DebuggerEvent getDebuggerEvent()
	{
		return debuggerEvent;
	}

	/**
	 * Gets the event type.
	 * @return The event type class)
	 */
	public String getEventType()
	{
		return debuggerEvent.getEventType();
	}

	/**
	 * Gets the current position of halted process.
	 */
	public ModelQualifier getHaltedPosition()
	{
		return debuggerEvent.getHaltedPosition();
	}

	/**
	 * Gets the exception that has occurred.
	 */
	public Throwable getException()
	{
		return debuggerEvent.getException();
	}

	/**
	 * Gets the executed data link.
	 */
	public ModelQualifier getControlLinkQualifier()
	{
		return debuggerEvent.getControlLinkQualifier();
	}

	/**
	 * Gets the executed control link.
	 */
	public ModelQualifier getDataLinkQualifier()
	{
		return debuggerEvent.getDataLinkQualifier();
	}

	/**
	 * Gets the source node socket.
	 */
	public ModelQualifier getSourceSocketQualifier()
	{
		return debuggerEvent.getSourceSocketQualifier();
	}

	/**
	 * Gets the target node socket.
	 */
	public ModelQualifier getTargetSocketQualifier()
	{
		return debuggerEvent.getTargetSocketQualifier();
	}

	/**
	 * Gets the source parameter.
	 */
	public ModelQualifier getSourceParamName()
	{
		return debuggerEvent.getSourceParamName();
	}

	/**
	 * Gets the source parameter member path.
	 */
	public String getSourceMemberPath()
	{
		return debuggerEvent.getSourceMemberPath();
	}

	/**
	 * Gets the target parameter.
	 */
	public ModelQualifier getTargetParamName()
	{
		return debuggerEvent.getTargetParamName();
	}

	/**
	 * Gets the target parameter member path.
	 */
	public String getTargetMemberPath()
	{
		return debuggerEvent.getTargetMemberPath();
	}

	/**
	 * Gets the param value.
	 */
	public Object getParamValue()
	{
		return debuggerEvent.getParamValue();
	}

	/**
	 * Gets the string representation of the exception that has occurred.
	 * This method is used if the thorwable is not able to be transfered with
	 * RMI.
	 *
	 */
	public String getExceptionString()
	{
		return debuggerEvent.getExceptionString();
	}

	/**
	 * Gets the param value as string.
	 */
	public String getParamValueString()
	{
		return debuggerEvent.getParamValueString();
	}
}