com.saperion.ngc.sapviewer

Class SAPViewerUrl

java.lang.Object

com.saperion.ngc.sapviewer.SAPViewerUrl

public class SAPViewerUrl
extends Object

This is the parser for SAPViewer URLs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DDC_TAG URL tag for DDC name.
static String	DOCID_TAG URL tag for document ID.
static String	DOWNLOAD_ALLOWED Property in control bean used to store if downloading is allowed or not.
static String	LINKTAG URL tag for WebLink mode.
static String	MAINTAG URL tag for WebView mode.
static String	SAPVIEWER_PREFIX Prefix for client instance ID of applet.
static String	USER_TAG URL tag for user name.

Constructor Summary

Constructors

Constructor and Description
SAPViewerUrl()

Method Summary

Methods

Modifier and Type	Method and Description
OpenDocumentBean	createControlBeanAndLogin(String url, javax.servlet.http.HttpServletRequest servletRequest, String viewerId) Parses the SAPViewer-URL, performs a login if required and created the viewer-control-bean.
static String	getRandomViewerId()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOWNLOAD_ALLOWED

public static final String DOWNLOAD_ALLOWED

Property in control bean used to store if downloading is allowed or not.

See Also:

Constant Field Values

MAINTAG

public static final String MAINTAG

URL tag for WebView mode.

See Also:

Constant Field Values

LINKTAG

public static final String LINKTAG

URL tag for WebLink mode.

See Also:

Constant Field Values

DOCID_TAG

public static final String DOCID_TAG

URL tag for document ID.

See Also:

Constant Field Values

USER_TAG

public static final String USER_TAG

URL tag for user name.

See Also:

Constant Field Values

DDC_TAG

public static final String DDC_TAG

URL tag for DDC name.

See Also:

Constant Field Values

SAPVIEWER_PREFIX

public static final String SAPVIEWER_PREFIX

Prefix for client instance ID of applet.

See Also:

Constant Field Values

Constructor Detail

SAPViewerUrl

public SAPViewerUrl()

Method Detail

createControlBeanAndLogin

public OpenDocumentBean createControlBeanAndLogin(String url,
                                         javax.servlet.http.HttpServletRequest servletRequest,
                                         String viewerId)
                                           throws AuthenticationException,
                                                  SystemException,
                                                  DocumentLockException,
                                                  SapViewerUrlException

Parses the SAPViewer-URL, performs a login if required and created the viewer-control-bean.

Parameters:

url - the URL to parse

servletRequest - the current request sent from the client

viewerId - the ID of the current viewer

Returns:

the bean containing the information about the document to open

Throws:

AuthenticationException - Exception when logging in

SystemException - Exception when parsing the url or when reading the document

DocumentLockException - document is locked

SapViewerUrlException - when the url was invalid

getRandomViewerId

public static String getRandomViewerId()

Returns:

a string to be used as client instance id for the applet