gov.nist.toolkit.toolkitApi

Class SimulatorBuilder

java.lang.Object

gov.nist.toolkit.toolkitApi.SimulatorBuilder

public class SimulatorBuilder
extends java.lang.Object

Build/modify a collection of different Actor simulators running in a remote copy of toolkit.

Constructor Summary

Constructors

Constructor and Description
SimulatorBuilder(java.lang.String urlRoot) This will initialize the API to contact the test engine at http://hostname:port/xdstools2

Method Summary

Modifier and Type	Method and Description
InitiatingGateway	asInitiatingGateway(SimConfig config)
DocumentConsumer	createDocumentConsumer(java.lang.String id, java.lang.String user, java.lang.String environmentName) Create new Document Consumer simulator with default configuration.
DocumentRecipient	createDocumentRecipient(java.lang.String id, java.lang.String user, java.lang.String environmentName) Create new Document Recipient simulator with default configuration.
DocumentRegRep	createDocumentRegRep(java.lang.String id, java.lang.String user, java.lang.String environmentName) Create new Document Registry/Repository simulator with default configuration.
DocumentRepository	createDocumentRepository(java.lang.String id, java.lang.String user, java.lang.String environmentName)
DocumentSource	createDocumentSource(java.lang.String id, java.lang.String user, java.lang.String environmentName) Create new Document Source simulator with default configuration.
IFhirServer	createFhirServer(java.lang.String id, java.lang.String user, java.lang.String environmentName)
ImagingDocumentSource	createImagingDocumentSource(java.lang.String id, java.lang.String user, java.lang.String environmentName) Create new Imaging Document Source simulator with default configuration.
InitiatingGateway	createInitiatingGateway(java.lang.String id, java.lang.String user, java.lang.String environmentName)
RespondingGateway	createRespondingGateway(java.lang.String id, java.lang.String user, java.lang.String environmentName)
XdmValidator	createXdmValidator()
void	delete(java.lang.String id, java.lang.String user) Delete a simulator.
SimConfig	get(SimId simId) Get configuration of a Simulator.
SimId	get(java.lang.String user, java.lang.String id) Creates SimId instance for passed user (session) and sim id.
EngineSpi	getEngine()
SimConfig	update(SimConfig config) Update the configuration of a Simulator.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimulatorBuilder

public SimulatorBuilder(java.lang.String urlRoot)

This will initialize the API to contact the test engine at http://hostname:port/xdstools2

Parameters:

urlRoot - where engine is running - typical value would be http://localhost:8080/xdstools2

Method Detail

getEngine

public EngineSpi getEngine()

Returns:

EngineSpi for this builder.

createDocumentSource

public DocumentSource createDocumentSource(java.lang.String id,
                                           java.lang.String user,
                                           java.lang.String environmentName)
                                    throws ToolkitServiceException

Create new Document Source simulator with default configuration. To create a simulator with custom configuration:

1. Create simulator with default configuration
2. Update the local copy of the configuration
3. Send the update via the update method

Parameters:

id - Simulator ID

user - User creating Simulator. Same as TestSession in Toolkit UI. The simulator ID must be unique for this user.

environmentName - Environment defines Affinity Domain coding schemes and TLS certificate for use with client.

Returns:

Simulator configuration.

Throws:

ToolkitServiceException - if anything goes wrong.

createImagingDocumentSource

public ImagingDocumentSource createImagingDocumentSource(java.lang.String id,
                                                         java.lang.String user,
                                                         java.lang.String environmentName)
                                                  throws ToolkitServiceException

Create new Imaging Document Source simulator with default configuration. To create a simulator with custom configuration:

1. Create simulator with default configuration
2. Update the local copy of the configuration
3. Send the update via the update method

Parameters:

id - Simulator ID

user - User creating Simulator. Same as TestSession in Toolkit UI. The simulator ID must be unique for this user.

environmentName - Environment defines Affinity Domain coding schemes and TLS certificate for use with client.

Returns:

Simulator configuration.

Throws:

ToolkitServiceException - if anything goes wrong.

createDocumentConsumer

public DocumentConsumer createDocumentConsumer(java.lang.String id,
                                               java.lang.String user,
                                               java.lang.String environmentName)
                                        throws ToolkitServiceException

Create new Document Consumer simulator with default configuration. To create a simulator with custom configuration:

1. Create simulator with default configuration
2. Update the local copy of the configuration
3. Send the update via the update method

Parameters:

id - Simulator ID

user - User creating Simulator. Same as TestSession in Toolkit UI. The simulator ID must be unique for this user.

environmentName - Environment defines Affinity Domain coding schemes and TLS certificate for use with client.

Returns:

Simulator configuration.

Throws:

ToolkitServiceException - if anything goes wrong.

createDocumentRecipient

public DocumentRecipient createDocumentRecipient(java.lang.String id,
                                                 java.lang.String user,
                                                 java.lang.String environmentName)
                                          throws ToolkitServiceException

Create new Document Recipient simulator with default configuration. To create a simulator with custom configuration:

1. Create simulator with default configuration
2. Update the local copy of the configuration
3. Send the update via the update method

Parameters:

id - Simulator ID

user - User creating Simulator. Same as TestSession in Toolkit UI. The simulator ID must be unique for this user.

environmentName - Environment defines Affinity Domain coding schemes and TLS certificate for use with client.

Returns:

Simulator configuration.

Throws:

ToolkitServiceException - if anything goes wrong.

createFhirServer

public IFhirServer createFhirServer(java.lang.String id,
                                    java.lang.String user,
                                    java.lang.String environmentName)
                             throws ToolkitServiceException

Throws:

ToolkitServiceException

createDocumentRegRep

public DocumentRegRep createDocumentRegRep(java.lang.String id,
                                           java.lang.String user,
                                           java.lang.String environmentName)
                                    throws ToolkitServiceException

Create new Document Registry/Repository simulator with default configuration. To create a simulator with custom configuration:

1. Create simulator with default configuration
2. Update the local copy of the configuration
3. Send the update via the update method

Parameters:

id - Simulator ID

user - User creating Simulator. Same as TestSession in Toolkit UI. The simulator ID must be unique for this user.

environmentName - Environment defines Affinity Domain coding schemes and TLS certificate for use with client.

Returns:

Simulator configuration.

Throws:

ToolkitServiceException - if anything goes wrong.

createDocumentRepository

public DocumentRepository createDocumentRepository(java.lang.String id,
                                                   java.lang.String user,
                                                   java.lang.String environmentName)
                                            throws ToolkitServiceException

Throws:

ToolkitServiceException

createRespondingGateway

public RespondingGateway createRespondingGateway(java.lang.String id,
                                                 java.lang.String user,
                                                 java.lang.String environmentName)
                                          throws ToolkitServiceException

Throws:

ToolkitServiceException

createInitiatingGateway

public InitiatingGateway createInitiatingGateway(java.lang.String id,
                                                 java.lang.String user,
                                                 java.lang.String environmentName)
                                          throws ToolkitServiceException

Throws:

ToolkitServiceException

asInitiatingGateway

public InitiatingGateway asInitiatingGateway(SimConfig config)

update

public SimConfig update(SimConfig config)
                 throws ToolkitServiceException

Update the configuration of a Simulator. Any properties that are passed in SimConfig that are not recognized will be silently ignored. Parameters passed with wrong type (String vs. boolean) will cause ToolkitServiceException. Expected usage is to retrieve the configuration using the get() method, update the parameters, and then submit the update using this call.

Parameters:

config - new configuration

Returns:

updated SimConfig if updates made or null if no changes accepted.

Throws:

ToolkitServiceException - if anything goes wrong

delete

public void delete(java.lang.String id,
                   java.lang.String user)
            throws ToolkitServiceException

Delete a simulator. There is another call available using the SimId parameter type. This parameter type contains the raw ID and USER that are used here. The two calls function identically. If the simulator does not exist no error is returned.

Parameters:

id - of simulator

user - of simulator

Throws:

ToolkitServiceException - if anything goes wrong.

get

public SimConfig get(SimId simId)
              throws ToolkitServiceException

Get configuration of a Simulator.

Parameters:

simId - simulator ID

Returns:

simulator configuration

Throws:

ToolkitServiceException - if anything goes wrong

get

public SimId get(java.lang.String user,
                 java.lang.String id)

Creates SimId instance for passed user (session) and sim id. Note: Does not check to see if such a simulator exists.

Parameters:

user - (session)

id - simulator id.

Returns:

SimId instance.

createXdmValidator

public XdmValidator createXdmValidator()