Package ca.uhn.fhir.jpa.subscription.util

Class SubscriptionRulesInterceptor

java.lang.Object

ca.uhn.fhir.jpa.subscription.util.SubscriptionRulesInterceptor

public class SubscriptionRulesInterceptor
extends Object

This interceptor enforces various rules on Subscriptions, preventing them from being registered if they don't meet the configured requirements.

Since:

8.2.0

See Also:

• addAllowedCriteriaPattern(String)
• setValidateRestHookEndpointIsReachable(boolean)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CRITERIA_WITH_AT_LEAST_ONE_PARAM

Constructor Summary

Constructors

Constructor	Description
SubscriptionRulesInterceptor(ca.uhn.fhir.context.FhirContext theFhirContext, SubscriptionSettings theSubscriptionSettings)

Method Summary

Modifier and Type	Method	Description
void	addAllowedCriteriaPattern(String theAllowedCriteriaPattern)	Specifies a regular expression pattern which any Subscription (or SubscriptionTopic on R5+) must match.
void	setValidateRestHookEndpointIsReachable(boolean theValidateRestHookEndpointIsReachable)	If true, Subscriptions with a type of "rest-hook" will be tested to ensure that the endpoint is accessible.
void	validateCreate(org.hl7.fhir.instance.model.api.IBaseResource theResource)
void	validateUpdate(org.hl7.fhir.instance.model.api.IBaseResource theOldResource, org.hl7.fhir.instance.model.api.IBaseResource theResource)

Methods inherited from class java.lang.Object

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

Field Details

CRITERIA_WITH_AT_LEAST_ONE_PARAM

public static final String CRITERIA_WITH_AT_LEAST_ONE_PARAM

See Also:

• Constant Field Values

Constructor Details

SubscriptionRulesInterceptor

public SubscriptionRulesInterceptor(@Nonnull
 ca.uhn.fhir.context.FhirContext theFhirContext,
 @Nonnull
 SubscriptionSettings theSubscriptionSettings)

Method Details

addAllowedCriteriaPattern

public void addAllowedCriteriaPattern(@Nonnull
 String theAllowedCriteriaPattern)

Specifies a regular expression pattern which any Subscription (or SubscriptionTopic on R5+) must match. If more than one pattern is supplied, the pattern must match at least one pattern to be accepted, but does not need to match all of them.

setValidateRestHookEndpointIsReachable

public void setValidateRestHookEndpointIsReachable(boolean theValidateRestHookEndpointIsReachable)

If true, Subscriptions with a type of "rest-hook" will be tested to ensure that the endpoint is accessible. If it is not, the subscription will be blocked.

validateCreate

public void validateCreate(org.hl7.fhir.instance.model.api.IBaseResource theResource)

validateUpdate

public void validateUpdate(org.hl7.fhir.instance.model.api.IBaseResource theOldResource,
 org.hl7.fhir.instance.model.api.IBaseResource theResource)