lib-ncip-client

Client for the NISO Circulation Interchange Protocol (NCIP)

building the project

mvn package

to do

• Feedback?
• Write tests
• More testing
• Anything to add to the repo, pom for CI?

dependencies

<dependency>
	<groupId>org.json</groupId>
	<artifactId>json</artifactId>
	<version>20190722</version>
</dependency>
<dependency>
	<groupId>org.apache.httpcomponents</groupId>
	<artifactId>httpclient</artifactId>
	<version>4.5.3</version>
</dependency>
<dependency>
	<groupId>org.apache.httpcomponents</groupId>
	<artifactId>httpcore</artifactId>
	<version>4.4.6</version>
</dependency>
<dependency>
	<groupId>org.slf4j</groupId>
	<artifactId>slf4j-api</artifactId>
	<version>1.7.18</version>
</dependency>
<dependency>
	<groupId>commons-io</groupId>
	<artifactId>commons-io</artifactId>
	<version>2.6</version>
</dependency>

usage

This initial version of the 'NCIP Client' supports four NCIP2 services:

• LookupUser
• AcceptItem
• CheckInItem
• CheckOutItem

Note: If you want to call mod-ncip directly in FOLIO (instead of through an edge module)...authentication has to take place. Use the FolioNcipClient (instead of NCIP2Client) which will authenticate with FOLIO:

FolioNcipClient folioClient = new FolioNcipClient("https://folio-snapshot-load-okapi.aws.indexdata.com","diku_admin","thedikupassword","diku");
		

LookupUser

NCIP2Client ncip2Client = new NCIP2Client("https://test.ncip.lehigh.edu/ncip");
LookupUser lookupUser = new LookupUser()
                  .setUserId("876579559")
                  .includeUserAddressInformation()
                  .includeUserPrivilege()
                  .includeNameInformation()
                  .setToAgency("Relais")
                  .setFromAgency("Relais")
                  .setApplicationProfileType("EZBORROW");
JSONObject response = ncip2Client.send(lookupUser);
System.out.println(response);

Response examples:

{
	"firstName": "Jane",
	"lastName": "Doe",
	"privileges": [{
			"value": "true",
			"key": "Courtesy Notice"
		}, {
			"value": "false",
			"key": "Delivery"
		},
		{
			"value": "true",
			"key": "Paging"
		}, {
			"value": "STAFF",
			"key": "Profile"
		}, {
			"value": "OK",
			"key": "status"
		}
	],
	"electronicAddresses": [{
		"value": "notreal@lehigh.edu",
		"key": "electronic mail address"
	}, {
		"value": "6105551212",
		"key": "TEL"
	}],
	"userId": "876579559"
}

Response example when there is a problem:
{"problems":[{"detail":"User does not exist","type":"","value":"85551212","element":"USER"}]}

AcceptItem

NCIP2Client ncip2Client = new NCIP2Client("https://test.ncip.lehigh.edu/ncip");
AcceptItem acceptItem = new AcceptItem()
                  .setItemId("LEH-20200305633")
                  .setRequestId("LEH-20200305633")
                  .setUserId("876579559")
                  .setAuthor("Jane Doe") 
                  .setTitle("One Fish Two Fish")
                  .setIsbn("983847293847")
                  .setCallNumber("505.c")
                  .setPickupLocation("FAIRCHILD")
                  .setToAgency("Relais")
                  .setFromAgency("Relais")
                  .setRequestedActionTypeString("Hold For Pickup")
                  .setApplicationProfileType("EZBORROW");
JSONObject response = ncip2Client.send(acceptItem);
System.out.println(response);

Response examples:

{"itemId":"LEH-20200305699","requestId":"25388"}

Response with a problem:
{"problems":[{"detail":"Item Barcode Already Exist","type":"","value":"LEH-20200305699","element":"Item"}]}

CheckoutItem

NCIP2Client ncip2Client = new NCIP2Client("https://test.ncip.lehigh.edu/ncip");
CheckoutItem checkoutItem = new CheckoutItem()
                  .setUserId("905808497")
                  .setItemId("LEH-20200305217")
                  .setRequestId("LEH-20200305217")
                  .setToAgency("01TULI_INST")
                  .setFromAgency("01TULI_INST")
                  .setApplicationProfileType("EZBORROW")
                  .setDesiredDueDate("2020-03-18");
JSONObject response = ncip2Client.send(checkoutItem);
System.out.println(response);

Response examples:

{"itemId":"LEH-20200305700","dueDate":"2020-06-13 04:00:00","userId":"876579559"}

Response with problem:
{"problems":[{"detail":"Invalid item barcode : LEH-2020030570a",
"type":"","value":"CheckOut Failed","element":""}]}

CheckinItem

NCIP2Client ncip2Client = new NCIP2Client("https://test.ncip.lehigh.edu/ncip");
CheckinItem checkinItem = new CheckinItem()
                  .setItemId("LEH-20200301608")
                  .setToAgency("01TULI_INST")
                  .setFromAgency("01TULI_INST")
                  .includeBibliographicDescription()
                  .setApplicationProfileType("EZBORROW");
JSONObject response = ncip2Client.send(checkinItem);
System.out.println(response);

Response examples:

{"itemId":"LEH-20200305700"}

Response with a problem:
{"problems":[{"detail":"Failed to find incoming or outgoing by external item barcode 
LEH-20200305699","type":"Unknown Item"}]}

design & future expansion

There are four objects representing each of the four services. For the most part, the values in these objects will be needed across other variations of this client like NCIP1 or something else custom that may have to be written.

The NCIP2Client object understands how to ask each object for the NCIP2 xml and how to send the request to an NCIP2 server and how to ask for the NCIP Response object based on the XML returned. I see this library expanding in the future by creating other Clients (e.g. NCIP1Client) and methods on the objects to support those clients.

The developer using this library can always create one of the four objects and will just need to vary the client object as others are added.