io.spine.server.commandbus

Class InvalidCommandException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.spine.server.commandbus.CommandException

io.spine.server.commandbus.InvalidCommandException

All Implemented Interfaces:

java.io.Serializable

public class InvalidCommandException
extends CommandException

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.

See Also:

Serialized Form

Field Summary

Fields inherited from class io.spine.server.commandbus.CommandException

ATTR_COMMAND_TYPE_NAME

Method Summary

Modifier and Type	Method and Description
static InvalidCommandException	inapplicableTenantId(io.spine.core.Command command) Creates an exception for the command which specifies a tenant in a single-tenant context.
static InvalidCommandException	missingTenantId(io.spine.core.Command command) Creates an exception for a command with missing tenant_id attribute in the CommandContext which is required in a multitenant application.
static InvalidCommandException	onConstraintViolations(io.spine.core.Command command, java.lang.Iterable<io.spine.validate.ConstraintViolation> violations) Creates an exception instance for a command message, which has fields that violate validation constraint(s).
static io.spine.base.Error	unknownTenantError(com.google.protobuf.Message commandMessage, java.lang.String errorText) Creates an error for a command with missing tenant_id attribute in the CommandContext which is required in a multitenant application.

Methods inherited from class io.spine.server.commandbus.CommandException

asError, asThrowable, commandTypeAttribute, createError, getCommand, messageFormat

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

onConstraintViolations

public static InvalidCommandException onConstraintViolations(io.spine.core.Command command,
                                                             java.lang.Iterable<io.spine.validate.ConstraintViolation> violations)

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

Parameters:

command - an invalid command

violations - constraint violations for the command message

missingTenantId

public static InvalidCommandException missingTenantId(io.spine.core.Command command)

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

unknownTenantError

public static io.spine.base.Error unknownTenantError(com.google.protobuf.Message commandMessage,
                                                     java.lang.String errorText)

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

inapplicableTenantId

public static InvalidCommandException inapplicableTenantId(io.spine.core.Command command)

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