Package ca.cdr.api.fhir.interceptor

Enum CdrPointcut

java.lang.Object

java.lang.Enum<CdrPointcut>

ca.cdr.api.fhir.interceptor.CdrPointcut

All Implemented Interfaces:

IPointcut, Serializable, Comparable<CdrPointcut>

public enum CdrPointcut
extends Enum<CdrPointcut>
implements IPointcut

Value for CdrHook.value()

Hook pointcuts are divided into several broad categories:

• FHIRGW_xxx: Hooks on the FHIR Gateway module

Enum Constant Summary

Enum Constants

Enum Constant	Description
FHIRGW_OPERATION_TARGET_PREINVOKE	FHIR Gateway Hook: This hook is called when the FHIR Gateway is about to invoke a FHIR operation operation against an individual target server.
FHIRGW_READ_TARGET_PREINVOKE	FHIR Gateway Hook: This hook is called when the FHIR Gateway is about to invoke a FHIR read or vread operation against an individual target server.
FHIRGW_SEARCH_PAGE_TARGET_PREINVOKE	FHIR Gateway Hook: This hook is called when the FHIR Gateway is about to invoke a FHIR search paging operation against an individual target server.
FHIRGW_SEARCH_TARGET_POSTINVOKE	FHIR Gateway Hook: This hook is called when the FHIR Gateway has finished invoking a FHIR search operation against an individual target server.
FHIRGW_SEARCH_TARGET_PREINVOKE	FHIR Gateway Hook: This hook is called when the FHIR Gateway is about to invoke a FHIR search operation against an individual target server.

Method Summary

Modifier and Type	Method	Description
List<String>	getParameterTypes()
Class<?>	getReturnType()
boolean	isShouldLogAndSwallowException(Throwable theException)
static CdrPointcut	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CdrPointcut[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.interceptor.api.IPointcut

name

Enum Constant Detail

FHIRGW_READ_TARGET_PREINVOKE

public static final CdrPointcut FHIRGW_READ_TARGET_PREINVOKE

FHIR Gateway Hook: This hook is called when the FHIR Gateway is about to invoke a FHIR read or vread operation against an individual target server. This hook is called once for each target that will be called, so if a single client read is being multicasted against two target servers, this hook will be invoked twice.

Hooks may accept the following parameters:

• ReadRequest - The read that is about to be invoked. The hook method can modify this request, and modifications will affect the operation that is actually performed against the target server.
• GatewayTargetJson - The gateway target server definition. Hook methods should not modify this object, and any changes will be ignored.
• ServletRequestDetails - A bean containing details about the request that is about to be processed.

Hook methods must return void.

FHIRGW_OPERATION_TARGET_PREINVOKE

public static final CdrPointcut FHIRGW_OPERATION_TARGET_PREINVOKE

FHIR Gateway Hook: This hook is called when the FHIR Gateway is about to invoke a FHIR operation operation against an individual target server.

Hooks may accept the following parameters:

• OperationRequest - The read that is about to be invoked. The hook method can modify this request, and modifications will affect the operation that is actually performed against the target server.
• GatewayTargetJson - The gateway target server definition. Hook methods should not modify this object, and any changes will be ignored.
• ServletRequestDetails - A bean containing details about the request that is about to be processed.

Hook methods must return void.

FHIRGW_SEARCH_TARGET_PREINVOKE

public static final CdrPointcut FHIRGW_SEARCH_TARGET_PREINVOKE

FHIR Gateway Hook: This hook is called when the FHIR Gateway is about to invoke a FHIR search operation against an individual target server. This hook is called once for each target that will be called, so if a single client search is being multicasted against two target servers, this hook will be invoked twice.

This hook can be contrasted with FHIRGW_SEARCH_PAGE_TARGET_PREINVOKE:

• FHIRGW_SEARCH_TARGET_PREINVOKE is called before the initial search is performed (which should return search results as well as paging links)
• FHIRGW_SEARCH_PAGE_TARGET_PREINVOKE is called before the subsequent pages of results are fetched

Hooks may accept the following parameters:

• SearchRequest - The search that is about to be invoked. The hook method can modify this request, and modifications will affect the operation that is actually performed against the target server.
• GatewayTargetJson - The gateway target server definition. Hook methods should not modify this object, and any changes will be ignored.
• SearchResultsAccumulator - The accumulator being used to collect the search results so far. Hook methods may use this object to inspect results recieved by other endpoints when searching in serial mode, and can modify the results as needed.
• ServletRequestDetails - A bean containing details about the request that is about to be processed.

Hook methods must return void.

FHIRGW_SEARCH_PAGE_TARGET_PREINVOKE

public static final CdrPointcut FHIRGW_SEARCH_PAGE_TARGET_PREINVOKE

FHIR Gateway Hook: This hook is called when the FHIR Gateway is about to invoke a FHIR search paging operation against an individual target server. This hook is called once for each target that will be called, so if a single client search is being multicasted against two target servers, this hook will be invoked twice.

This hook can be contrasted with FHIRGW_SEARCH_TARGET_PREINVOKE:

• FHIRGW_SEARCH_TARGET_PREINVOKE is called before the initial search is performed (which should return search results as well as paging links)
• FHIRGW_SEARCH_PAGE_TARGET_PREINVOKE is called before the subsequent pages of results are fetched

Hooks may accept the following parameters:

• SearchPageRequest - The search that is about to be invoked. The hook method can modify this request, and modifications will affect the operation that is actually performed against the target server.
• GatewayTargetJson - The gateway target server definition. Hook methods should not modify this object, and any changes will be ignored.
• SearchResultsAccumulator - The accumulator being used to collect the search results so far. Hook methods may use this object to inspect results received by other endpoints when searching in serial mode, and can modify the results as needed.
• ServletRequestDetails - A bean containing details about the request that is about to be processed.

Hook methods must return void.

FHIRGW_SEARCH_TARGET_POSTINVOKE

public static final CdrPointcut FHIRGW_SEARCH_TARGET_POSTINVOKE

FHIR Gateway Hook: This hook is called when the FHIR Gateway has finished invoking a FHIR search operation against an individual target server. This hook is called once for each target that has been called, so if a single client search is being multicasted against two target servers, this hook will be invoked twice.

Hooks may accept the following parameters:

• GatewayTargetJson - The gateway target server definition. Hook methods should not modify this object, and any changes will be ignored.
• SearchResultsAccumulator - The accumulator being used to collect the search results so far. Hook methods may use this object to inspect results received by other endpoints when searching in serial mode, and can modify the results as needed. Note that the FHIRGW_SEARCH_TARGET_POSTINVOKE pointcut is invoked once for each gateway target, before the search results are added to the accumulator. Results from the current target are found in the SearchResponse object, and will be moved from that object into the accumulator after this pointcut is complete.
• SearchResponse - This object contains the search results from the individual Gateway Target that was called. Interceptors may modify this object in any way they want.

Hook methods must return void.

Method Detail

values

public static CdrPointcut[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CdrPointcut c : CdrPointcut.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CdrPointcut valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isShouldLogAndSwallowException

public boolean isShouldLogAndSwallowException(@Nonnull
                                              Throwable theException)

Specified by:

isShouldLogAndSwallowException in interface IPointcut

getReturnType

@Nonnull
public Class<?> getReturnType()

Specified by:

getReturnType in interface IPointcut

getParameterTypes

@Nonnull
public List<String> getParameterTypes()

Specified by:

getParameterTypes in interface IPointcut