io.katharsis.errorhandling.mapper.ExceptionMapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of katharsis-core Show documentation

Core Katharsis library

The newest version!

package io.katharsis.errorhandling.mapper;

import io.katharsis.errorhandling.ErrorResponse;

/**
 * ExceptionMapper supporting both Katharsis servers and clients.
 */
public interface ExceptionMapper extends JsonApiExceptionMapper {

	/**
	 * Converts the given exception to an JSON API response. Used on the server-side.
	 */
	@Override
	ErrorResponse toErrorResponse(E exception);

	/**
	 * Convert the given error response to an exception. Used on the client-side.
	 *
	 * @param errorResponse error response
	 * @return exception
	 */
	E fromErrorResponse(ErrorResponse errorResponse);

	/**
	 * Decides whether the given errorResponse can be handled by this mapper. 
	 * If true is returned, {@link #fromErrorResponse(ErrorResponse)} will be called.
	 * 
	 * If multiple mappers accept a given error response, the most specific exception is chosen, meaning
	 * the one with the most superTypes.
	 * 
	 * @param errorResponse
	 * @return true if it can be handled.
	 */
	boolean accepts(ErrorResponse errorResponse);
}