Package ca.cdr.api.fhirgw.svc

Interface IFhirEndpointGatewayTarget

public interface IFhirEndpointGatewayTarget

Method Summary

Modifier and Type	Method	Description
String	getBaseUrl()	Return the base URL for the server
List<String>	getHeadersToForward()	Get headers to be copied from the incoming client request and added to requests to the target server
String	getId()	Fetch the ID for this target
String	getResourceIdPrefix()	Provides a prefix to prepend to resource IDs
String	getTargetFixedUrl()	If the downstream target uses a fixed endpoint URL which does not match the defined {@link this#getBaseUrl()}, set this value to the target's Fixed URL in order to have gateway trust bundle links which originate from this URL.
MethodOutcome	invokeCreate(CreateRequest theRequest, ServletRequestDetails theRequestDetails)	Invoked to perform a fhir CREATE operation
MethodOutcome	invokeDelete(DeleteRequest theRequest, ServletRequestDetails theRequestDetails)	Invoked to perform a fhir delete operation
String	invokeGraphQLOperation(OperationRequest theRequest, String theGraphQLQuery)	Invoked to perform a GraphQL operation
OperationResponse	invokeOperation(OperationRequest theRequest)	Invoked to perform a fhir operation
SearchSingleTargetResponse	invokePageRequest(SearchPageRequest theRequest)	Invoked to fetch a page of results
ReadResponse	invokeRead(ReadRequest theRequest)	Invoked to perform a read or vread operation
MethodOutcome	invokeTransaction(TransactionRequest theRequest, ServletRequestDetails theRequestDetails)	Invoked to perform a FHIR TRANSACTION operation
SearchSingleTargetResponse	invokeTypeSearch(SearchRequest theRequest)	Invoked to perform a type level search
MethodOutcome	invokeUpdate(UpdateRequest theRequest, ServletRequestDetails theRequestDetails)	Invoked to perform a fhir update operation
boolean	isAllowedToFail()	Should FHIR Gateway permit this target to fail on search routes? Does not apply to read routes.
boolean	isServerCapabilityStatementValidationEnabled()	Should FHIR Gateway validate the target server's CapabilityStatement with a request to /metadata
boolean	isUseHttpPostForAllSearches()	Should this target use HTTP POST for all search operations
void	setAllowedToFail(boolean theAllowedToFail)	Should FHIR Gateway permit this target to fail on search routes? Does not apply to read routes.
void	setBaseUrl(String theBaseUrl)	This method will be called prior to start()
void	setConnectTimeout(int theConnectTimeoutSeconds)	This method will be called prior to start()
void	setHeadersToForward(List<String> theHeadersToForward)	Return headers to be copied from the incoming client request and added to requests to the target server
void	setHttpBasicCredentials(String theUsername, String thePassword)	This method will only be called if HTTP Basic credentials are configured for this endpoint
void	setResourceIdPrefix(String theResourceIdPrefix)	Provides a prefix to prepend to resource IDs
void	setServerCapabilityStatementValidationEnabled(boolean theServerCapabilityStatementValidationEnabled)	Should FHIR Gateway validate the target server's CapabilityStatement with a request to /metadata
void	setSocketTimeout(int theSocketTimeoutSeconds)	This method will be called prior to start()
void	setTargetFixedUrl(String theTargetFixedUrl)	If the downstream target uses a fixed endpoint URL which does not match the defined {@link this#getBaseUrl()}, set this value to the target's Fixed URL in order to have gateway trust bundle links which originate from this URL.
void	setUseHttpPostForAllSearches(boolean theUseHttpPostForAllSearches)	Should this target use HTTP POST for all search operations
void	start()	This method will be automatically called once before any invoke methods
void	stop()	This method will be automatically called when the gateway is shutting down

Method Details

getId

String getId()

Fetch the ID for this target

setConnectTimeout

void setConnectTimeout(int theConnectTimeoutSeconds)

This method will be called prior to start()

setSocketTimeout

void setSocketTimeout(int theSocketTimeoutSeconds)

This method will be called prior to start()

setHttpBasicCredentials

void setHttpBasicCredentials(String theUsername,
 String thePassword)

This method will only be called if HTTP Basic credentials are configured for this endpoint

This method will be called prior to start()

setResourceIdPrefix

void setResourceIdPrefix(String theResourceIdPrefix)

Provides a prefix to prepend to resource IDs

This method will be called prior to start()

getResourceIdPrefix

String getResourceIdPrefix()

Provides a prefix to prepend to resource IDs

start

void start()

This method will be automatically called once before any invoke methods

stop

void stop()

This method will be automatically called when the gateway is shutting down

invokeTypeSearch

SearchSingleTargetResponse invokeTypeSearch(SearchRequest theRequest)

Invoked to perform a type level search

Parameters:

theRequest - The details of the search request

invokePageRequest

SearchSingleTargetResponse invokePageRequest(SearchPageRequest theRequest)

Invoked to fetch a page of results

invokeRead

ReadResponse invokeRead(ReadRequest theRequest)

Invoked to perform a read or vread operation

invokeOperation

OperationResponse invokeOperation(OperationRequest theRequest)

Invoked to perform a fhir operation

invokeGraphQLOperation

String invokeGraphQLOperation(OperationRequest theRequest,
 String theGraphQLQuery)
                       throws IOException,
URISyntaxException,
org.apache.http.auth.AuthenticationException

Invoked to perform a GraphQL operation

Throws:

IOException

URISyntaxException

org.apache.http.auth.AuthenticationException

invokeUpdate

MethodOutcome invokeUpdate(UpdateRequest theRequest,
 ServletRequestDetails theRequestDetails)

Invoked to perform a fhir update operation

invokeDelete

MethodOutcome invokeDelete(DeleteRequest theRequest,
 ServletRequestDetails theRequestDetails)

Invoked to perform a fhir delete operation

invokeCreate

MethodOutcome invokeCreate(CreateRequest theRequest,
 ServletRequestDetails theRequestDetails)

Invoked to perform a fhir CREATE operation

invokeTransaction

MethodOutcome invokeTransaction(TransactionRequest theRequest,
 ServletRequestDetails theRequestDetails)

Invoked to perform a FHIR TRANSACTION operation

getBaseUrl

String getBaseUrl()

Return the base URL for the server

setBaseUrl

void setBaseUrl(String theBaseUrl)

This method will be called prior to start()

getHeadersToForward

List<String> getHeadersToForward()

Get headers to be copied from the incoming client request and added to requests to the target server

setHeadersToForward

void setHeadersToForward(List<String> theHeadersToForward)

Return headers to be copied from the incoming client request and added to requests to the target server

isUseHttpPostForAllSearches

boolean isUseHttpPostForAllSearches()

Should this target use HTTP POST for all search operations

Default is false

setUseHttpPostForAllSearches

void setUseHttpPostForAllSearches(boolean theUseHttpPostForAllSearches)

Should this target use HTTP POST for all search operations

Default is false

setTargetFixedUrl

void setTargetFixedUrl(String theTargetFixedUrl)

If the downstream target uses a fixed endpoint URL which does not match the defined {@link this#getBaseUrl()}, set this value to the target's Fixed URL in order to have gateway trust bundle links which originate from this URL.

Parameters:

theTargetFixedUrl - The fixed URL of the downstream target.

getTargetFixedUrl

String getTargetFixedUrl()

If the downstream target uses a fixed endpoint URL which does not match the defined {@link this#getBaseUrl()}, set this value to the target's Fixed URL in order to have gateway trust bundle links which originate from this URL.

Returns:

the fixed URL of the downstream target.

setServerCapabilityStatementValidationEnabled

void setServerCapabilityStatementValidationEnabled(boolean theServerCapabilityStatementValidationEnabled)

Should FHIR Gateway validate the target server's CapabilityStatement with a request to /metadata

Default is true

isServerCapabilityStatementValidationEnabled

boolean isServerCapabilityStatementValidationEnabled()

Should FHIR Gateway validate the target server's CapabilityStatement with a request to /metadata

Default is true

setAllowedToFail

void setAllowedToFail(boolean theAllowedToFail)

Should FHIR Gateway permit this target to fail on search routes? Does not apply to read routes.

Default is false

isAllowedToFail

boolean isAllowedToFail()

Should FHIR Gateway permit this target to fail on search routes? Does not apply to read routes.

Default is false