com.ibm.ecm.json

Class JSONViewoneBootstrapResponse

  1. java.lang.Object
  2. extended byjava.util.AbstractMap<K,V>
  3. extended byjava.util.HashMap
  4. extended bycom.ibm.json.java.JSONObject
  5. extended bycom.ibm.ecm.json.JSONResponse
  6. extended bycom.ibm.ecm.json.JSONViewoneBootstrapResponse
All implemented interfaces:
JSONArtifact, java.io.Serializable, java.lang.Cloneable, java.util.Map
  1. public class JSONViewoneBootstrapResponse
  2. extends JSONResponse
This class structures the JSON used to represent a getViewoneBootstrap service response.

There are two ways to use this class:

  1. In plug-in request filters for /repository-type/getViewoneBootstrap services, to produce a custom response that specifies all aspects of the Viewone viewer (Pro or Virtual) launch.
  2. In plug-in response filters for /repository-type/getViewoneBootstrap responses. This class is actually the JSONObject passed to the response filter, so it can be immediately cast, as in: 
     JSONViewoneBootstrapResponse jsonViewoneBootstrapResponse = (JSONViewoneBootstrapResponse) jsonResponse;
    The bootstrap response can be modified through its accessors before being returned to the client.
Since:
2.0.3
See Also:
Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Modifier and Type Field and Description
  1. protected
  2. JSONObject
 viewOneBootstrap
  1. protected
  2. JSONObject
 viewOneParameters

Constructor Summary

Constructor and Description
JSONViewoneBootstrapResponse()

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
 getGetContentUrl()
Returns the currently specified content URL.
  1. void
 setAnnotationHideButtons(java.lang.String annotationHideButtons)
Set the ViewONE annotationHideButtons parameter.
  1. void
 setAnnotationHideContextButtonIds(java.lang.String annotationHideContextButtonIds)
Set the ViewONE annotationHideContextButtonIds parameter.
  1. void
 setAnnotationHideContextButtons(java.lang.String annotationHideContextButtons)
Set the ViewONE annotationHideContextButtons parameter.
  1. void
 setColdTemplateUrl(java.lang.String coldTemplateUrl)
For FileNet COLD documents, specify URL used to retrieve the COLD template corresponding to the document.
  1. void
 setContentElementList(java.util.List<java.lang.Integer> contentElementList)
Specify a list of document parts to Daeja ViewONE.
  1. void
 setCustomAnnotationToolTip(java.lang.String customAnnotationToolTip)
Sets the customAnnotationTooltip parameter of Daeja ViewONE.
  1. void
 setFilenetSystem(int value)
This parameter is FileNet-specific, and is used to specify the system/application that Daeja ViewONE is working with.
  1. void
 setFileNetUG(java.lang.String fileNetUG)
For FileNet Image Services systems only, specifies the URL used to retrieve User Group information.
  1. void
 setFnSecURL(java.lang.String fnSecURL)
For FileNet P8 systems, specifies the URL used to access the security dialog when a user clicks the padlock on the annotation toolbar to open the extended security dialog.
  1. void
 setGetAnnotationUrl(java.lang.String getAnnotationUrl)
Specify the service URL that Daeja ViewONE should call to retrieve document annotations.
  1. void
 setGetContentUrl(java.lang.String getContentUrl)
Specify the service URL that Daeja ViewONE should call to retrieve document content.
  1. protected
  2. void
 setIfNotNull(java.lang.String key,java.lang.String value)
  1. void
 setUpdateAnnotationUrl(java.lang.String updateAnnotationUrl)
Specify the service URL that Daeja ViewONE should call to store annotation changes.
  1. void
 setUserDisplayNameMap(java.util.Map<java.lang.String,java.lang.String> userDisplayNameMap)
Specify a map containing mappings of user symbolic names to user display names.
  1. protected
  2. void
 setV1IfNotNull(java.lang.String key,java.lang.String value)
  1. void
 setViewOneParameter(java.lang.String parameter,java.lang.String value)
Set any Daeja ViewONE parameter by specifying the parameter name and value.
Methods inherited from class com.ibm.ecm.json.JSONResponse
addErrorMessage, addInfoMessage, addWarningMessage, hasErrors
Methods inherited from class com.ibm.json.java.JSONObject
isValidObject, isValidType, parse, parse, parse, put, serialize, serialize, serialize, serialize, serialize, serialize, toString
Methods inherited from class java.util.HashMap
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, putAll, remove, size, values
Methods inherited from class java.util.AbstractMap
equals, hashCode
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Map
equals, hashCode

Field Detail

viewOneBootstrap

  1. protected JSONObject viewOneBootstrap

viewOneParameters

  1. protected JSONObject viewOneParameters

Constructor Detail

JSONViewoneBootstrapResponse

  1. public JSONViewoneBootstrapResponse( )

Method Detail

setGetAnnotationUrl

  1. public void setGetAnnotationUrl( java.lang.String getAnnotationUrl)
Specify the service URL that Daeja ViewONE should call to retrieve document annotations.
Parameters:
getAnnotationUrl -

setUpdateAnnotationUrl

  1. public void setUpdateAnnotationUrl( java.lang.String updateAnnotationUrl)
Specify the service URL that Daeja ViewONE should call to store annotation changes.
Parameters:
updateAnnotationUrl -

setGetContentUrl

  1. public void setGetContentUrl(java.lang.String getContentUrl)
Specify the service URL that Daeja ViewONE should call to retrieve document content.
Parameters:
getContentUrl -

getGetContentUrl

  1. public java.lang.String getGetContentUrl( )
Returns the currently specified content URL. This URL will contain the parameters that identify the repository and document, and can be used as the basis for setting other URLs - such as the annotation retrieval URL.
Returns:
the content retrieval URL

setUserDisplayNameMap

  1. public void setUserDisplayNameMap( java.util.Map<java.lang.String,java.lang.String> userDisplayNameMap)
Specify a map containing mappings of user symbolic names to user display names. In cases where ViewONE annotations contain user symbolic names, Daeja ViewONE will use this map to show display names in the annotation tooltips.
Parameters:
userDisplayNameMap -

setContentElementList

  1. public void setContentElementList( java.util.List<java.lang.Integer> contentElementList)
Specify a list of document parts to Daeja ViewONE. For multi-part/multi-content-element documents, Daeja ViewONE will display the first page of each document part as a page in the viewer. If the document is single-part, do not set this value.
Parameters:
contentElementList -

setColdTemplateUrl

  1. public void setColdTemplateUrl( java.lang.String coldTemplateUrl)
For FileNet COLD documents, specify URL used to retrieve the COLD template corresponding to the document.
Parameters:
coldTemplateUrl -

setAnnotationHideButtons

  1. public void setAnnotationHideButtons( java.lang.String annotationHideButtons)
Set the ViewONE annotationHideButtons parameter. For more information on this parameter, refer to the Daeja ViewONE documentation.
Parameters:
annotationHideButtons -

setAnnotationHideContextButtons

  1. public void setAnnotationHideContextButtons( java.lang.String annotationHideContextButtons)
Set the ViewONE annotationHideContextButtons parameter. For more information on this parameter, refer to the Daeja ViewONE documentation.
Parameters:
annotationHideContextButtons -

setAnnotationHideContextButtonIds

  1. public void setAnnotationHideContextButtonIds( java.lang.String annotationHideContextButtonIds)
Set the ViewONE annotationHideContextButtonIds parameter. For more information on this parameter, refer to the Daeja ViewONE documentation.
Parameters:
annotationHideContextButtonIds -

setFilenetSystem

  1. public void setFilenetSystem(int value)
This parameter is FileNet-specific, and is used to specify the system/application that Daeja ViewONE is working with. The following values are valid:
  • 0 - FileNet Image Services
  • 1 - FileNet Content Services
  • 3 - FileNet P8 Content Engine using AE/Workplace
  • 4 - FileNet P8 Content Engine using WorkplaceXT or IBM Content Navigator.
The default value used in IBM Content Navigator is 4. However, if you are using FileNet Image Services federated with CMIS, you must set the parameter value to 0 to support the use of annotations.
Parameters:
value -

setFileNetUG

  1. public void setFileNetUG(java.lang.String fileNetUG)
For FileNet Image Services systems only, specifies the URL used to retrieve User Group information. This URL is used during display of annotation security dialogs for IS.
Parameters:
fileNetUG -

setFnSecURL

  1. public void setFnSecURL(java.lang.String fnSecURL)
For FileNet P8 systems, specifies the URL used to access the security dialog when a user clicks the padlock on the annotation toolbar to open the extended security dialog.
Parameters:
fnSecURL -

setCustomAnnotationToolTip

  1. public void setCustomAnnotationToolTip( java.lang.String customAnnotationToolTip)
Sets the customAnnotationTooltip parameter of Daeja ViewONE. For more information on this parameter, refer to the Daeja ViewONE documentation.
Parameters:
customAnnotationToolTip -

setViewOneParameter

  1. public void setViewOneParameter( java.lang.String parameter,
  2. java.lang.String value)
Set any Daeja ViewONE parameter by specifying the parameter name and value. Refer to the Daeja ViewONE document for a complete list of available parameters.
Parameters:
parameter -
value -

setIfNotNull

  1. protected void setIfNotNull(java.lang.String key,
  2. java.lang.String value)

setV1IfNotNull

  1. protected void setV1IfNotNull(java.lang.String key,
  2. java.lang.String value)