de.innovationgate.wgpublisher.jsputils

Class JspHelper

java.lang.Object

de.innovationgate.wgpublisher.jsputils.JspHelper

public class JspHelper
extends java.lang.Object

Object to be used inside JSP scriptlets in TML modules, that can be used to retrieve WGA data.

Constructor Summary

Constructors

Constructor and Description
JspHelper(javax.servlet.jsp.PageContext pageContext) Constructor, taking the page context.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	fullDateFormat(java.util.Date date)
java.lang.String	fullDateTimeFormat(java.util.Date date)
java.lang.String	fullTimeFormat(java.util.Date date)
TMLContext	getContextFromTag(java.lang.String id) Retrieves a TMLContext object for the context of a specified WebTML tag.
WGACore	getCore() Returns the WGA core object
de.innovationgate.webgate.api.WGDatabase	getDatabase(java.lang.String key) Fetches a database by the given key, without opening it.
java.util.Collection<java.lang.String>	getDatabaseKeys() Returns the database keys of available Databases in WGA
WGPDispatcher	getDispatcher() Returns the dispatcher servlet of WGA
java.util.PropertyResourceBundle	getLabels(java.lang.String baseName) Returns labels for a given language name
TMLContext	getMainContext() Returns a TMLContext object for the main context of the current request.
javax.servlet.jsp.PageContext	getPageContext() Serves the JSP page context again
java.lang.String	getPublisherPath() Returns the path to the WGAPublisher on this server, excluding any additional path information.
java.lang.String	getRequestPath() Returns the complete URL to this request
WGAError	getWGAError()
boolean	isAdminLoggedIn()
boolean	isBrowserInterface()
java.lang.String	longDateFormat(java.util.Date date)
java.lang.String	longDateTimeFormat(java.util.Date date)
java.lang.String	longTimeFormat(java.util.Date date)
java.lang.String	mediumDateFormat(java.util.Date date)
java.lang.String	mediumDateTimeFormat(java.util.Date date)
java.lang.String	mediumTimeFormat(java.util.Date date)
java.lang.String	numberFormat(java.lang.Number num)
de.innovationgate.webgate.api.WGDatabase	openDatabase(java.lang.String key) Opens the database with the given key.
de.innovationgate.webgate.api.WGDatabase	openDatabase(de.innovationgate.webgate.api.WGDatabase db) Opens the given database object with the domain login of the current user, or anonymous if there is none.
void	setContentType(java.lang.String contentType)
java.lang.String	shortDateFormat(java.util.Date date)
java.lang.String	shortDateTimeFormat(java.util.Date date)
java.lang.String	shortTimeFormat(java.util.Date date)
void	writeContentInfo() Writes content information script block based on the request path.

Methods inherited from class java.lang.Object

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

Constructor Detail

JspHelper

public JspHelper(javax.servlet.jsp.PageContext pageContext)

Constructor, taking the page context.

Method Detail

getDatabaseKeys

public java.util.Collection<java.lang.String> getDatabaseKeys()

Returns the database keys of available Databases in WGA

getDispatcher

public WGPDispatcher getDispatcher()

Returns the dispatcher servlet of WGA

getCore

public WGACore getCore()

Returns the WGA core object

openDatabase

public de.innovationgate.webgate.api.WGDatabase openDatabase(java.lang.String key)
                                                      throws de.innovationgate.webgate.api.WGException

Opens the database with the given key. The login used is an existing login for the database's domain or anonymous if none yet exists.

Parameters:

key - The database key

Returns:

The database object

Throws:

de.innovationgate.webgate.api.WGUnavailableException

de.innovationgate.webgate.api.WGException

openDatabase

public de.innovationgate.webgate.api.WGDatabase openDatabase(de.innovationgate.webgate.api.WGDatabase db)
                                                      throws de.innovationgate.webgate.api.WGException

Opens the given database object with the domain login of the current user, or anonymous if there is none.

Parameters:

db - The database to open

Returns:

The WGAPI database object

Throws:

de.innovationgate.webgate.api.WGException

getDatabase

public de.innovationgate.webgate.api.WGDatabase getDatabase(java.lang.String key)
                                                     throws de.innovationgate.webgate.api.WGException

Fetches a database by the given key, without opening it. There will be no session open unless some earlier code has opened the database.

Parameters:

key - The database key

Returns:

WGDatabase

Throws:

de.innovationgate.webgate.api.WGException

getRequestPath

public java.lang.String getRequestPath()

Returns the complete URL to this request

getPublisherPath

public java.lang.String getPublisherPath()

Returns the path to the WGAPublisher on this server, excluding any additional path information.

getContextFromTag

public TMLContext getContextFromTag(java.lang.String id)

Retrieves a TMLContext object for the context of a specified WebTML tag.

Parameters:

id - The ID of the WebTML tag.

getMainContext

public TMLContext getMainContext()

Returns a TMLContext object for the main context of the current request.

getLabels

public java.util.PropertyResourceBundle getLabels(java.lang.String baseName)

Returns labels for a given language name

Parameters:

baseName - The language name

Returns:

Labels of that language as PropertyResourceBundle

isBrowserInterface

public boolean isBrowserInterface()

isAdminLoggedIn

public boolean isAdminLoggedIn()

getWGAError

public WGAError getWGAError()

shortDateFormat

public java.lang.String shortDateFormat(java.util.Date date)

fullDateFormat

public java.lang.String fullDateFormat(java.util.Date date)

longDateFormat

public java.lang.String longDateFormat(java.util.Date date)

mediumDateFormat

public java.lang.String mediumDateFormat(java.util.Date date)

shortDateTimeFormat

public java.lang.String shortDateTimeFormat(java.util.Date date)

fullTimeFormat

public java.lang.String fullTimeFormat(java.util.Date date)

longTimeFormat

public java.lang.String longTimeFormat(java.util.Date date)

mediumTimeFormat

public java.lang.String mediumTimeFormat(java.util.Date date)

shortTimeFormat

public java.lang.String shortTimeFormat(java.util.Date date)

fullDateTimeFormat

public java.lang.String fullDateTimeFormat(java.util.Date date)

longDateTimeFormat

public java.lang.String longDateTimeFormat(java.util.Date date)

mediumDateTimeFormat

public java.lang.String mediumDateTimeFormat(java.util.Date date)

numberFormat

public java.lang.String numberFormat(java.lang.Number num)

setContentType

public void setContentType(java.lang.String contentType)

writeContentInfo

public void writeContentInfo()
                      throws java.io.IOException

Writes content information script block based on the request path. This is meant to be used on WGA error pages to provide minimal information about the requested content to WGA Content Manager.

Throws:

java.io.IOException

getPageContext

public javax.servlet.jsp.PageContext getPageContext()

Serves the JSP page context again