com.ibm.ecm.json

Class JSONViewoneBootstrapResponse

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

com.ibm.json.java.JSONObject

com.ibm.ecm.json.JSONResponse

com.ibm.ecm.json.JSONViewoneBootstrapResponse

All Implemented Interfaces:

com.ibm.json.java.JSONArtifact, java.io.Serializable, java.lang.Cloneable, java.util.Map

public class JSONViewoneBootstrapResponse
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>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	currentSecurityToken
protected com.ibm.json.java.JSONObject	viewOneBootstrap
protected com.ibm.json.java.JSONObject	viewOneParameters

Constructor Summary

Constructors

Constructor and Description
JSONViewoneBootstrapResponse() Deprecated. - Use JSONViewoneBootstrapResponse(HttpServletRequest request).
JSONViewoneBootstrapResponse(javax.servlet.http.HttpServletRequest request)

Method Summary

Modifier and Type	Method and Description
void	disableEditingAnnotations()
void	disablePrinting()
java.lang.String	getColdTemplateUrl()
java.lang.String	getGetAnnotationUrl()
java.lang.String	getGetContentUrl() Returns the currently specified content URL.
java.lang.String	getUpdateAnnotationUrl()
java.lang.String	getVirtualViewerId()
void	setAnnotationHideButtons(java.lang.String annotationHideButtons) Set the ViewONE annotationHideButtons parameter.
void	setAnnotationHideContextButtonIds(java.lang.String annotationHideContextButtonIds) Set the ViewONE annotationHideContextButtonIds parameter.
void	setAnnotationHideContextButtons(java.lang.String annotationHideContextButtons) Set the ViewONE annotationHideContextButtons parameter.
void	setColdTemplateUrl(java.lang.String coldTemplateUrl) For FileNet COLD documents, specify URL used to retrieve the COLD template corresponding to the document.
void	setContentElementList(java.util.List<java.lang.Integer> contentElementList) Specify a list of document parts to Daeja ViewONE.
void	setContentElementTypeList(java.util.List<java.lang.String> contentElementTypeList) Specify a list of document part types to Daeja ViewONE.
void	setCustomAnnotationToolTip(java.lang.String customAnnotationToolTip) Sets the customAnnotationTooltip parameter of Daeja ViewONE.
void	setDocumentAddMode(java.lang.String value)
void	setDocumentId(java.lang.String documentId)
void	setEditRedactionReasons(java.util.List<RedactionReasonConfig> editRedactionReasonList) Specify the list of redaction reasons that the current user has edit access for.
void	setFilenetSystem(int value) This parameter is FileNet-specific, and is used to specify the system/application that Daeja ViewONE is working with.
void	setFileNetUG(java.lang.String fileNetUG) For FileNet Image Services systems only, specifies the URL used to retrieve User Group information.
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.
void	setGetAnnotationUrl(java.lang.String getAnnotationUrl) Specify the service URL that Daeja ViewONE should call to retrieve document annotations.
void	setGetContentUrl(java.lang.String getContentUrl) Specify the service URL that Daeja ViewONE should call to retrieve document content.
protected void	setIfNotNull(java.lang.String key, java.lang.String value)
void	setPartFileName(java.lang.String value)
void	setRedactionSaveMode(java.lang.String value)
void	setSkipCustomTooltip(boolean value)
void	setUpdateAnnotationUrl(java.lang.String updateAnnotationUrl) Specify the service URL that Daeja ViewONE should call to store annotation changes.
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.
protected void	setV1IfNotNull(java.lang.String key, java.lang.String value)
void	setVersionCheckoutAvailable(boolean value) Flag this document as being available for checkout.
void	setVersioningAvailable(boolean value)
void	setViewOneParameter(java.lang.String parameter, java.lang.String value) Set any Daeja ViewONE parameter by specifying the parameter name and value.
void	setVirtualViewerId(java.lang.String viewerId)

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, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, 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

protected com.ibm.json.java.JSONObject viewOneBootstrap

viewOneParameters

protected com.ibm.json.java.JSONObject viewOneParameters

currentSecurityToken

protected java.lang.String currentSecurityToken

Constructor Detail

JSONViewoneBootstrapResponse

public JSONViewoneBootstrapResponse()

Deprecated. - Use JSONViewoneBootstrapResponse(HttpServletRequest request).

JSONViewoneBootstrapResponse

public JSONViewoneBootstrapResponse(javax.servlet.http.HttpServletRequest request)

Method Detail

setGetAnnotationUrl

public void setGetAnnotationUrl(java.lang.String getAnnotationUrl)

Specify the service URL that Daeja ViewONE should call to retrieve document annotations.

Parameters:

getAnnotationUrl -

getGetAnnotationUrl

public java.lang.String getGetAnnotationUrl()

setUpdateAnnotationUrl

public void setUpdateAnnotationUrl(java.lang.String updateAnnotationUrl)

Specify the service URL that Daeja ViewONE should call to store annotation changes.

Parameters:

updateAnnotationUrl -

getUpdateAnnotationUrl

public java.lang.String getUpdateAnnotationUrl()

setGetContentUrl

public void setGetContentUrl(java.lang.String getContentUrl)

Specify the service URL that Daeja ViewONE should call to retrieve document content.

Parameters:

getContentUrl -

getGetContentUrl

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

setVirtualViewerId

public void setVirtualViewerId(java.lang.String viewerId)

Parameters:

viewerId -

Since:

2.0.3.8

getVirtualViewerId

public java.lang.String getVirtualViewerId()

Returns:

Since:

2.0.3.8

setEditRedactionReasons

public void setEditRedactionReasons(java.util.List<RedactionReasonConfig> editRedactionReasonList)
                             throws java.lang.Exception

Specify the list of redaction reasons that the current user has edit access for.

Parameters:

editRedactionReasonList -

Throws:

java.lang.Exception

Since:

2.0.3.8

setUserDisplayNameMap

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

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 -

setContentElementTypeList

public void setContentElementTypeList(java.util.List<java.lang.String> contentElementTypeList)

Specify a list of document part types 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:

contentElementTypeList -

setColdTemplateUrl

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 -

getColdTemplateUrl

public java.lang.String getColdTemplateUrl()

setAnnotationHideButtons

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

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

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

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

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

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

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 -

setVersionCheckoutAvailable

public void setVersionCheckoutAvailable(boolean value)

Flag this document as being available for checkout.

Parameters:

value - true or false

Since:

2.0.3.5

setVersioningAvailable

public void setVersioningAvailable(boolean value)

setPartFileName

public void setPartFileName(java.lang.String value)

setRedactionSaveMode

public void setRedactionSaveMode(java.lang.String value)

setDocumentAddMode

public void setDocumentAddMode(java.lang.String value)

setSkipCustomTooltip

public void setSkipCustomTooltip(boolean value)

setDocumentId

public void setDocumentId(java.lang.String documentId)

disableEditingAnnotations

public void disableEditingAnnotations()

disablePrinting

public void disablePrinting()

setViewOneParameter

public void setViewOneParameter(java.lang.String parameter,
                                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

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

setV1IfNotNull

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