imageStampResourceContext parameter

Completes the URL for an annotation image stamp by appending values from the annotationStamp parameter, customAppParameter parameter, and from the codebase by using macros that are extracted by default.

You might have an HTML file that contains the following parameters, for example:

<param name="annotationStamp1" value="image:logo.tif?id=12&otherData=321657" />
<param name="annotationStamp2" value="image:pic.jpg?id=13&otherData=3a2es7" />
<param name="imageStampResourceContext" value="http://localhost:8080/stampservlet? id=${originalStampURL.query.id}" />

The values of the annotationStamp parameters are appended to the value of the imageStampResourceContext parameter. This operation is performed for every image stamp annotation.

Several macros get extracted from each annotationStamp parameter, depending on the parameter format:


${originalStampURL}, this contains the entire value of the corresponding stamp URL
${originalStampURL.protocol}, for example, http
${originalStampURL.host, for example, localhost
${originalStampURL.port}, for example, 8080
${originalStampURL.path}, for example, /myServer/v1files
${originalStampURL.query}, extracts all the query parameters as a single string
${originalStampURL.authority}, for example, localhost:8080

Additionally, single query parameters can be extracted with the following pattern ${originalStampURL.query.paramName}, where paramName is the name of the query parameter in the corresponding annotation stamp URL. For example:

${originalStampURL.query.id}: Refers to a specific query parameter appended to the annotationStamp URL that the viewer extracts.

If you have an HTML file that contains the following parameters, the viewer completes the URL for each annotation image stamp by appending values that are extracted from the annotationStamp parameters and from the customAppParameter parameters:

<param name="customAppParameter1" value="<id=32>" />
<param name="customAppParameter2" value="<security_token=sf1w5e1fr3>" />
<param name="annotationStamp1" value="image:logo.tif?id=12&otherData=321657" />
<param name="annotationStamp2" value="image:pic.jpg?id=13&otherData=3a2es7" />
<param name="imageStampResourceContext" value="http://localhost:8080/stampservlet?
id=${originalStampURL.query.id}&security=${customAppParameter.security_token}" />

In this instance, the final URL used to retrieve the second annotation stamp is http://localhost:8080/stampservlet?id=13&security=sf1w5e1fr3.

Important: If you are using the jiBurner toolkit, custom app parameters in the imageStampResourceContext parameter can be substituted only if they are provided to the jiBurner toolkit by using the setDocumentConfig(Hashtable config) API call.


Hashtable config = new Hashtable(); 
config.put("imageStampResourceContext", 
"http://localhost:8080/myServer/v1files/?id=${customContextParameter.id}&sec=${customContextParameter.security_token}"); 
config.put("customAppParameter1", "<file=stamp.png>"); 
burnerInstance.setDocumentConfig(config);

Example

<param name="imageStampResourceContext" value="http://localhost:8080/stampservlet
?id=${originalStampURL.query.id}&security=${customAppParameter.security_token}" />