SWORDException.java

/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.purl.sword.base;

/**
 * Represents a generic SWORD exception. If this thrown by a repository,
 * it would result in a HTTP 500 message being returned to the user.
 * 
 * @author Stuart Lewis
 * @author Neil Taylor
 */
public class SWORDException extends Exception 
{
	private String errorCode;
	
	/**
     * Create a new instance and store the specified message and source data. 
     * 
     * @param message The message for the exception. 
     * @param source  The original exception that lead to this exception. This
     *                can be <code>null</code>.
     */
    public SWORDException(String message, Exception source)
    {  
       super(message, source); 
    }
    
    /**
     * Create a new instance and store the specified message and source data. 
     * 
     * @param message The message for the exception. 
     * @param source  The original exception that lead to this exception. This
     *                can be <code>null</code>.
     * @param errorCode The error code to sed back with the request
     */
    public SWORDException(String message, Exception source, String errorCode)
    {  
       super(message, source); 
       this.errorCode = errorCode;
    }
    
    /**
     * Create a new instance and store the specified message. 
     * 
     * @param message The message for the exception. 
     */
    public SWORDException(String message)
    {
       super(message);
    }
    
    /**
     * Get the error code
     * 
     * @return The error code
     */
    public String getErrorCode() {
    	return errorCode;
    }
}