ServletUrl (webclient 8.1.1-4 API)

java.lang.Object
- com.saperion.ngc.servlet.ServletUrl

```
public final class ServletUrl
extends Object
```
Utility class to construct the URLs required to access the servlets.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ANNOTATIONS` Annotations servlet url part.
`static String`	`BASE_URL` Init parameter for Viewer baseURL.
`static String`	`CLIENT_LOCALE` Client locale attribute.
`static String`	`CONTENT` Content servlet url part.
`static String`	`CONTENT_LIST` Content list session attribute.
`static String`	`DDC_NAME_ATTR` DDC name attribute.
`static String`	`DOC_ELEMENT_ATTR` Name for document element attribute used in streaming-servlet request.
`static String`	`DOWNLOAD_MODE` Download attribute.
`static String`	`EDIT_MODE` Edit mode attribute.
`static String`	`FILENAME_ATTR` Filename attribute.
`static String`	`FILENAME_ENCODING` Charset used to encode the filename.
`static String`	`JADICEANNO` Annotations servlet url part.
`static String`	`JADICESEARCH` Search servlet url part.
`static String`	`MASHUP` Mashup-servlet.
`static String`	`OBJ_ID_ATTR` Name for object id (sysrowid) attribute used in streaming-servlet request.
`static String`	`PDFCONTENT` PDF content Servlet URL part.
`static String`	`REV_CURRENT_REVISION` currentRevision.
`static String`	`REV_ID_ATTR` Name for revision id (hdoc) attribute used in streaming-servlet request.
`static String`	`SAP_NOTES` SAP-Notes retrieval- and storage-servlet.
`static String`	`UPLOAD_ANNOTATIONS` Upload-Annotations servlet url part.
`static String`	`VIEW_CONTENT` View-content servlet url part.
`static String`	`VIEW_TEMPORARY_CONTENT` View-temporary-content servlet url part.
`static String`	`VIEWER_CONTROL` Viewer-Control-Servlet URL part.
`static String`	`VIEWER_ID` Popup-id parameter.
`static String`	`ZIP` ZIP servlet url part.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`constructDocumentUrl(String revisionId, boolean currentRevision, int element, String filename, boolean download, javax.servlet.http.HttpServletRequest request)` Deprecated. download parameter will be removed and set to true in version 8.1. Use `constructDocumentUrl(String, boolean, int, String, HttpServletRequest)` instead.
`static String`	`constructDocumentUrl(String revisionId, boolean currentRevision, int element, String filename, javax.servlet.http.HttpServletRequest request)` Constructs the url to retrieve the document with the specified document id.
`static String`	`constructGetPdfUrl(javax.servlet.http.HttpServletRequest request, String objectId, String revisionId, String ddcName, String filename, boolean currentRevision)` Constructs the URL for a PDF document.
`static String`	`constructGetPdfUrl(javax.servlet.http.HttpServletRequest request, String objectId, String revisionId, String ddcName, String filename, boolean currentRevision, boolean download)` Deprecated. download parameter will be removed and set to true in version 8.1. Use `constructGetPdfUrl(HttpServletRequest, String, String, String, String, boolean)` instead.
`static String`	`constructMashupUrl(String filename, javax.servlet.http.HttpServletRequest request)` Constructs the url that is required to access the mashup-servlet.
`static String`	`constructSapNotesUrl(javax.servlet.http.HttpServletRequest request)` Constructs the URL that can be used to get or post sap notes from or to the SAPViewerNotesServlet.
`static String`	`constructSearchJadiceUrl(javax.servlet.http.HttpServletRequest request, String viewerId)` Constructs the URL needed to fulltext search.
`static String`	`constructTimelineUrl(DocumentId documentId, javax.servlet.http.HttpServletRequest request)` Constructs the url to retrieve revision infos for timeline components.
`static String`	`constructViewAnnotationsUrl(javax.servlet.http.HttpServletRequest request, String viewerId)` Constructs the URL needed to view annotations.
`static String`	`constructViewDocumentUrl(javax.servlet.http.HttpServletRequest request, String viewerId)` Constructs the URL needed to view a document.
`static String`	`constructViewerControlUrl(javax.servlet.http.HttpServletRequest request)` Constructs the URL that can be used to contact the ViewerControlServlet.
`static String`	`constructViewerControlUrl(javax.servlet.http.HttpServletRequest request, String viewerId)` Constructs the URL that can be used to contact the ViewerControlServlet.
`static String`	`constructViewJadiceAnnoUrl(javax.servlet.http.HttpServletRequest request, String viewerId)` Constructs the URL needed to view annotations.
`static String`	`constructViewTemporaryDocumentUrl(javax.servlet.http.HttpServletRequest request, String viewerId)` Constructs the URL needed to view a temporary document.
`static String`	`constructZipUrl(javax.servlet.http.HttpServletRequest request)` Constructs the url to retrieve document content as zip file.
`static String`	`getBaseUrl(javax.servlet.http.HttpServletRequest request)` Returns the base url of the current request without the session id.
`static String`	`getBaseUrl(javax.servlet.http.HttpServletRequest request, String servletUrlPart)` Returns the base url of the current request.
`static String`	`getBaseUrl(javax.servlet.ServletContext servletContext)` Returns the base URL of the webclient.
`static boolean`	`urlSessionTrackingUsed(javax.servlet.http.HttpSession session)` Checks if sessions are tracked by URL-rewriting (adding ;jsessionid).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FILENAME_ENCODING
```
public static final String FILENAME_ENCODING
```
    Charset used to encode the filename.
    
    See Also:
    
    Constant Field Values
  - ANNOTATIONS
```
public static final String ANNOTATIONS
```
    Annotations servlet url part.
    
    See Also:
    
    Constant Field Values
  - JADICEANNO
```
public static final String JADICEANNO
```
    Annotations servlet url part.
    
    See Also:
    
    Constant Field Values
  - JADICESEARCH
```
public static final String JADICESEARCH
```
    Search servlet url part.
    
    See Also:
    
    Constant Field Values
  - UPLOAD_ANNOTATIONS
```
public static final String UPLOAD_ANNOTATIONS
```
    Upload-Annotations servlet url part.
    
    See Also:
    
    Constant Field Values
  - ZIP
```
public static final String ZIP
```
    ZIP servlet url part.
    
    See Also:
    
    Constant Field Values
  - CONTENT
```
public static final String CONTENT
```
    Content servlet url part.
    
    See Also:
    
    Constant Field Values
  - VIEW_CONTENT
```
public static final String VIEW_CONTENT
```
    View-content servlet url part.
    
    See Also:
    
    Constant Field Values
  - VIEW_TEMPORARY_CONTENT
```
public static final String VIEW_TEMPORARY_CONTENT
```
    View-temporary-content servlet url part.
    
    See Also:
    
    Constant Field Values
  - VIEWER_CONTROL
```
public static final String VIEWER_CONTROL
```
    Viewer-Control-Servlet URL part.
    
    See Also:
    
    Constant Field Values
  - PDFCONTENT
```
public static final String PDFCONTENT
```
    PDF content Servlet URL part.
    
    See Also:
    
    Constant Field Values
  - SAP_NOTES
```
public static final String SAP_NOTES
```
    SAP-Notes retrieval- and storage-servlet.
    
    See Also:
    
    Constant Field Values
  - MASHUP
```
public static final String MASHUP
```
    Mashup-servlet.
    
    See Also:
    
    Constant Field Values
  - OBJ_ID_ATTR
```
public static final String OBJ_ID_ATTR
```
    Name for object id (sysrowid) attribute used in streaming-servlet request.
    
    See Also:
    
    Constant Field Values
  - REV_ID_ATTR
```
public static final String REV_ID_ATTR
```
    Name for revision id (hdoc) attribute used in streaming-servlet request.
    
    See Also:
    
    Constant Field Values
  - REV_CURRENT_REVISION
```
public static final String REV_CURRENT_REVISION
```
    currentRevision.
    
    See Also:
    
    Constant Field Values
  - DOC_ELEMENT_ATTR
```
public static final String DOC_ELEMENT_ATTR
```
    Name for document element attribute used in streaming-servlet request.
    
    See Also:
    
    Constant Field Values
  - FILENAME_ATTR
```
public static final String FILENAME_ATTR
```
    Filename attribute.
    
    See Also:
    
    Constant Field Values
  - DDC_NAME_ATTR
```
public static final String DDC_NAME_ATTR
```
    DDC name attribute.
    
    See Also:
    
    Constant Field Values
  - EDIT_MODE
```
public static final String EDIT_MODE
```
    Edit mode attribute.
    
    See Also:
    
    Constant Field Values
  - CLIENT_LOCALE
```
public static final String CLIENT_LOCALE
```
    Client locale attribute.
    
    See Also:
    
    Constant Field Values
  - DOWNLOAD_MODE
```
public static final String DOWNLOAD_MODE
```
    Download attribute.
    
    See Also:
    
    Constant Field Values
  - CONTENT_LIST
```
public static final String CONTENT_LIST
```
    Content list session attribute.
    
    See Also:
    
    Constant Field Values
  - BASE_URL
```
public static final String BASE_URL
```
    Init parameter for Viewer baseURL.
    
    See Also:
    
    Constant Field Values
  - VIEWER_ID
```
public static final String VIEWER_ID
```
    Popup-id parameter.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - constructDocumentUrl
```
@Deprecated
public static String constructDocumentUrl(String revisionId,
                                                       boolean currentRevision,
                                                       int element,
                                                       String filename,
                                                       boolean download,
                                                       javax.servlet.http.HttpServletRequest request)
                                                throws UnsupportedEncodingException
```
    Deprecated. download parameter will be removed and set to true in version 8.1. Use constructDocumentUrl(String, boolean, int, String, HttpServletRequest) instead.
    
    Constructs the url to retrieve the document with the specified document id.
    
    Parameters:
    
    revisionId - the id of the document to retrieve
    
    currentRevision - currentRevision
    
    element - document element
    
    filename - filename of the element
    
    download - set to true to force the browser to open a download box
    overwritten if NgClientConstants.WEBCONFIG_ALWAYS_ATTACH_DOCUMENT_DOWNLOAD is true
    
    request - request
    
    Returns:
    
    url as string
    
    Throws:
    
    UnsupportedEncodingException - unsupported encoding
  - constructDocumentUrl
```
public static String constructDocumentUrl(String revisionId,
                                          boolean currentRevision,
                                          int element,
                                          String filename,
                                          javax.servlet.http.HttpServletRequest request)
                                   throws UnsupportedEncodingException
```
    Constructs the url to retrieve the document with the specified document id.
    Download the document as attachment. Force the browser to open a download box
    
    Parameters:
    
    revisionId - the id of the document to retrieve
    
    currentRevision - currentRevision
    
    element - document element
    
    filename - filename of the element
    
    request - request
    
    Returns:
    
    url as string
    
    Throws:
    
    UnsupportedEncodingException - unsupported encoding
  - constructMashupUrl
```
public static String constructMashupUrl(String filename,
                                        javax.servlet.http.HttpServletRequest request)
```
    Constructs the url that is required to access the mashup-servlet.
    
    Parameters:
    
    filename - Filename
    
    request - current servlet request
    
    Returns:
    
    Mashup URL
  - constructZipUrl
```
public static String constructZipUrl(javax.servlet.http.HttpServletRequest request)
```
    Constructs the url to retrieve document content as zip file. The ZIP servlet requires the list of content to be set as session attribute CONTENT_LIST. (The attribute is removed by the servlet after the ZIP was constructed).
    
    Parameters:
    
    request - request
    
    Returns:
    
    url
  - constructTimelineUrl
```
public static String constructTimelineUrl(DocumentId documentId,
                                          javax.servlet.http.HttpServletRequest request)
```
    Constructs the url to retrieve revision infos for timeline components.
    
    Parameters:
    
    documentId - document id
    
    request - request
    
    Returns:
    
    url
  - getBaseUrl
```
public static String getBaseUrl(javax.servlet.http.HttpServletRequest request,
                                String servletUrlPart)
```
    Returns the base url of the current request. The session id will be contained if the session-tracking-mode is set to URL.
    
    Parameters:
    
    request - request
    
    servletUrlPart - the part of the url that identifies the servlet (with leading /)
    
    Returns:
    
    base url
  - getBaseUrl
```
public static String getBaseUrl(javax.servlet.http.HttpServletRequest request)
```
    Returns the base url of the current request without the session id.
    
    Parameters:
    
    request - request
    
    Returns:
    
    base url
  - constructViewerControlUrl
```
public static String constructViewerControlUrl(javax.servlet.http.HttpServletRequest request)
```
    Constructs the URL that can be used to contact the ViewerControlServlet.
    
    Parameters:
    
    request - servlet request
    
    Returns:
    
    URL as string
  - constructViewerControlUrl
```
public static String constructViewerControlUrl(javax.servlet.http.HttpServletRequest request,
                                               String viewerId)
```
    Constructs the URL that can be used to contact the ViewerControlServlet.
    
    Parameters:
    
    request - servlet request
    
    viewerId - ID of the viewer
    
    Returns:
    
    URL as string
  - constructSapNotesUrl
```
public static String constructSapNotesUrl(javax.servlet.http.HttpServletRequest request)
```
    Constructs the URL that can be used to get or post sap notes from or to the SAPViewerNotesServlet.
    
    Parameters:
    
    request - servlet request
    
    Returns:
    
    URL as string
  - constructViewDocumentUrl
```
public static String constructViewDocumentUrl(javax.servlet.http.HttpServletRequest request,
                                              String viewerId)
```
    Constructs the URL needed to view a document.
    
    Parameters:
    
    request - servlet request
    
    viewerId - viewer ID
    
    Returns:
    
    URL as string
  - constructViewTemporaryDocumentUrl
```
public static String constructViewTemporaryDocumentUrl(javax.servlet.http.HttpServletRequest request,
                                                       String viewerId)
```
    Constructs the URL needed to view a temporary document.
    
    Parameters:
    
    request - servlet request
    
    viewerId - viewer ID
    
    Returns:
    
    URL as string
  - constructViewAnnotationsUrl
```
public static String constructViewAnnotationsUrl(javax.servlet.http.HttpServletRequest request,
                                                 String viewerId)
```
    Constructs the URL needed to view annotations.
    
    Parameters:
    
    request - servlet request
    
    viewerId - viewer ID
    
    Returns:
    
    URL as string
  - constructViewJadiceAnnoUrl
```
public static String constructViewJadiceAnnoUrl(javax.servlet.http.HttpServletRequest request,
                                                String viewerId)
```
    Constructs the URL needed to view annotations.
    
    Parameters:
    
    request - servlet request
    
    viewerId - viewer ID
    
    Returns:
    
    URL as string
  - constructGetPdfUrl
```
@Deprecated
public static String constructGetPdfUrl(javax.servlet.http.HttpServletRequest request,
                                                     String objectId,
                                                     String revisionId,
                                                     String ddcName,
                                                     String filename,
                                                     boolean currentRevision,
                                                     boolean download)
```
    Deprecated. download parameter will be removed and set to true in version 8.1. Use constructGetPdfUrl(HttpServletRequest, String, String, String, String, boolean) instead.
    
    Constructs the url for a PDF document.
    
    Parameters:
    
    request - the http request to set the given parameters
    
    objectId - the sysrowid attribute
    
    revisionId - name for revision id (hdoc) attribute
    
    ddcName - the ddc name
    
    filename - attribute
    
    currentRevision - if true, current revision is used
    
    download - if true, the references PDF will get downloaded and not displayed inline
    
    Returns:
    
    the URL string
  - constructGetPdfUrl
```
public static String constructGetPdfUrl(javax.servlet.http.HttpServletRequest request,
                                        String objectId,
                                        String revisionId,
                                        String ddcName,
                                        String filename,
                                        boolean currentRevision)
```
    Constructs the URL for a PDF document.
    Download the document as attachment. Force the browser to open a download box.
    
    Parameters:
    
    request - the http request to set the given parameters
    
    objectId - the sysrowid attribute
    
    revisionId - name for revision id (hdoc) attribute
    
    ddcName - the ddc name
    
    filename - attribute
    
    currentRevision - if true, current revision is used
    
    Returns:
    
    the request URL as string
  - constructSearchJadiceUrl
```
public static String constructSearchJadiceUrl(javax.servlet.http.HttpServletRequest request,
                                              String viewerId)
```
    Constructs the URL needed to fulltext search.
    
    Parameters:
    
    request - servlet request
    
    viewerId - viewer ID
    
    Returns:
    
    URL as string
  - urlSessionTrackingUsed
```
public static boolean urlSessionTrackingUsed(javax.servlet.http.HttpSession session)
```
    Checks if sessions are tracked by URL-rewriting (adding ;jsessionid). This can be configured in web.xml.
    
    Parameters:
    
    session - current session
    
    Returns:
    
    true if sessions are tracked by URL
  - getBaseUrl
```
public static String getBaseUrl(javax.servlet.ServletContext servletContext)
```
    Returns the base URL of the webclient. If it is configured in webclient.properties, the configured value will be returned. If not, the servlet context is used to auto-determine the URL.
    
    Parameters:
    
    servletContext - the context of the current servlet
    
    Returns:
    
    the base URL of the webclient

Class ServletUrl

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FILENAME_ENCODING

ANNOTATIONS

JADICEANNO

JADICESEARCH

UPLOAD_ANNOTATIONS

ZIP

CONTENT

VIEW_CONTENT

VIEW_TEMPORARY_CONTENT

VIEWER_CONTROL

PDFCONTENT

SAP_NOTES

MASHUP

OBJ_ID_ATTR

REV_ID_ATTR

REV_CURRENT_REVISION

DOC_ELEMENT_ATTR

FILENAME_ATTR

DDC_NAME_ATTR

EDIT_MODE

CLIENT_LOCALE

DOWNLOAD_MODE

CONTENT_LIST

BASE_URL

VIEWER_ID

Method Detail

constructDocumentUrl

constructDocumentUrl

constructMashupUrl

constructZipUrl

constructTimelineUrl

getBaseUrl

getBaseUrl

constructViewerControlUrl

constructViewerControlUrl

constructSapNotesUrl

constructViewDocumentUrl

constructViewTemporaryDocumentUrl

constructViewAnnotationsUrl

constructViewJadiceAnnoUrl

constructGetPdfUrl

constructGetPdfUrl

constructSearchJadiceUrl

urlSessionTrackingUsed

getBaseUrl