net.anotheria.anosite.handler.ResponseAbort Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ano-site Show documentation

There is a newer version: 4.3.2.1

package net.anotheria.anosite.handler;

import net.anotheria.anosite.shared.InternalResponseCode;
/**
 * Commands the called to abort the execution. This usually happens if the execution encountered and exception.
 * @author lrosenberg
 */
public class ResponseAbort extends BoxHandlerResponse{
	/**
	 * The underlying exception (if any).
	 */
	private Exception cause;
	/**
	 * Creates a new abort response.
	 */
	public ResponseAbort(){
		
	}
	/**
	 * Creates a new abort response with the given code.
	 * @param aCause source exception.
	 */
	public ResponseAbort(Exception aCause){
		cause = aCause;
	}

	@Override
	public InternalResponseCode getResponseCode() {
		return InternalResponseCode.ABORT;
	}
	/**
	 * Returns the cause of the abort (i.e. the exception).
	 * @return cause of the InternalError.
	 */
	public Exception getCause(){
		return cause;
	}
	/**
	 * Returns the exception's message or null.
	 * @return original cause message.
	 */
	public String getCauseMessage(){
		return cause == null ? null : cause.getMessage();
	}
	
	
	
}