Class AbstractQueryInterceptor<T,R>

java.lang.Object
io.micronaut.data.runtime.intercept.AbstractQueryInterceptor<T,R>
Type Parameters:
T - The declaring type
R - The return type
All Implemented Interfaces:
DataInterceptor<T,R>
Direct Known Subclasses:
AbstractAsyncInterceptor, AbstractReactiveInterceptor, AbstractSpecificationInterceptor, DefaultAbstractFindPageInterceptor, DefaultCountInterceptor, DefaultDeleteAllInterceptor, DefaultDeleteAllReturningInterceptor, DefaultDeleteOneInterceptor, DefaultDeleteReturningManyAsyncInterceptor, DefaultDeleteReturningManyInterceptor, DefaultDeleteReturningOneInterceptor, DefaultExistsByInterceptor, DefaultFindAllInterceptor, DefaultFindByIdInterceptor, DefaultFindOneInterceptor, DefaultFindOptionalInterceptor, DefaultFindSliceInterceptor, DefaultFindStreamInterceptor, DefaultInsertAllInterceptor, DefaultInsertEntityInterceptor, DefaultInsertOneInterceptor, DefaultInsertReturningManyAsyncInterceptor, DefaultInsertReturningManyInterceptor, DefaultInsertReturningOneInterceptor, DefaultProcedureReturningManyAsyncInterceptor, DefaultProcedureReturningManyInterceptor, DefaultProcedureReturningOneInterceptor, DefaultSaveAllInterceptor, DefaultSaveEntityInterceptor, DefaultSaveOneInterceptor, DefaultUpdateAllEntitiesInterceptor, DefaultUpdateEntityInterceptor, DefaultUpdateInterceptor, DefaultUpdateReturningManyAsyncInterceptor, DefaultUpdateReturningManyInterceptor, DefaultUpdateReturningOneInterceptor, DetachInterceptor, FlushInterceptor, LoadInterceptor, MergeInterceptor, PersistInterceptor, RefreshInterceptor, RemoveInterceptor
public abstract class AbstractQueryInterceptor<T,R> extends Object implements DataInterceptor<T,R>
Abstract interceptor that executes a Query.
Since:
1.0
Author:
graemerocher

  • Field Details

    • conversionService

      protected final io.micronaut.core.convert.ConversionService conversionService

    • operations

      protected final RepositoryOperations operations

    • preparedQueryResolver

      protected final PreparedQueryResolver preparedQueryResolver

  • Constructor Details

    • AbstractQueryInterceptor

      protected AbstractQueryInterceptor(@NonNull RepositoryOperations operations)
      Default constructor.
      Parameters:
      operations - The operations

  • Method Details

    • findRepositoryOperations

      @Internal protected final <O> @Nullable O findRepositoryOperations(@NonNull Class<O> operationsType)
      Finds the requested repository operations from the root operations or one of its async/reactive variants.
      Type Parameters:
      O - The operations type
      Parameters:
      operationsType - The operations type
      Returns:
      The operations, if available
      Since:
      5.0.0

    • getParameterValueMap

      protected @NonNull Map<String,Object> getParameterValueMap(io.micronaut.aop.MethodInvocationContext<?,?> context)
      Returns parameter values with respect of Parameter annotation.
      Parameters:
      context - The method invocation context
      Returns:
      The parameters value map

    • getReturnType

      protected io.micronaut.core.type.Argument<?> getReturnType(io.micronaut.aop.MethodInvocationContext<?,?> context)
      Returns the return type.
      Parameters:
      context - The context
      Returns:
      the return type

    • convertOne

      protected final @Nullable Object convertOne(io.micronaut.aop.MethodInvocationContext<?,?> context, @Nullable Object o)

    • convertOne

      protected final Object convertOne(Object o, io.micronaut.core.type.Argument<?> argumentType)

    • prepareQuery

      protected final <RT> @NonNull PreparedQuery<?,RT> prepareQuery(RepositoryMethodKey methodKey, io.micronaut.aop.MethodInvocationContext<T,R> context)
      Prepares a query for the given context.
      Type Parameters:
      RT - The result generic type
      Parameters:
      methodKey - The method key
      context - The context
      Returns:
      The query

    • prepareCountQuery

      protected final @NonNull PreparedQuery<?,Number> prepareCountQuery(RepositoryMethodKey methodKey, @NonNull io.micronaut.aop.MethodInvocationContext<T,R> context)
      Prepares a query for the given context.
      Parameters:
      methodKey - The method key
      context - The context
      Returns:
      The query

    • getRequiredRootEntity

      protected <E> @NonNull Class<E> getRequiredRootEntity(io.micronaut.aop.MethodInvocationContext context)
      Obtains the root entity or throws an exception if it is not available.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      Returns:
      The root entity type
      Throws:
      IllegalStateException - If the root entity is unavailable

    • getEntityParameter

      protected <RT> RT getEntityParameter(io.micronaut.aop.MethodInvocationContext<?,?> context, @NonNull Class<RT> type)
      Retrieve an entity parameter value in role.
      Type Parameters:
      RT - The generic type
      Parameters:
      context - The context
      type - The type
      Returns:
      An result

    • getEntitiesParameter

      protected <RT> Iterable<RT> getEntitiesParameter(io.micronaut.aop.MethodInvocationContext<?,?> context, @NonNull Class<RT> type)
      Retrieve an entities parameter value in role.
      Type Parameters:
      RT - The generic type
      Parameters:
      context - The context
      type - The type
      Returns:
      An result

    • findEntityParameter

      protected <RT> Optional<RT> findEntityParameter(io.micronaut.aop.MethodInvocationContext<?,?> context, @NonNull Class<RT> type)
      Find an entity parameter value in role.
      Type Parameters:
      RT - The generic type
      Parameters:
      context - The context
      type - The type
      Returns:
      An result

    • findEntitiesParameter

      protected <RT> Optional<Iterable<RT>> findEntitiesParameter(io.micronaut.aop.MethodInvocationContext<?,?> context, @NonNull Class<RT> type)
      Fid an entities parameter value in role.
      Type Parameters:
      RT - The generic type
      Parameters:
      context - The context
      type - The type
      Returns:
      An result

    • getRequiredParameterInRole

      protected <RT> RT getRequiredParameterInRole(io.micronaut.aop.MethodInvocationContext<?,?> context, @NonNull String role, @NonNull Class<RT> type)
      Retrieve a parameter in the given role for the given type.
      Type Parameters:
      RT - The generic type
      Parameters:
      context - The context
      role - The role
      type - The type
      Returns:
      An result

    • getParameterInRole

      protected <RT> Optional<RT> getParameterInRole(io.micronaut.aop.MethodInvocationContext<?,?> context, @NonNull String role, @NonNull Class<RT> type)
      Retrieve a parameter in the given role for the given type.
      Type Parameters:
      RT - The generic type
      Parameters:
      context - The context
      role - The role
      type - The type
      Returns:
      An optional result

    • getParameterInRole

      protected <RT> Optional<RT> getParameterInRole(io.micronaut.aop.MethodInvocationContext<?,?> context, @NonNull String role, @NonNull io.micronaut.core.type.Argument<RT> type)
      Retrieve a parameter in the given role for the given type.
      Type Parameters:
      RT - The generic type
      Parameters:
      context - The context
      role - The role
      type - The type
      Returns:
      An optional result

    • getParametersInRole

      protected <RT> @NonNull List<RT> getParametersInRole(@NonNull io.micronaut.aop.MethodInvocationContext<?,?> context, @NonNull String role, @NonNull Class<RT> type)
      Retrieve a parameter in the given role for the given type.
      Type Parameters:
      RT - The generic type
      Parameters:
      context - The context
      role - The role
      type - The type
      Returns:
      An optional result

    • getParametersInRole

      protected <RT> @NonNull List<RT> getParametersInRole(@NonNull io.micronaut.aop.MethodInvocationContext<?,?> context, @NonNull String role, @NonNull io.micronaut.core.type.Argument<RT> type)
      Retrieve a parameter in the given role for the given type.
      Type Parameters:
      RT - The generic type
      Parameters:
      context - The context
      role - The role
      type - The type
      Returns:
      An optional result

    • hasReturnTypeInRole

      protected boolean hasReturnTypeInRole(@NonNull io.micronaut.aop.MethodInvocationContext<?,?> context, @NonNull String role, @NonNull Class<?> type)
      Check the return role from the method context.
      Parameters:
      context - The method context
      role - The role
      type - The type
      Returns:
      The optional parameter

    • getPageable

      protected @NonNull Pageable getPageable(io.micronaut.aop.MethodInvocationContext<?,?> context)
      Resolves the Pageable for the given context.
      Parameters:
      context - The pageable
      Returns:
      The pageable or null

    • getPageableInRole

      protected @Nullable Pageable getPageableInRole(io.micronaut.aop.MethodInvocationContext<?,?> context)
      Resolves the Pageable for the given context.
      Parameters:
      context - The context
      Returns:
      The pageable or null

    • getOffset

      protected int getOffset(io.micronaut.aop.MethodInvocationContext<?,?> context)
      Resolves the offset.
      Parameters:
      context - The context
      Returns:
      The offset or -1
      Since:
      4.10

    • getLimit

      protected int getLimit(io.micronaut.aop.MethodInvocationContext<?,?> context)
      Resolves the limit.
      Parameters:
      context - The context
      Returns:
      The limit or -1
      Since:
      4.10

    • hasEntityId

      protected final boolean hasEntityId(io.micronaut.aop.MethodInvocationContext<?,?> context, Object entity)
      Whether the entity has a non-null identity value.
      Parameters:
      context - The method invocation context
      entity - The entity instance
      Returns:
      True if the entity has an ID value

    • isEntityUpdateCandidate

      protected final boolean isEntityUpdateCandidate(io.micronaut.aop.MethodInvocationContext<?,?> context, Object entity)
      Whether the entity should be updated instead of inserted.
      Parameters:
      context - The method invocation context
      entity - The entity instance
      Returns:
      True if the entity has enough state to use the update query

    • isSaveAsInsert

      protected final boolean isSaveAsInsert()
      Returns:
      Whether save methods should always perform insert operations.

    • isSaveAssignedIdFallbackToUpdate

      protected final boolean isSaveAssignedIdFallbackToUpdate()
      Returns:
      Whether save should fall back to update when insert detects an existing assigned-ID entity.

    • resolveSaveOperation

      protected final AbstractQueryInterceptor.SaveOperation resolveSaveOperation(io.micronaut.aop.MethodInvocationContext<?,?> context, Object entity)
      Resolve whether save should insert or update the entity.
      Parameters:
      context - The method invocation context
      entity - The entity instance
      Returns:
      The selected save operation

    • persistOrUpdate

      protected final <E> E persistOrUpdate(io.micronaut.aop.MethodInvocationContext<T,?> context, E entity)
      Persists a new entity, or updates an entity that already has an identity.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The method invocation context
      entity - The entity
      Returns:
      The persisted or updated entity

    • persistWithUpdateFallback

      protected final <E> E persistWithUpdateFallback(io.micronaut.aop.MethodInvocationContext<T,?> context, E entity)
      Persists the entity and falls back to update when the configured exception conversion identifies that the insert failed because the entity already exists.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The method invocation context
      entity - The entity
      Returns:
      The persisted or updated entity

    • isEntityExistsException

      protected final boolean isEntityExistsException(io.micronaut.aop.MethodInvocationContext<?,?> context, RuntimeException exception)

    • unwrapCompletionException

      protected final Throwable unwrapCompletionException(Throwable throwable)

    • propagate

      protected final RuntimeException propagate(Throwable throwable)

    • getRequiredEntity

      protected @NonNull Object getRequiredEntity(io.micronaut.aop.MethodInvocationContext<T,?> context)
      Looks up the entity to persist from the execution context, or throws an exception.
      Parameters:
      context - The context
      Returns:
      The entity

    • instantiateEntity

      protected @NonNull Object instantiateEntity(@NonNull Class<?> rootEntity, @NonNull Map<String,Object> parameterValues)
      Instantiate the given entity for the given parameter values.
      Parameters:
      rootEntity - The entity
      parameterValues - The parameter values
      Returns:
      The entity
      Throws:
      IllegalArgumentException - if the entity cannot be instantiated due to an illegal argument

    • getPagedQuery

      protected <E> @NonNull PagedQuery<E> getPagedQuery(@NonNull io.micronaut.aop.MethodInvocationContext context)
      Get the paged query for the given context.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      Returns:
      The paged query

    • getInsertBatchOperation

      protected <E> @NonNull InsertBatchOperation<E> getInsertBatchOperation(@NonNull io.micronaut.aop.MethodInvocationContext context, @NonNull Iterable<E> iterable)
      Get the insert batch operation for the given context.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      iterable - The iterable
      Returns:
      The paged query

    • getInsertBatchOperation

      protected <E> @NonNull InsertBatchOperation<E> getInsertBatchOperation(@NonNull io.micronaut.aop.MethodInvocationContext context, Class<E> rootEntity, @NonNull Iterable<E> iterable)
      Get the insert batch operation for the given context.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      rootEntity - The root entity
      iterable - The iterable
      Returns:
      The paged query

    • getInsertOperation

      protected <E> @NonNull InsertOperation<E> getInsertOperation(@NonNull io.micronaut.aop.MethodInvocationContext context)
      Get the batch operation for the given context.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      Returns:
      The paged query

    • getUpdateOperation

      protected <E> @NonNull UpdateOperation<E> getUpdateOperation(@NonNull io.micronaut.aop.MethodInvocationContext<T,?> context)
      Get the batch operation for the given context.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      Returns:
      The paged query

    • getUpdateOperation

      protected <E> @NonNull UpdateOperation<E> getUpdateOperation(@NonNull io.micronaut.aop.MethodInvocationContext<T,?> context, E entity)
      Get the batch operation for the given context.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      entity - The entity instance
      Returns:
      The paged query

    • getUpdateAllBatchOperation

      protected <E> @NonNull UpdateBatchOperation<E> getUpdateAllBatchOperation(@NonNull io.micronaut.aop.MethodInvocationContext<T,?> context, Class<E> rootEntity, @NonNull Iterable<E> iterable)
      Get the update all batch operation for the given context.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      rootEntity - The root entitry
      iterable - The iterable
      Returns:
      The paged query

    • getDeleteOperation

      protected <E> @NonNull DeleteOperation<E> getDeleteOperation(@NonNull io.micronaut.aop.MethodInvocationContext<T,?> context, @NonNull E entity)
      Get the delete operation for the given context.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      entity - The entity
      Returns:
      The paged query

    • getDeleteReturningOperation

      protected <E,K> @NonNull DeleteReturningOperation<E,K> getDeleteReturningOperation(@NonNull io.micronaut.aop.MethodInvocationContext<T,?> context, @NonNull E entity)
      Get the delete operation for the given context.
      Type Parameters:
      E - The entity type
      K - The result type
      Parameters:
      context - The context
      entity - The entity
      Returns:
      The paged query

    • getDeleteAllBatchOperation

      protected <E> @NonNull DeleteBatchOperation<E> getDeleteAllBatchOperation(@NonNull io.micronaut.aop.MethodInvocationContext<T,?> context)
      Get the delete all batch operation for the given context.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      Returns:
      The paged query

    • getDeleteBatchOperation

      protected <E> @NonNull DeleteBatchOperation<E> getDeleteBatchOperation(@NonNull io.micronaut.aop.MethodInvocationContext<T,?> context, @NonNull Iterable<E> iterable)
      Get the delete batch operation for the given context.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      iterable - The iterable
      Returns:
      The paged query

    • getDeleteReturningBatchOperation

      protected <E,K> @NonNull DeleteReturningBatchOperation<E,K> getDeleteReturningBatchOperation(@NonNull io.micronaut.aop.MethodInvocationContext<T,?> context, @NonNull Iterable<E> iterable)
      Get the delete returning batch operation for the given context.
      Type Parameters:
      E - The entity type
      K - The result type
      Parameters:
      context - The context
      iterable - The iterable
      Returns:
      The paged query

    • getDeleteBatchOperation

      protected <E> @NonNull DeleteBatchOperation<E> getDeleteBatchOperation(@NonNull io.micronaut.aop.MethodInvocationContext<T,?> context, Class<E> rootEntity, @NonNull Iterable<E> iterable)
      Get the delete batch operation for the given context.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      rootEntity - The root entity
      iterable - The iterable
      Returns:
      The paged query

    • getInsertOperation

      protected <E> @NonNull InsertOperation<E> getInsertOperation(@NonNull io.micronaut.aop.MethodInvocationContext<T,?> context, E entity)
      Get the batch operation for the given context.
      Type Parameters:
      E - The entity type
      Parameters:
      context - The context
      entity - The entity
      Returns:
      The paged query

    • validateNullArguments

      protected final void validateNullArguments(io.micronaut.aop.MethodInvocationContext<?,?> context)
      Validates null arguments ensuring no argument is null unless declared so.
      Parameters:
      context - The context

    • count

      protected int count(Iterable<?> iterable)
      Count the items.
      Parameters:
      iterable - the iterable
      Returns:
      the size

    • isNumber

      protected boolean isNumber(@Nullable Class<?> type)
      Is the type a number.
      Parameters:
      type - The type
      Returns:
      True if is a number