Package ca.cdr.test.app.clients

Class AdminJsonRestClient

java.lang.Object

ca.cdr.test.app.clients.AdminJsonRestClient

All Implemented Interfaces:

AutoCloseable

public class AdminJsonRestClient
extends Object
implements AutoCloseable

AdminJsonRestClient is a client for the Admin API of the CDR. It currently supports anonymous and http-basic authentication.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdminJsonRestClient.ForbiddenOperationException	Exception thrown when a forbidden operation is attempted

Method Summary

Modifier and Type	Method	Description
PrivacyNoticeAcceptanceJson	acceptPrivacyNotice(String theVersion)
void	awaitNewTransactionLogEntry(Long theMostRecentTxLogEntryId)
static AdminJsonRestClient	build(String theBaseUrl, String theUsername, String thePassword)	Deprecated, for removal: This API element is subject to removal in a future version. Use open(String, String, String), whose name says that the client owns the connection pool it returns and that the caller has to close it.
static AdminJsonRestClient	buildAnonymous(String theBaseUrl)	Deprecated, for removal: This API element is subject to removal in a future version. Use openAnonymous(String), whose name says that the client owns the connection pool it returns and that the caller has to close it.
void	cancelBatchJob(String theModuleId, String theJobId)	Cancel a batch job
void	close()	Releases the connection pool this client built for itself.
<T> T	convertJsonNodeToModel(com.fasterxml.jackson.databind.JsonNode jsonNode, Class<T> modelClass)	Since many methods currently return JsonNode, if you have a known model you would like to bind to, you can convert a json object to it using this method
<T> com.fasterxml.jackson.databind.JsonNode	convertModelToJsonNode(T model)
CdaTemplateJson	createCdaTemplate(String theModuleId, String theTemplateId, CdaTemplateRequestJson theTemplate)
OAuth2KeystoreJson	createKeystore(OAuth2KeystoreJson theKeystore)
OAuth2ClientDetailsJson	createOAuthClient(String theNodeId, String theModuleId, OAuth2WritableClientDetailsJson theClientDetails)	Create an OAuth client for a specific module
OAuth2ServerJson	createOidcServer(String theNodeId, String theModuleId, OAuth2ServerJson theServer)
com.fasterxml.jackson.databind.JsonNode	createOidcServer(String theNodeId, String theModuleId, com.fasterxml.jackson.databind.JsonNode theServerDetails)	Create an OIDC server for a specific module
void	deleteCdaTemplate(String theModuleId, String theTemplateId)
void	deleteKeystore(String theKeystoreId)
void	deleteOAuthClient(String theNodeId, String theModuleId, String theClientId)	Delete an OAuth client
com.fasterxml.jackson.databind.JsonNode	get(String thePath)	Perform a generic GET request to the specified path and return the response as JsonNode
String[]	getAllBatchJobModuleIds()	Get all module IDs that support batch jobs
AuditEventsJson	getAuditEvents()
AuditEventsJson	getAuditEvents(org.springframework.util.MultiValueMap<String,String> theQueryParams)
Batch2JobInstanceJson	getBatchJobInstance(String theModuleId, String theJobId)	Get a specific batch job instance by ID
AllBatch2JobInstancesJson	getBatchJobInstances(String theModuleId)
AllBatch2JobInstancesJson	getBatchJobInstances(String theModuleId, org.springframework.util.MultiValueMap<String,String> theQueryParams)
Batch2JobInstancesJson	getBatchJobInstancesByName(String theModuleId, String theJobDefinitionId, Boolean theEnded, int theStart, int theCount)
CdaTemplateResponseJson	getCdaTemplate(String theModuleId, String theTemplateId)
CdaTemplateViewAllResponseJson	getCdaTemplates(String theModuleId)
String	getFhirEndpointModuleIdFromPort(int thePort)	Find the module ID of the FHIR endpoint (FHIR REST, hybrid providers, or FHIR gateway) running on the given port.
com.fasterxml.jackson.databind.JsonNode	getHealthChecks(boolean theOnlyRunning)	Get health checks for all modules
OAuth2KeystoreJson	getKeystore(String theKeystoreId)
OAuth2KeystoresJson	getKeystores(int thePageIndex, int thePageSize)
MdmAlgorithmsListJson	getMdmAlgorithms(String theModuleId)
com.fasterxml.jackson.databind.JsonNode	getMdmDuplicateGoldenResources(String theModuleId)	Get MDM duplicate golden resources
com.fasterxml.jackson.databind.JsonNode	getMdmLinks(String theModuleId)	Get MDM links
MdmMetricsJson	getMdmMetrics(String theModuleId, String theResourceType)
com.fasterxml.jackson.databind.JsonNode	getModuleConfig(String theNodeId, String theModuleId)	Get the module configuration for a specific node and module
com.fasterxml.jackson.databind.JsonNode	getModuleInterceptors(String theNodeId, String theModuleId)
TransactionLogEventsJson.TransactionLogEventJson	getMostRecentTransactionLogEntry()
Long	getMostRecentTransactionLogEntryId()
NodeConfigurations	getNodeConfigurations()	Get the node configurations from the admin API.
com.fasterxml.jackson.databind.JsonNode	getNodeStatuses()	Get node statuses
OAuth2ClientDetailsJson	getOAuthClient(String theNodeId, String theModuleId, String theClientId)	Get an OAuth client
OAuth2ClientsJson	getOAuthClients(int thePageIndex, int thePageSize, ClientStatusFilterEnum theClientStatus)
OAuth2ServerJson	getOidcServer(String theNodeId, String theModuleId, String theIssuerUrl)
OAuth2ServersJson	getOidcServers(String theNodeId, String theModuleId, int thePageIndex, int thePageSize)
int	getPortFromModule(String theModuleId)	Get the port number for a specific module from the node configurations.
PrivacyNoticeJson	getPrivacyNotice()
PrivacyNoticeStatusJson	getPrivacyNoticeStatus()
com.fasterxml.jackson.databind.JsonNode	getRestorePoint(String theNodeId, Long theId)	Get a specific restore point
com.fasterxml.jackson.databind.JsonNode	getRestorePoints(String theNodeId, String theVersion, String theFromDate, String theToDate, int theOffset, int theCount)	Get a list of restore points for a node
TransactionLogEventsJson.TransactionLogEventJson	getTransactionLogEntryById(Long theId)	Fetch a transaction log entry by ID and return all details (includes the body)
TransactionLogEventsJson.TransactionLogEventJson	getTransactionLogEvent(Long theEventId, boolean theIncludeBody)	Get a specific transaction log event with its body
TransactionLogEventCodesJson	getTransactionLogEventCodes()
TransactionLogEventsJson	getTransactionLogs()	Get transaction logs
TransactionLogEventsJson	getTransactionLogs(org.springframework.util.MultiValueMap<String,String> theQueryParams)
Set<LoggerConfigJson>	getTroubleshootingLoggers()
static AdminJsonRestClient	issuingOn(SmileTestHttpClient theHttpClient, String theBaseUrl, String theUsername, String thePassword)	Builds a client that issues its requests on theHttpClient, sharing that client's connection pool and cookie store with everything else built over it.
com.fasterxml.jackson.databind.JsonNode	mergeMdmGoldenResources(String theModuleId, Object theRequest)	Merge MDM golden resources
static AdminJsonRestClient	open(String theBaseUrl, String theUsername, String thePassword)	Opens a client authenticating as the given user, over a connection pool of its own.
static AdminJsonRestClient	openAnonymous(String theBaseUrl)	Opens a client sending no credentials, over a connection pool of its own.
EtlImportProcessFileResponseJson	processBulkImport(String theModuleId, String theFilename, String theContent)	Process a bulk ETL import file
EtlImportProcessFileResponseJson	processBulkImport(String theModuleId, String theFilename, String theUserJobType, String theContent)	Process a bulk ETL import file
com.fasterxml.jackson.databind.JsonNode	restartModule(String theNodeId, String theModuleId)	Request to restart a module on all processes.
com.fasterxml.jackson.databind.JsonNode	restartModule(String theNodeId, String theModuleId, boolean theShouldWaitForRestart)	Request to restart a module on all processes.
com.fasterxml.jackson.databind.JsonNode	restartModule(String theNodeId, String theModuleId, boolean theShouldWaitForRestart, Duration theWaitTimeout)	Request to restart a module on all processes with a caller-supplied wait timeout.
void	restoreSystem(String theNodeId, Long theRestorePointId)	Restore the system to a specific restore point
OAuth2RevokeAllWithScopeResponseJson	revokeAllTokens(String theNodeId, String theModuleId, String theScope)
com.fasterxml.jackson.databind.JsonNode	stopModule(String theNodeId, String theModuleId)	Request to stop a module on all processes ModuleProcessesStatusChangeResponseJson
String	submitMdmOperation(String theModuleId, IBaseParameters theParameters)	Submit an MDM operation to perform batch matching on all resources
static String	toJsonString(IBaseResource theResource)
CdaTemplateJson	updateCdaTemplate(String theModuleId, String theTemplateId, CdaTemplateRequestJson theTemplate)
CdaTemplateJson	updateCdaTemplateScript(String theModuleId, String theTemplateId, String theScript)
OAuth2KeystoreJson	updateKeystore(String theKeystoreId, OAuth2KeystoreJson theKeystore)
com.fasterxml.jackson.databind.JsonNode	updateMdmLink(String theModuleId, Object theRequest)	Update MDM link
com.fasterxml.jackson.databind.JsonNode	updateModuleConfig(String theNodeId, String theModuleId, com.fasterxml.jackson.databind.JsonNode theOptions, boolean theRestart, boolean theReload)	Update the configuration for a specific module.
com.fasterxml.jackson.databind.JsonNode	updateModuleConfig(String theNodeId, String theModuleId, com.fasterxml.jackson.databind.JsonNode theOptions, boolean theRestart, boolean theReload, boolean theShouldWaitForRestart)	Update the configuration for a specific module.
com.fasterxml.jackson.databind.JsonNode	updateModuleConfig(String theNodeId, String theModuleId, com.fasterxml.jackson.databind.JsonNode theOptions, boolean theRestart, boolean theReload, boolean theShouldWaitForRestart, Duration theWaitTimeout)	Update the configuration for a specific module with a caller-supplied wait timeout.
OAuth2ClientDetailsJson	updateOAuthClient(String theNodeId, String theModuleId, String theClientId, OAuth2WritableClientDetailsJson theClientDetails)	Update an OAuth client for a specific module
OAuth2ServerJson	updateOidcServer(String theNodeId, String theModuleId, OAuth2ServerJson theServer)
com.fasterxml.jackson.databind.JsonNode	updateOidcServer(String theNodeId, String theModuleId, String theServerId, com.fasterxml.jackson.databind.JsonNode theServerDetails)	Update an OIDC server
LoggerConfigJson	updateTroubleshootingLoggerLevel(String theLoggerName, String theLoggerLevel)
Set<LoggerConfigJson>	updateTroubleshootingLoggers(Set<LoggerConfigJson> theLoggers)
UserDetailsJson	userCreate(String theNode, String theModuleId, UserDetailsJson userDetails)
UserDetailsJson	userFetchByPid(String theNodeId, String theModuleId, Long thePid)
com.fasterxml.jackson.databind.JsonNode	userFindAll(String theNodeId, String theModuleId, int thePageSize)
String	userFindAllAsString(String theNodeId, String theModuleId, int thePageSize)	Find all users and return the result as a String that can be used with ObjectMapper
com.fasterxml.jackson.databind.JsonNode	userFindByUsername(String theNodeId, String theModuleId, String theUsername)
String	userFindByUsernameAsString(String theNodeId, String theModuleId, String theUsername)	Find users by username and return the result as a String that can be used with ObjectMapper
UserDetailsJson	userUpdate(UserDetailsJson theUserDetails)

Methods inherited from class java.lang.Object

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

Method Details

open

@Nonnull
public static AdminJsonRestClient open(@Nonnull
 String theBaseUrl,
 @Nonnull
 String theUsername,
 @Nonnull
 String thePassword)

Opens a client authenticating as the given user, over a connection pool of its own.

The caller owns the pool: open this in a try-with-resources block, or close it from an @AfterAll when it is a field. Use issuingOn(SmileTestHttpClient, String, String, String) instead where a client to issue on already exists.

Parameters:

theBaseUrl - the Admin JSON base URL, including port

theUsername - the user to authenticate as

thePassword - that user's password

openAnonymous

@Nonnull
public static AdminJsonRestClient openAnonymous(@Nonnull
 String theBaseUrl)

Opens a client sending no credentials, over a connection pool of its own.

The caller owns the pool ? see open(String, String, String).

Parameters:

theBaseUrl - the Admin JSON base URL, including port

issuingOn

@Nonnull
public static AdminJsonRestClient issuingOn(@Nonnull
 SmileTestHttpClient theHttpClient,
 @Nonnull
 String theBaseUrl,
 @Nonnull
 String theUsername,
 @Nonnull
 String thePassword)

Builds a client that issues its requests on theHttpClient, sharing that client's connection pool and cookie store with everything else built over it. A harness passes its own client here so that a session established through this client is visible to the harness's other clients, and so that clearCookies() reaches this client too.

The pool stays the caller's: close() leaves it open, so there is nothing here for the caller to release. Use open(String, String, String) to build a pool of your own.

Parameters:

theHttpClient - the client to issue on, which the caller keeps ownership of

theBaseUrl - the Admin JSON base URL, including port

theUsername - the user to authenticate as

thePassword - that user's password

build

@Deprecated(since="2026.11.R01",
            forRemoval=true)
@Nonnull
public static AdminJsonRestClient build(@Nonnull
 String theBaseUrl,
 @Nonnull
 String theUsername,
 @Nonnull
 String thePassword)

Deprecated, for removal: This API element is subject to removal in a future version.

Use open(String, String, String), whose name says that the client owns the connection pool it returns and that the caller has to close it.

buildAnonymous

@Deprecated(since="2026.11.R01",
            forRemoval=true)
@Nonnull
public static AdminJsonRestClient buildAnonymous(@Nonnull
 String theBaseUrl)

Deprecated, for removal: This API element is subject to removal in a future version.

Use openAnonymous(String), whose name says that the client owns the connection pool it returns and that the caller has to close it.

userCreate

@Nonnull
public UserDetailsJson userCreate(String theNode,
 String theModuleId,
 UserDetailsJson userDetails)

userUpdate

@Nonnull
public UserDetailsJson userUpdate(UserDetailsJson theUserDetails)

userFindByUsername

@Nonnull
public com.fasterxml.jackson.databind.JsonNode userFindByUsername(String theNodeId,
 String theModuleId,
 String theUsername)

userFindByUsernameAsString

@Nonnull
public String userFindByUsernameAsString(String theNodeId,
 String theModuleId,
 String theUsername)

Find users by username and return the result as a String that can be used with ObjectMapper

Parameters:

theNodeId - The node ID

theModuleId - The module ID

theUsername - The username to search for

Returns:

The JSON string representation of the result

userFindAll

@Nonnull
public com.fasterxml.jackson.databind.JsonNode userFindAll(String theNodeId,
 String theModuleId,
 int thePageSize)

userFindAllAsString

@Nonnull
public String userFindAllAsString(String theNodeId,
 String theModuleId,
 int thePageSize)

Find all users and return the result as a String that can be used with ObjectMapper

Parameters:

theNodeId - The node ID

theModuleId - The module ID

thePageSize - The page size

Returns:

The JSON string representation of the result

userFetchByPid

@Nonnull
public UserDetailsJson userFetchByPid(String theNodeId,
 String theModuleId,
 Long thePid)

getModuleConfig

@Nonnull
public com.fasterxml.jackson.databind.JsonNode getModuleConfig(String theNodeId,
 String theModuleId)

Get the module configuration for a specific node and module

getModuleInterceptors

public com.fasterxml.jackson.databind.JsonNode getModuleInterceptors(String theNodeId,
 String theModuleId)

updateModuleConfig

@Nonnull
public com.fasterxml.jackson.databind.JsonNode updateModuleConfig(String theNodeId,
 String theModuleId,
 com.fasterxml.jackson.databind.JsonNode theOptions,
 boolean theRestart,
 boolean theReload)

Update the configuration for a specific module. When either theRestart or theReload is set, the client blocks until the module reports "STARTED" (up to DEFAULT_TIMEOUT). Use updateModuleConfig(String, String, JsonNode, boolean, boolean, boolean) to opt out of the wait.

updateModuleConfig

@Nonnull
public com.fasterxml.jackson.databind.JsonNode updateModuleConfig(String theNodeId,
 String theModuleId,
 com.fasterxml.jackson.databind.JsonNode theOptions,
 boolean theRestart,
 boolean theReload,
 boolean theShouldWaitForRestart)

Update the configuration for a specific module.

Parameters:

theShouldWaitForRestart - when true and either theRestart or theReload is set, the client polls the admin status endpoint until the module reports "STARTED", up to DEFAULT_TIMEOUT.

updateModuleConfig

@Nonnull
public com.fasterxml.jackson.databind.JsonNode updateModuleConfig(String theNodeId,
 String theModuleId,
 com.fasterxml.jackson.databind.JsonNode theOptions,
 boolean theRestart,
 boolean theReload,
 boolean theShouldWaitForRestart,
 Duration theWaitTimeout)

Update the configuration for a specific module with a caller-supplied wait timeout.

Parameters:

theShouldWaitForRestart - when true and either theRestart or theReload is set, the client polls the admin status endpoint until the module reports "STARTED", up to theWaitTimeout.

theWaitTimeout - the maximum duration to wait for the module to report "STARTED" when theShouldWaitForRestart is true. Ignored otherwise.

stopModule

@Nonnull
public com.fasterxml.jackson.databind.JsonNode stopModule(String theNodeId,
 String theModuleId)

Request to stop a module on all processes ModuleProcessesStatusChangeResponseJson

restartModule

@Nonnull
public com.fasterxml.jackson.databind.JsonNode restartModule(String theNodeId,
 String theModuleId)

Request to restart a module on all processes. Blocks until the module reports "STARTED" (up to DEFAULT_TIMEOUT). Use restartModule(String, String, boolean) to opt out of the wait.

restartModule

@Nonnull
public com.fasterxml.jackson.databind.JsonNode restartModule(String theNodeId,
 String theModuleId,
 boolean theShouldWaitForRestart)

Request to restart a module on all processes.

Parameters:

theShouldWaitForRestart - when true, the client polls the admin status endpoint until the module reports "STARTED", up to DEFAULT_TIMEOUT.

restartModule

@Nonnull
public com.fasterxml.jackson.databind.JsonNode restartModule(String theNodeId,
 String theModuleId,
 boolean theShouldWaitForRestart,
 Duration theWaitTimeout)

Request to restart a module on all processes with a caller-supplied wait timeout.

Parameters:

theShouldWaitForRestart - when true, the client polls the admin status endpoint until the module reports "STARTED", up to theWaitTimeout.

theWaitTimeout - the maximum duration to wait for the module to report "STARTED" when theShouldWaitForRestart is true. Ignored otherwise.

getRestorePoints

@Nonnull
public com.fasterxml.jackson.databind.JsonNode getRestorePoints(String theNodeId,
 @Nullable
 String theVersion,
 @Nullable
 String theFromDate,
 @Nullable
 String theToDate,
 int theOffset,
 int theCount)

Get a list of restore points for a node

getRestorePoint

@Nonnull
public com.fasterxml.jackson.databind.JsonNode getRestorePoint(String theNodeId,
 Long theId)

Get a specific restore point

restoreSystem

public void restoreSystem(String theNodeId,
 Long theRestorePointId)

Restore the system to a specific restore point

getHealthChecks

@Nonnull
public com.fasterxml.jackson.databind.JsonNode getHealthChecks(boolean theOnlyRunning)

Get health checks for all modules

getNodeStatuses

@Nonnull
public com.fasterxml.jackson.databind.JsonNode getNodeStatuses()

Get node statuses

cancelBatchJob

public void cancelBatchJob(String theModuleId,
 String theJobId)

Cancel a batch job

getAllBatchJobModuleIds

@Nonnull
public String[] getAllBatchJobModuleIds()

Get all module IDs that support batch jobs

getBatchJobInstance

@Nonnull
public Batch2JobInstanceJson getBatchJobInstance(String theModuleId,
 String theJobId)

Get a specific batch job instance by ID

getBatchJobInstances

@Nonnull
public AllBatch2JobInstancesJson getBatchJobInstances(String theModuleId)

getBatchJobInstances

@Nonnull
public AllBatch2JobInstancesJson getBatchJobInstances(String theModuleId,
 @Nonnull
 org.springframework.util.MultiValueMap<String,String> theQueryParams)

getBatchJobInstancesByName

@Nonnull
public Batch2JobInstancesJson getBatchJobInstancesByName(String theModuleId,
 String theJobDefinitionId,
 @Nullable
 Boolean theEnded,
 int theStart,
 int theCount)

processBulkImport

@Nonnull
public EtlImportProcessFileResponseJson processBulkImport(@Nonnull
 String theModuleId,
 @Nullable
 String theFilename,
 @Nonnull
 String theContent)

Process a bulk ETL import file

Parameters:

theModuleId - the id of the etl module to target

theFilename - the optional filename as a hint for the import process

theContent - the body of the csv file to import

processBulkImport

@Nonnull
public EtlImportProcessFileResponseJson processBulkImport(@Nonnull
 String theModuleId,
 @Nullable
 String theFilename,
 @Nullable
 String theUserJobType,
 @Nonnull
 String theContent)

Process a bulk ETL import file

Parameters:

theModuleId - the id of the etl module to target

theFilename - the optional filename as a hint for the import process

theUserJobType - the optional job type to use for the import process

theContent - the body of the csv file to import

getTransactionLogs

@Nonnull
public TransactionLogEventsJson getTransactionLogs()

Get transaction logs

getTransactionLogs

@Nonnull
public TransactionLogEventsJson getTransactionLogs(@Nonnull
 org.springframework.util.MultiValueMap<String,String> theQueryParams)

getTransactionLogEventCodes

@Nonnull
public TransactionLogEventCodesJson getTransactionLogEventCodes()

getAuditEvents

@Nonnull
public AuditEventsJson getAuditEvents()

getAuditEvents

@Nonnull
public AuditEventsJson getAuditEvents(@Nonnull
 org.springframework.util.MultiValueMap<String,String> theQueryParams)

getMdmAlgorithms

@Nonnull
public MdmAlgorithmsListJson getMdmAlgorithms(String theModuleId)

getMdmMetrics

@Nonnull
public MdmMetricsJson getMdmMetrics(String theModuleId,
 String theResourceType)

getTroubleshootingLoggers

@Nonnull
public Set<LoggerConfigJson> getTroubleshootingLoggers()

updateTroubleshootingLoggers

@Nonnull
public Set<LoggerConfigJson> updateTroubleshootingLoggers(@Nonnull
 Set<LoggerConfigJson> theLoggers)

updateTroubleshootingLoggerLevel

@Nonnull
public LoggerConfigJson updateTroubleshootingLoggerLevel(String theLoggerName,
 String theLoggerLevel)

getTransactionLogEvent

@Nonnull
public TransactionLogEventsJson.TransactionLogEventJson getTransactionLogEvent(Long theEventId,
 boolean theIncludeBody)

Get a specific transaction log event with its body

createOAuthClient

@Nonnull
public OAuth2ClientDetailsJson createOAuthClient(String theNodeId,
 String theModuleId,
 OAuth2WritableClientDetailsJson theClientDetails)

Create an OAuth client for a specific module

updateOAuthClient

@Nonnull
public OAuth2ClientDetailsJson updateOAuthClient(String theNodeId,
 String theModuleId,
 String theClientId,
 OAuth2WritableClientDetailsJson theClientDetails)

Update an OAuth client for a specific module

deleteOAuthClient

public void deleteOAuthClient(String theNodeId,
 String theModuleId,
 String theClientId)

Delete an OAuth client

getOAuthClients

@Nonnull
public OAuth2ClientsJson getOAuthClients(int thePageIndex,
 int thePageSize,
 @Nullable
 ClientStatusFilterEnum theClientStatus)

getOAuthClient

@Nonnull
public OAuth2ClientDetailsJson getOAuthClient(String theNodeId,
 String theModuleId,
 String theClientId)

Get an OAuth client

createOidcServer

@Nonnull
public com.fasterxml.jackson.databind.JsonNode createOidcServer(String theNodeId,
 String theModuleId,
 com.fasterxml.jackson.databind.JsonNode theServerDetails)

Create an OIDC server for a specific module

createOidcServer

@Nonnull
public OAuth2ServerJson createOidcServer(String theNodeId,
 String theModuleId,
 @Nonnull
 OAuth2ServerJson theServer)

getOidcServer

@Nonnull
public OAuth2ServerJson getOidcServer(String theNodeId,
 String theModuleId,
 String theIssuerUrl)

getOidcServers

@Nonnull
public OAuth2ServersJson getOidcServers(@Nullable
 String theNodeId,
 @Nullable
 String theModuleId,
 int thePageIndex,
 int thePageSize)

updateOidcServer

@Nonnull
public com.fasterxml.jackson.databind.JsonNode updateOidcServer(String theNodeId,
 String theModuleId,
 String theServerId,
 com.fasterxml.jackson.databind.JsonNode theServerDetails)

Update an OIDC server

updateOidcServer

@Nonnull
public OAuth2ServerJson updateOidcServer(String theNodeId,
 String theModuleId,
 @Nonnull
 OAuth2ServerJson theServer)

createCdaTemplate

@Nonnull
public CdaTemplateJson createCdaTemplate(String theModuleId,
 String theTemplateId,
 @Nonnull
 CdaTemplateRequestJson theTemplate)

updateCdaTemplate

@Nonnull
public CdaTemplateJson updateCdaTemplate(String theModuleId,
 String theTemplateId,
 @Nonnull
 CdaTemplateRequestJson theTemplate)

updateCdaTemplateScript

@Nonnull
public CdaTemplateJson updateCdaTemplateScript(String theModuleId,
 String theTemplateId,
 String theScript)

getCdaTemplates

@Nonnull
public CdaTemplateViewAllResponseJson getCdaTemplates(String theModuleId)

getCdaTemplate

@Nonnull
public CdaTemplateResponseJson getCdaTemplate(String theModuleId,
 String theTemplateId)

deleteCdaTemplate

public void deleteCdaTemplate(String theModuleId,
 String theTemplateId)

getPrivacyNotice

@Nonnull
public PrivacyNoticeJson getPrivacyNotice()

getPrivacyNoticeStatus

@Nonnull
public PrivacyNoticeStatusJson getPrivacyNoticeStatus()

acceptPrivacyNotice

@Nonnull
public PrivacyNoticeAcceptanceJson acceptPrivacyNotice(String theVersion)

getKeystores

@Nonnull
public OAuth2KeystoresJson getKeystores(int thePageIndex,
 int thePageSize)

getKeystore

@Nonnull
public OAuth2KeystoreJson getKeystore(String theKeystoreId)

createKeystore

@Nonnull
public OAuth2KeystoreJson createKeystore(@Nonnull
 OAuth2KeystoreJson theKeystore)

updateKeystore

@Nonnull
public OAuth2KeystoreJson updateKeystore(String theKeystoreId,
 @Nonnull
 OAuth2KeystoreJson theKeystore)

deleteKeystore

public void deleteKeystore(String theKeystoreId)

revokeAllTokens

@Nonnull
public OAuth2RevokeAllWithScopeResponseJson revokeAllTokens(@Nullable
 String theNodeId,
 @Nullable
 String theModuleId,
 @Nullable
 String theScope)

getMdmLinks

@Nonnull
public com.fasterxml.jackson.databind.JsonNode getMdmLinks(String theModuleId)

Get MDM links

mergeMdmGoldenResources

@Nonnull
public com.fasterxml.jackson.databind.JsonNode mergeMdmGoldenResources(String theModuleId,
 Object theRequest)

Merge MDM golden resources

updateMdmLink

@Nonnull
public com.fasterxml.jackson.databind.JsonNode updateMdmLink(String theModuleId,
 Object theRequest)

Update MDM link

getMdmDuplicateGoldenResources

@Nonnull
public com.fasterxml.jackson.databind.JsonNode getMdmDuplicateGoldenResources(String theModuleId)

Get MDM duplicate golden resources

submitMdmOperation

@Nonnull
public String submitMdmOperation(String theModuleId,
 IBaseParameters theParameters)

Submit an MDM operation to perform batch matching on all resources

Parameters:

theModuleId - The module ID

theParameters - The parameters for the MDM operation

Returns:

The response as a String

toJsonString

public static String toJsonString(IBaseResource theResource)

getNodeConfigurations

@Nonnull
public NodeConfigurations getNodeConfigurations()

Get the node configurations from the admin API.

Returns:

The node configurations

getPortFromModule

public int getPortFromModule(String theModuleId)

Get the port number for a specific module from the node configurations.

Parameters:

theModuleId - The ID of the module to get the port for

Returns:

The port number, or the default FHIR port (8000) if not found

getFhirEndpointModuleIdFromPort

@Nonnull
public String getFhirEndpointModuleIdFromPort(int thePort)

Find the module ID of the FHIR endpoint (FHIR REST, hybrid providers, or FHIR gateway) running on the given port.

Parameters:

thePort - The port to look up

Returns:

The module ID of the FHIR endpoint module running on the given port

Throws:

IllegalArgumentException - if no FHIR endpoint module is found running on the given port

IllegalStateException - if no nodes are found in the node configuration

convertJsonNodeToModel

public <T> T convertJsonNodeToModel(com.fasterxml.jackson.databind.JsonNode jsonNode,
 Class<T> modelClass)
                             throws com.fasterxml.jackson.core.JsonProcessingException

Since many methods currently return JsonNode, if you have a known model you would like to bind to, you can convert a json object to it using this method

Throws:

com.fasterxml.jackson.core.JsonProcessingException

convertModelToJsonNode

public <T> com.fasterxml.jackson.databind.JsonNode convertModelToJsonNode(T model)
                                                                   throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getMostRecentTransactionLogEntry

@Nullable
public TransactionLogEventsJson.TransactionLogEventJson getMostRecentTransactionLogEntry()

getMostRecentTransactionLogEntryId

@Nullable
public Long getMostRecentTransactionLogEntryId()

awaitNewTransactionLogEntry

public void awaitNewTransactionLogEntry(Long theMostRecentTxLogEntryId)

getTransactionLogEntryById

public TransactionLogEventsJson.TransactionLogEventJson getTransactionLogEntryById(Long theId)

Fetch a transaction log entry by ID and return all details (includes the body)

get

@Nonnull
public com.fasterxml.jackson.databind.JsonNode get(String thePath)

Perform a generic GET request to the specified path and return the response as JsonNode

Parameters:

thePath - The path to perform the GET request on

Returns:

The response as JsonNode

close

public void close()

Releases the connection pool this client built for itself. A no-op when the client was built over one supplied by a caller, which owns its own pool.

Specified by:

close in interface AutoCloseable