pactsafe-java-sdk

A Java client for the Ironclad Clickwrap Activity API. Integrate into any application for secure legal record-keeping.

Fork it at https://github.com/pactsafe/pactsafe-java-sdk

Initialization

<dependency>
  <groupId>com.pactsafe</groupId>
  <artifactId>pactsafe-java-sdk</artifactId>
  <version>{Latest}</version>
</dependency>

Coming soon to maven-central.

Initialization

Initialize the Activity client, passing your PactSafe Site's access_id String as the first argument.

Activity site = new Activity("ACCESS_KEY");

Configuration

The second argument to the Activity constructor is an optional ParameterStore object of properties for the Activity client.

ParameterStore parameters = new ParameterStore();
parameters.setTestMode(true);
Activity site = new Activity("ACCESS_KEY", parameters);

The third argument is an optional ActivityOptions object of client configuration settings.

ActivityOptions options = new ActivityOptions();
options.setHost("http://localhost:3000");
Activity site = new Activity("ACCESS_KEY", parameters, options);

Parameters

Every Action sent to the PactSafe Activity API is built from the parameters stored on the Activity client. These parameter values can be set or retrieved at any point.

ParameterStore parameters = site.getParameters();
parameters.setPageTitle("Registration Page");
site.setParameters(parameters);

Load

The load method lets you load the properties and content of a clickwrap Group by key.

Group group = site.load("GROUP_KEY");

Optionally, you can pass a custom Map<String, Object> as renderData for the second argument -- allowing you to alter the content each time the Group is loaded. For this reason, every response from the load request provides a unique render_id to use for activity tracking.

renderDataMap.put("order_id", 123456);
renderDataMap.put("company_name", "Example LLC");
Group group = site.load("GROUP_KEY", renderDataMap);

Retrieve

The retrieve method lets you load a Signer's acceptance history for a given set of Contract IDs.

Providing a signer_id and an array of contracts, the response will contain a map of each Contract ID and its most recently accepted Version ID.

List<Integer> contractIds = new ArrayList<Integer>();
contractIds.add(1);
contractIds.add(4);
Map<Integer, String> retrieve = activity.retrieve("SIGNER_ID", contractIds);

When invoked from a group object, the contracts from the group will be automatically loaded.

Map<Integer, String> retrieve = group.retrieve("SIGNER_ID");

Latest

The latest method tells you if a Signer has accepted the latest Version for a given set of Contract IDs.

This method is similar to the retrieve method, but instead of providing the actual Version ID that was last accepted, the response contains a boolean true or false for each contract ID.

Map<Integer, Boolean> latest = activity.latest("SIGNER_ID", contractIds);

When invoked from a group object, the contracts from the group will be automatically loaded.

Map<Integer, Boolean> latest = activity.latest("SIGNER_ID");

Send

The send method lets you track a Signer Action by sending data to the PactSafe Activity API.

Provide an option from the EventType enum, as well as any parameters to save on the Action. The signerId parameter and renderId are required for most event types.

ParameterStore action = new ParameterStore();
action.setSignerId("[email protected]");
action.setRenderId(group.getParameters().getRenderId());
action.setPageTitle("My Test Page Title");

site.send(EventType.UPDATED, action);

Agreed

The agreed method sends a Signer Action to the PactSafe Activity API with the event type agreed.

Provide a signer_id, as well as any parameters to save on the Action. If the content being accepted was assigned a render_id, be sure to include that same render_id in the Action parameters.

ParameterStore action = new ParameterStore();
action.setSignerId("[email protected]");
action.setRenderId(group.getParameters().getRenderId());
Map<String, Object> customData = new HashMap<String, Object>();
customData.put("order_id", 123456);
customData.put("sku", "MYTX772");
action.setCustomData(customData);

site.agreed(action);

Exceptions

All methods outside of Activity initialization are designed to throw a PactSafeActivityException Exception should an issue arrise in the processing of your request. Additionally, an IllegalArgumentException will be raised should illegal arguments be passed.

Development

For development, you can enable the test_mode parameter when the client is initialized. Any Signers or Actions created within test mode can be easily cleared from your account.

ParameterStore parameters = new ParameterStore();
parameters.setTestMode(true);
Activity site = new Activity("ACCESS_KEY", parameters);