ACE Ims API - Revision history

Toaster at 20:43, 9 September 2008

2008-09-09T20:43:04Z

← Older revision		Revision as of 20:43, 9 September 2008
Line 9:		Line 9:
	* ace-common.jar - shared ACE components, error message constants, etc		* ace-common.jar - shared ACE components, error message constants, etc
	* adapt-util.jar - Utility classes, string parsing, etc		* adapt-util.jar - Utility classes, string parsing, etc
	* [[http://logging.apache.org/log4j/ Log4j-1.2.15.jar]] - Logging for the API		* [http://logging.apache.org/log4j/ Log4j-1.2.15.jar] - Logging for the API

	'''Sample Code'''		'''Sample Code'''

Toaster at 20:42, 9 September 2008

2008-09-09T20:42:31Z

← Older revision		Revision as of 20:42, 9 September 2008
Line 106:		Line 106:
	==Complete Registration Sample==		==Complete Registration Sample==

	A complete sample is available [[ImsBatchSample.java\|BatchSample.java]]		A complete sample is available [[Media:ImsBatchSample.java\|BatchSample.java]]

	==Token Validation==		==Token Validation==

Toaster at 20:41, 9 September 2008

2008-09-09T20:41:30Z

← Older revision		Revision as of 20:41, 9 September 2008
Line 3:		Line 3:
	==Getting Started==		==Getting Started==

	* Javadoc.		* Javadoc

	'''Required Components'''		'''Required Components'''
Line 9:		Line 9:
	* ace-common.jar - shared ACE components, error message constants, etc		* ace-common.jar - shared ACE components, error message constants, etc
	* adapt-util.jar - Utility classes, string parsing, etc		* adapt-util.jar - Utility classes, string parsing, etc
	* Log4j-1.2.15.jar - Logging for the API		* [[http://logging.apache.org/log4j/ Log4j-1.2.15.jar]] - Logging for the API

	'''Sample Code'''		'''Sample Code'''

Toaster at 20:34, 9 September 2008

2008-09-09T20:34:54Z

← Older revision		Revision as of 20:34, 9 September 2008
Line 24:		Line 24:
	==Token Creation==		==Token Creation==

	The IMS provides the ~~<nop>~~TokenRequestBatch service that can be used to bulk register tokens. The service is available from your ims connection. It requires a name of your token service, a [[#RequestBatchCallback][RequestBatchCallback]] to notify you when tokens have been registered, max mumber of tokens to send on one call, and how many milliseconds to wait at most before a call.		The IMS provides the TokenRequestBatch service that can be used to bulk register tokens. The service is available from your ims connection. It requires a name of your token service, a [[#RequestBatchCallback\|RequestBatchCallback]] to notify you when tokens have been registered, max mumber of tokens to send on one call, and how many milliseconds to wait at most before a call.

	<pre>		<pre>
Line 56:		Line 56:
	===RequestBatchCallback===		===RequestBatchCallback===

	The ~~<nop>~~RequestBatchCallback handles responses from the IMS. It provides three methods that will be called when an IMS request returns. Please note, this will be called from an internally created thread and not the thread that called batch.add(). Implementers should take care to make sure there are no threading issues between adding requests and receiving responses.		The RequestBatchCallback handles responses from the IMS. It provides three methods that will be called when an IMS request returns. Please note, this will be called from an internally created thread and not the thread that called batch.add(). Implementers should take care to make sure there are no threading issues between adding requests and receiving responses.

	<pre>		<pre>
Line 106:		Line 106:
	==Complete Registration Sample==		==Complete Registration Sample==

	A complete sample is available		A complete sample is available [[ImsBatchSample.java\|BatchSample.java]]

	==Token Validation==		==Token Validation==

Toaster at 20:33, 9 September 2008

2008-09-09T20:33:39Z

← Older revision		Revision as of 20:33, 9 September 2008
Line 12:		Line 12:

	'''Sample Code'''		'''Sample Code'''
	* [[Media:ImsBatchSample~~.Java]]~~		* [[Media:ImsBatchSample.java\|BatchSample.java]]
	* [[%ATTACHURL%/BatchSample.java][BatchSample.java]]

	==Connect to IMS==		==Connect to IMS==

Toaster at 20:33, 9 September 2008

2008-09-09T20:33:02Z

← Older revision		Revision as of 20:33, 9 September 2008
Line 12:		Line 12:

	'''Sample Code'''		'''Sample Code'''
			* [[Media:ImsBatchSample.Java]]
	* [[%ATTACHURL%/BatchSample.java][BatchSample.java]]		* [[%ATTACHURL%/BatchSample.java][BatchSample.java]]

Toaster at 19:33, 9 September 2008

2008-09-09T19:33:27Z

← Older revision		Revision as of 19:33, 9 September 2008
Line 1:		Line 1:
			The Java IMS api provides a mechanism to both create tokens and validate existing tokens against the IMS. There are four jars required for the API. The API has been designed to work for Java 1.6.0 or greater.

			==Getting Started==
	==~~Overview~~==
	The Java IMS api provides a mechanism to both create tokens and validate existing tokens against the IMS. There are four jars required for the API. The API has been designed to work for Java 1.6.0 or greater.

	* Javadoc.		* Javadoc.

Toaster at 19:32, 9 September 2008

2008-09-09T19:32:51Z

← Older revision		Revision as of 19:32, 9 September 2008
Line 1:		Line 1:


			==Overview==
	The Java IMS api provides a mechanism to both create tokens and validate existing tokens against the IMS. There are four jars required for the API. The API has been designed to work for Java 1.6.0 or greater.		The Java IMS api provides a mechanism to both create tokens and validate existing tokens against the IMS. There are four jars required for the API. The API has been designed to work for Java 1.6.0 or greater.

	* Javadoc.		* Javadoc.

	'''Required Components'''		'''Required Components'''
	* ims-api.jar - API classes		* ims-api.jar - API classes
	* ace-common.jar - shared ACE components, error message constants, etc		* ace-common.jar - shared ACE components, error message constants, etc
	* adapt-util.jar - Utility classes, string parsing, etc		* adapt-util.jar - Utility classes, string parsing, etc
	* Log4j-1.2.15.jar - Logging for the API		* Log4j-1.2.15.jar - Logging for the API

	'''Sample Code'''		'''Sample Code'''
	* [[%ATTACHURL%/BatchSample.java][BatchSample.java]]		* [[%ATTACHURL%/BatchSample.java][BatchSample.java]]

	==Connect to IMS==		==Connect to IMS==
Line 56:		Line 59:
	The <nop>RequestBatchCallback handles responses from the IMS. It provides three methods that will be called when an IMS request returns. Please note, this will be called from an internally created thread and not the thread that called batch.add(). Implementers should take care to make sure there are no threading issues between adding requests and receiving responses.		The <nop>RequestBatchCallback handles responses from the IMS. It provides three methods that will be called when an IMS request returns. Please note, this will be called from an internally created thread and not the thread that called batch.add(). Implementers should take care to make sure there are no threading issues between adding requests and receiving responses.

	<~~source lang=java~~>		<pre>
	class BatchCallback implements RequestBatchCallback		class BatchCallback implements RequestBatchCallback
	{		{
Line 100:		Line 103:
	}		}
	}		}
	</~~source~~>		</pre>

	==Complete Registration Sample==		==Complete Registration Sample==

Toaster at 19:31, 9 September 2008

2008-09-09T19:31:51Z

← Older revision		Revision as of 19:31, 9 September 2008
Line 16:		Line 16:
	All communication with the IMS is handled through the IMSService class.		All communication with the IMS is handled through the IMSService class.

	<~~source lang=java~~>		<pre>
	IMSService ims = IMSService.connect("ims.umiacs.umd.edu", 8080);		IMSService ims = IMSService.connect("ims.umiacs.umd.edu", 8080);
	</~~source~~>		</pre>

	==Token Creation==		==Token Creation==
Line 24:		Line 24:
	The IMS provides the <nop>TokenRequestBatch service that can be used to bulk register tokens. The service is available from your ims connection. It requires a name of your token service, a [[#RequestBatchCallback][RequestBatchCallback]] to notify you when tokens have been registered, max mumber of tokens to send on one call, and how many milliseconds to wait at most before a call.		The IMS provides the <nop>TokenRequestBatch service that can be used to bulk register tokens. The service is available from your ims connection. It requires a name of your token service, a [[#RequestBatchCallback][RequestBatchCallback]] to notify you when tokens have been registered, max mumber of tokens to send on one call, and how many milliseconds to wait at most before a call.

	<~~source lang="java"~~>		<pre>
	// create service		// create service
	TokenRequestBatch batch = ims.createImmediateTokenRequestBatch("SHA-256-0", new BatchCallback(), 1000, 5000);		TokenRequestBatch batch = ims.createImmediateTokenRequestBatch("SHA-256-0", new BatchCallback(), 1000, 5000);
Line 34:		Line 34:
	// shutdown registration thread and block until all outstanding requests have been serviced		// shutdown registration thread and block until all outstanding requests have been serviced
	batch.close();		batch.close();
	</~~source~~>		</pre>

	The TokenRequestBatch will spawn off a thread that handles all communication with the IMS. This means the batch.add call is nonblocking and can be used in a loop to add many files. The batch will add files to a queue and when any of the thresholds used to create the batch are met, a request will be sent to the IMS.		The TokenRequestBatch will spawn off a thread that handles all communication with the IMS. This means the batch.add call is nonblocking and can be used in a loop to add many files. The batch will add files to a queue and when any of the thresholds used to create the batch are met, a request will be sent to the IMS.

	<~~source lang=java~~>		<pre>
	File[] fileList = getListOfFiles(...);		File[] fileList = getListOfFiles(...);
	for (File file : fileList)		for (File file : fileList)
Line 49:		Line 49:
	}		}
	batch.close();		batch.close();
	</~~source~~>		</pre>

Toaster at 19:29, 9 September 2008

2008-09-09T19:29:21Z

← Older revision		Revision as of 19:29, 9 September 2008
Line 16:		Line 16:
	All communication with the IMS is handled through the IMSService class.		All communication with the IMS is handled through the IMSService class.

	<~~verbatim~~>		<source lang=java>
	IMSService ims = IMSService.connect("ims.umiacs.umd.edu", 8080);		IMSService ims = IMSService.connect("ims.umiacs.umd.edu", 8080);
	</~~verbatim~~>		</source>

	==Token Creation==		==Token Creation==
Line 24:		Line 24:
	The IMS provides the <nop>TokenRequestBatch service that can be used to bulk register tokens. The service is available from your ims connection. It requires a name of your token service, a [[#RequestBatchCallback][RequestBatchCallback]] to notify you when tokens have been registered, max mumber of tokens to send on one call, and how many milliseconds to wait at most before a call.		The IMS provides the <nop>TokenRequestBatch service that can be used to bulk register tokens. The service is available from your ims connection. It requires a name of your token service, a [[#RequestBatchCallback][RequestBatchCallback]] to notify you when tokens have been registered, max mumber of tokens to send on one call, and how many milliseconds to wait at most before a call.

	<source lang=java>		<source lang="java">
	// create service		// create service
	TokenRequestBatch batch = ims.createImmediateTokenRequestBatch("SHA-256-0", new BatchCallback(), 1000, 5000);		TokenRequestBatch batch = ims.createImmediateTokenRequestBatch("SHA-256-0", new BatchCallback(), 1000, 5000);