org.axonframework.commandhandling.model.inspection

Class ModelInspector<T>

java.lang.Object

org.axonframework.commandhandling.model.inspection.ModelInspector<T>

Type Parameters:

T - the target type of the inspector

All Implemented Interfaces:

AggregateModel<T>, EntityModel<T>

public class ModelInspector<T>
extends Object
implements AggregateModel<T>

Inspector of an entity of type T that creates command and event handlers that delegate to a target entity and its child entities.

Method Summary

Modifier and Type	Method and Description
MessageHandlingMember<? super T>	commandHandler(String commandName) Get the MessageHandlingMember capable of handling commands with given commandName (see CommandMessage.getCommandName()).
Map<String,MessageHandlingMember<? super T>>	commandHandlers() Get a mapping of MessageHandlingMember to command name (obtained via CommandMessage.getCommandName()).
protected Optional<MessageHandlingMember<? super T>>	getHandler(Message<?> message) Returns the MessageHandlingMember that is capable of handling the given message.
Object	getIdentifier(T target) Get the identifier of the given target entity.
Long	getVersion(T target) Get the current version number of the given aggregate.
static <AT> AggregateModel<AT>	inspectAggregate(Class<AT> aggregateType) Create an inspector for given aggregateType that uses a ClasspathParameterResolverFactory to resolve method parameters.
static <T> AggregateModel<T>	inspectAggregate(Class<T> aggregateType, ParameterResolverFactory parameterResolverFactory) Create an inspector for given aggregateType that uses given parameterResolverFactory to resolve method parameters.
<C> ModelInspector<C>	modelOf(Class<? extends C> entityType) Get the EntityModel of an entity of type childEntityType in case it is the child of the modeled entity.
void	publish(EventMessage<?> message, T target) Publish given event message on the given target entity.
String	routingKey() Get the name of the routing key property on commands and events that provides the identifier that should be used to target entities of this kind.
String	type() Get the String representation of the modeled aggregate's type.

Methods inherited from class java.lang.Object

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

Method Detail

inspectAggregate

public static <AT> AggregateModel<AT> inspectAggregate(Class<AT> aggregateType)

Create an inspector for given aggregateType that uses a ClasspathParameterResolverFactory to resolve method parameters.

Type Parameters:

AT - the aggregate's type

Parameters:

aggregateType - the target aggregate type

Returns:

a new inspector instance for the inspected class

inspectAggregate

public static <T> AggregateModel<T> inspectAggregate(Class<T> aggregateType,
                                                     ParameterResolverFactory parameterResolverFactory)

Create an inspector for given aggregateType that uses given parameterResolverFactory to resolve method parameters.

Type Parameters:

T - the aggregate's type

Parameters:

aggregateType - the target aggregate type

parameterResolverFactory - the resolver factory to use during detection

Returns:

a new inspector instance for the inspected class

commandHandlers

public Map<String,MessageHandlingMember<? super T>> commandHandlers()

Description copied from interface: EntityModel

Get a mapping of MessageHandlingMember to command name (obtained via CommandMessage.getCommandName()).

Specified by:

commandHandlers in interface EntityModel<T>

Returns:

Map of message handler to command name

commandHandler

public MessageHandlingMember<? super T> commandHandler(String commandName)

Description copied from interface: EntityModel

Get the MessageHandlingMember capable of handling commands with given commandName (see CommandMessage.getCommandName()). If the entity is not capable of handling such commands an exception is raised.

Specified by:

commandHandler in interface EntityModel<T>

Parameters:

commandName - The name of the command

Returns:

The handler for the command

modelOf

public <C> ModelInspector<C> modelOf(Class<? extends C> entityType)

Description copied from interface: EntityModel

Get the EntityModel of an entity of type childEntityType in case it is the child of the modeled entity.

Specified by:

modelOf in interface EntityModel<T>

Type Parameters:

C - the type of the child entity

Parameters:

entityType - The class instance of the child entity type

Returns:

An EntityModel for the child entity

publish

public void publish(EventMessage<?> message,
                    T target)

Description copied from interface: EntityModel

Publish given event message on the given target entity.

Specified by:

publish in interface EntityModel<T>

Parameters:

message - The event message to publish

target - The target entity for the event

type

public String type()

Description copied from interface: AggregateModel

Get the String representation of the modeled aggregate's type. This defaults to the simple name of the aggregate's type.

Specified by:

type in interface AggregateModel<T>

Returns:

The type of the aggregate

getVersion

public Long getVersion(T target)

Description copied from interface: AggregateModel

Get the current version number of the given aggregate. For event sourced aggregates this is identical to the sequence number of the last applied event.

Specified by:

getVersion in interface AggregateModel<T>

Parameters:

target - The target aggregate root instance

Returns:

The current version of the aggregate

getHandler

protected Optional<MessageHandlingMember<? super T>> getHandler(Message<?> message)

Returns the MessageHandlingMember that is capable of handling the given message. If no member is found an empty optional is returned.

Parameters:

message - the message to find a handler for

Returns:

the handler of the message if present on the model

getIdentifier

public Object getIdentifier(T target)

Description copied from interface: EntityModel

Get the identifier of the given target entity.

Specified by:

getIdentifier in interface EntityModel<T>

Parameters:

target - The entity instance

Returns:

The identifier of the given target entity

routingKey

public String routingKey()

Description copied from interface: EntityModel

Get the name of the routing key property on commands and events that provides the identifier that should be used to target entities of this kind.

Specified by:

routingKey in interface EntityModel<T>

Returns:

The name of the routing key that holds the identifier used to target this sort of entity