Class IpfAtnaConfigurationProperties

java.lang.Object
org.openehealth.ipf.boot.atna.IpfAtnaConfigurationProperties
@ConfigurationProperties(prefix="ipf.atna") public class IpfAtnaConfigurationProperties extends Object

  • Constructor Details

    • IpfAtnaConfigurationProperties

      public IpfAtnaConfigurationProperties()

  • Method Details

    • isAuditEnabled

      public boolean isAuditEnabled()

    • setAuditEnabled

      public void setAuditEnabled(boolean auditEnabled)

    • getAuditSourceType

      public AuditSource getAuditSourceType()

    • setAuditSourceType

      public void setAuditSourceType(AuditSource auditSourceType)

    • getAuditSourceId

      public String getAuditSourceId()

    • setAuditSourceId

      public void setAuditSourceId(String auditSourceId)

    • getAuditSendingApplication

      public String getAuditSendingApplication()

    • setAuditSendingApplication

      public void setAuditSendingApplication(String auditSendingApplication)

    • getRequestIdHeaderNames

      public List<String> getRequestIdHeaderNames()
      Names of the HTTP headers that may carry the id correlating the audit records the two ends of a transaction write about it, most preferred first. The first header a request actually carries wins; empty disables the lookup.

      IHE BALP asks for X-Request-Id and reports it as the transaction entity of an AuditEvent. A deployment that already propagates a trace can name its headers instead: "traceparent" for W3C Trace Context, or "b3" and "X-B3-TraceId" for the single-header and multi-header flavours of B3 (naming both accepts whichever a caller uses; they yield the same id).

    • setRequestIdHeaderNames

      public void setRequestIdHeaderNames(List<String> requestIdHeaderNames)
      Names of the HTTP headers that may carry the id correlating the audit records the two ends of a transaction write about it, most preferred first. The first header a request actually carries wins; empty disables the lookup.

      IHE BALP asks for X-Request-Id and reports it as the transaction entity of an AuditEvent. A deployment that already propagates a trace can name its headers instead: "traceparent" for W3C Trace Context, or "b3" and "X-B3-TraceId" for the single-header and multi-header flavours of B3 (naming both accepts whichever a caller uses; they yield the same id).

    • getRequestIdType

      public ParticipantObjectIdTypeCode getRequestIdType()
      Participant object ID type to record the correlation id under, whichever header it was found in. Leave unset and the type follows the header, so that the DICOM audit record says which propagation format the id came from: XRequestId, W3cTraceContext, B3SingleHeader or B3MultiHeader. Set it only to flatten that distinction, e.g. for a repository that understands XRequestId alone.

    • setRequestIdType

      public void setRequestIdType(ParticipantObjectIdTypeCode requestIdType)
      Participant object ID type to record the correlation id under, whichever header it was found in. Leave unset and the type follows the header, so that the DICOM audit record says which propagation format the id came from: XRequestId, W3cTraceContext, B3SingleHeader or B3MultiHeader. Set it only to flatten that distinction, e.g. for a repository that understands XRequestId alone.

    • getAuditRepositoryTransport

      public String getAuditRepositoryTransport()
      Sets the Audit transport (UDP, TLS)

    • setAuditRepositoryTransport

      public void setAuditRepositoryTransport(String auditRepositoryTransport)
      Sets the Audit transport (UDP, TLS)

    • getAuditRepositoryHost

      public String getAuditRepositoryHost()
      Sets the host of the audit repository. Deprecated, set ipf.atna.audit-repository-host

    • setAuditRepositoryHost

      public void setAuditRepositoryHost(String auditRepositoryHost)
      Sets the host of the audit repository. Deprecated, set ipf.atna.audit-repository-host

    • getAuditRepositoryPort

      public int getAuditRepositoryPort()
      Sets the port of the audit repository. Deprecated, set ipf.atna.audit-repository-port

    • setAuditRepositoryPort

      public void setAuditRepositoryPort(int auditRepositoryPort)
      Sets the port of the audit repository. Deprecated, set ipf.atna.audit-repository-port

    • getAuditEnterpriseSiteId

      public String getAuditEnterpriseSiteId()
      Enterprise Site Id

    • setAuditEnterpriseSiteId

      public void setAuditEnterpriseSiteId(String auditEnterpriseSiteId)
      Enterprise Site Id

    • getAuditQueueClass

      public Class<? extends AuditMessageQueue> getAuditQueueClass()
      Sets the Audit Message Queue class to be used for sending ATNA records

    • setAuditQueueClass

      public void setAuditQueueClass(Class<? extends AuditMessageQueue> auditQueueClass)
      Sets the Audit Message Queue class to be used for sending ATNA records

    • getAuditMessagePostProcessorClass

      public Class<? extends AuditMessagePostProcessor> getAuditMessagePostProcessorClass()
      Sets the Audit Message Postprocessor class

    • setAuditMessagePostProcessorClass

      public void setAuditMessagePostProcessorClass(Class<? extends AuditMessagePostProcessor> auditMessagePostProcessorClass)
      Sets the Audit Message Postprocessor class

    • getAuditSenderClass

      public Class<? extends AuditTransmissionProtocol> getAuditSenderClass()
      Sets the Audit Sender class to be used for sending ATNA records

    • setAuditSenderClass

      public void setAuditSenderClass(Class<? extends AuditTransmissionProtocol> auditSenderClass)
      Sets the Audit Sender class to be used for sending ATNA records

    • getAuditExceptionHandlerClass

      public Class<? extends AuditExceptionHandler> getAuditExceptionHandlerClass()
      Sets the exception handler in case auditing fails

    • setAuditExceptionHandlerClass

      public void setAuditExceptionHandlerClass(Class<? extends AuditExceptionHandler> auditExceptionHandlerClass)
      Sets the exception handler in case auditing fails

    • isIncludeParticipantsFromResponse

      public boolean isIncludeParticipantsFromResponse()

    • setIncludeParticipantsFromResponse

      public void setIncludeParticipantsFromResponse(boolean includeParticipantsFromResponse)

    • getAuditValueIfMissing

      public String getAuditValueIfMissing()

    • setAuditValueIfMissing

      public void setAuditValueIfMissing(String auditValueIfMissing)

    • isSpringAuditEventEnabled

      public boolean isSpringAuditEventEnabled()

    • setSpringAuditEventEnabled

      public void setSpringAuditEventEnabled(boolean springAuditEventEnabled)

    • getWsAuditDatasetEnricherClass

      public Class<? extends WsAuditDatasetEnricher> getWsAuditDatasetEnricherClass()
      Class of the optional audit dataset enricher for Web Service based transactions.

    • setWsAuditDatasetEnricherClass

      public void setWsAuditDatasetEnricherClass(Class<? extends WsAuditDatasetEnricher> wsAuditDatasetEnricherClass)
      Class of the optional audit dataset enricher for Web Service based transactions.

    • getFhirAuditDatasetEnricherClass

      public Class<? extends FhirAuditDatasetEnricher> getFhirAuditDatasetEnricherClass()
      Class of the optional audit dataset enricher for FHIR based transactions.

    • setFhirAuditDatasetEnricherClass

      public void setFhirAuditDatasetEnricherClass(Class<? extends FhirAuditDatasetEnricher> fhirAuditDatasetEnricherClass)
      Class of the optional audit dataset enricher for FHIR based transactions.

    • getBalp

      public IpfAtnaConfigurationProperties.Balp getBalp()

    • setBalp

      public void setBalp(IpfAtnaConfigurationProperties.Balp balp)