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 Details

    • 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_OPERATION_TARGET_POSTINVOKE

      public static final CdrPointcut FHIRGW_OPERATION_TARGET_POSTINVOKE
      FHIR Gateway Hook: This hook is called when the FHIR Gateway has finished invoking a FHIR extended operation operation against an individual target server. This hook is called once for each target that has been called, so if a single client operation 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. This may be empty in the case of operations which do not return search results. Some operations, such as $everything, will return search results, but others such as $ 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.
      • OperationResponse - This object contains the Operation Response from the individual Gateway Target that was called. Interceptors may modify this object in any way they want. This may be null if the operation returns a Bundle (check the SearchResultsAccumulator instead).

      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:

      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:

      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.

    • FHIRGW_CREATE_TARGET_PREINVOKE

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

      For creates where a client id is specified, the update hook will be fired instead.

      Hooks may accept the following parameters:

      • CreateRequest - The create 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_UPDATE_TARGET_PREINVOKE

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

      This hook will also be called for create operations when a client id is provided.

      Hooks may accept the following parameters:

      • UpdateRequest - The update 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_DELETE_TARGET_PREINVOKE

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

      Hooks may accept the following parameters:

      • DeleteRequest - The delete 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.

    • SERVER_CONFIGURATION_KEYSTORE

      public static final CdrPointcut SERVER_CONFIGURATION_KEYSTORE
      Endpoint Hook: The pointcut provides the capability to supply a provisioned KeyStore file for TLS base encryption. Note that pointcut SERVER_CONFIGURATION_KEYSTORE is invoked only if the endpoint listener is said to required TLS encryption for incoming connections through environment property tls.enabled

      Hooks may accept the following parameters:

      • - The keystore password

      Hook methods must return KeyStore.

  • Method Details