server/io.spine.server.commandbus/InvalidCommandException

InvalidCommandException

public class InvalidCommandException extends CommandException implements MessageInvalid

The exception for reporting invalid commands.

A command is invalid if it's supported (there's a handler for the command), but its attributes are not populated according to framework conventions or validation constraints.

Inherited properties

ATTR_COMMAND_TYPE_NAME

public final static String ATTR_COMMAND_TYPE_NAME

The name of the attribute of the command type reported in an error.

cause

public Throwable cause

command

public final Command command

stackTrace

public Array<StackTraceElement> stackTrace

Functions

inapplicableTenantId

public static InvalidCommandException inapplicableTenantId(Command command)

Creates an exception for the command which specifies a tenant in a single-tenant context.

missingTenantId

public static InvalidCommandException missingTenantId(Command command)

Creates an exception for a command with missing tenant_id attribute in the CommandContext which is required in a multitenant application.

onConstraintViolations

public static InvalidCommandException onConstraintViolations(Command command, Iterable<ConstraintViolation> violations)

Creates an exception instance for a command message, which has fields that violate validation constraint(s).

unknownTenantError

public static Error unknownTenantError(Message commandMessage, String errorText)

Creates an error for a command with missing tenant_id attribute in the CommandContext which is required in a multitenant application.

Inherited functions

addSuppressed

public final synchronized void addSuppressed(Throwable exception)

asError

public Error asError()

Converts this instance into an io.spine.base.Error.

asThrowable

public Throwable asThrowable()

Converts this instance into a java.lang.Throwable.

commandTypeAttribute

public static Map<String, Value> commandTypeAttribute(Message commandMessage)

Returns a map with a command type attribute.

createError

protected static Error createError(String format, Command command, CommandValidationError errorCode)

fillInStackTrace

public synchronized Throwable fillInStackTrace()

getCause

public synchronized Throwable getCause()

getCommand

public Command getCommand()

Returns a related command.

getLocalizedMessage

public String getLocalizedMessage()

getMessage

public String getMessage()

getStackTrace

public Array<StackTraceElement> getStackTrace()

getSuppressed

public final synchronized Array<Throwable> getSuppressed()

initCause

public synchronized Throwable initCause(Throwable cause)

messageFormat

protected static String messageFormat(String format, Command command)

Builds a formatted string for the passed format and a command.

printStackTrace

public void printStackTrace()

setStackTrace

public void setStackTrace(Array<StackTraceElement> stackTrace)

toString

public String toString()