Class IpfFhirStreamingUploadAutoConfiguration

java.lang.Object

org.openehealth.ipf.boot.fhir.IpfFhirStreamingUploadAutoConfiguration

@Configuration
@ConditionalOnWebApplication
@ConditionalOnProperty(prefix="ipf.fhir.streaming-upload",
                       name="enabled")
@AutoConfigureAfter(IpfFhirAutoConfiguration.class)
@EnableConfigurationProperties(IpfFhirConfigurationProperties.class)
public class IpfFhirStreamingUploadAutoConfiguration
extends Object

Registers the Base64SplittingFilter, which streams the document content of a large FHIR upload past the FHIR parser instead of letting it materialize on the heap.

This is the runtime half of the bridge to the split: the split itself knows nothing about Spring, about configuration properties or about metrics, so everything it needs is assembled here. Two pieces of that are deployment specific and can be contributed as beans:

• a StreamedDocumentListener, to meter the split - the filter answers to it without having to know about any particular metrics library
• a UnaryOperator<String> named STREAMING_UPLOAD_DIAGNOSTICS_POLICY, applied to the diagnostics of a rejection before it is sent. The filter answers a rejected upload itself and therefore bypasses whatever the FHIR servlet's interceptors would have applied, so an application that does not disclose error details to its clients has to redact them here as well.

The filter is off unless ipf.fhir.streaming-upload.enabled is set; when off, it is not registered at all.

Author:

Christian Ohr

See Also:

• IpfFhirConfigurationProperties.StreamingUpload

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILTER_NAME	Name under which the filter is registered.
static final String	STREAMING_UPLOAD_DIAGNOSTICS_POLICY	Bean name of the UnaryOperator<String> that the filter applies to the diagnostics of a rejection.

Constructor Summary

Constructors

Constructor	Description
IpfFhirStreamingUploadAutoConfiguration()

Method Summary

Modifier and Type	Method	Description
org.springframework.boot.web.servlet.FilterRegistrationBean<Base64SplittingFilter>	base64SplittingFilterRegistration(IpfFhirConfigurationProperties config, FhirContext fhirContext, ObjectProvider<StreamedDocumentListener> listener, ObjectProvider<UnaryOperator<String>> diagnosticsPolicy)

Methods inherited from class Object

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

Field Details

STREAMING_UPLOAD_DIAGNOSTICS_POLICY

public static final String STREAMING_UPLOAD_DIAGNOSTICS_POLICY

Bean name of the UnaryOperator<String> that the filter applies to the diagnostics of a rejection.

See Also:

• Constant Field Values

FILTER_NAME

public static final String FILTER_NAME

Name under which the filter is registered.

See Also:

• Constant Field Values

Constructor Details

IpfFhirStreamingUploadAutoConfiguration

public IpfFhirStreamingUploadAutoConfiguration()

Method Details

base64SplittingFilterRegistration

@Bean
@ConditionalOnMissingBean(name="base64SplittingFilterRegistration")
public org.springframework.boot.web.servlet.FilterRegistrationBean<Base64SplittingFilter> base64SplittingFilterRegistration(IpfFhirConfigurationProperties config,
 FhirContext fhirContext,
 ObjectProvider<StreamedDocumentListener> listener,
 @Qualifier("streamingUploadDiagnosticsPolicy")
 ObjectProvider<UnaryOperator<String>> diagnosticsPolicy)