psdi.webclient.system.runtime

Class WebClientRuntime

java.lang.Object

psdi.webclient.system.runtime.WebClientRuntime

public class WebClientRuntime
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static char[]	HEXDIGITS A table of hex digits
static java.util.HashMap<java.lang.Character,java.lang.Integer>	keycode
static int	MSG_BTNCANCEL
static int	MSG_BTNNO
static int	MSG_BTNOK
static int	MSG_BTNYES
static java.lang.String	MXE_WEBCLIENT_ASYNCRENDERTIMELIMIT A constant for the Tpae system property which is used to determine maximum amount of seconds to elapse between rendering of the page when handling asynchronous requests.
static java.lang.String	MXE_WEBCLIENT_DEEPREQUIREDCHECK A constant for the Tpae system property which is used to determine if the framework will perform a a check for all required fields when saving
static java.lang.String	MXE_WEBCLIENT_MAXASYNCREQUESTSBEFORERENDER A constant for the Tpae system property mxe.webclient.maxasyncrequestsbeforerender which is used to determine the maximum number of asynchronous requests to be handled before a render is sent to the page.
static java.lang.String	PORTLET_CACHE_PREFIX A constant for naming the cache of portlet specific info in the current start center.
static java.lang.String	PORTLETLAYOUT_CACHE_NAME A constant for naming the cache of portlet layout for a current start center
static java.lang.String	PORTLETLAYOUT_CACHE_UID A constant for naming the cache that contains the uid for the contents in the Portlet Layout cache
static java.lang.String	PORTLETS_ALLOWED_CACHE A constant for naming the cache of portlets that are allowed.
static java.lang.String	ROWMARKID
RuntimeServiceability	serviceability
static java.lang.String	SPECIALSAVECHARS Deprecated. Since 7.5.0.1
static java.lang.String	STARTCENTER_CACHE_NAME A constant for naming the cache of start center list and info for the current user
static java.lang.String	STARTCENTER_UID_CACHE_NAME A constant for naming the uid of a start center.

Method Summary

Modifier and Type	Method and Description
FieldClassInfo	addFieldClassInfo(FieldClassInfo fci) Adds a FieldClassInfo object to the fieldClassInfo cache
static java.lang.String	addRowMarker(java.lang.String id, int row) Adds a row marker to a String (used for id's)
static void	addToTranslatableLabels(java.lang.String type, java.lang.String key)
void	addWebClientSession(javax.servlet.http.HttpSession httpSession, WebClientSession wcs) Deprecated. use WebClientSessionFactory createSession()
static java.lang.String[]	breakupMsgLookup(java.lang.String lookup) Breas messages lookup, generally specified as proeperties into group and key part making it ready to be used for getMessage call. For.e.g ui#startlable will be broken into an array of 2 of ui and startlable
void	cacheExcludeApps()
boolean	canBeUsedInRecordHover(java.lang.String controlType) Returns true if the passed in control type is support within a recordhover control.
boolean	canUseStaticIds() Returns true if UI should use static mxids rather than sequence based sceheme
static WebClientEvent	checkSession(WebClientSession wcs, WebClientEvent event) Deprecated. as of MBS 7.1.1.6. Replaced by RequestManager checkSession
static boolean	containsRowMarker(java.lang.String value)
static java.lang.String	createSendEventString(java.lang.String event, java.lang.String target, java.lang.String val, int jsMethod) Creates a sendEvent string to be used in jsp's where components cannot do the same thing.
static java.lang.String	createStatusText(MXException[] warnings, WebClientSession wcs) Transforms the warnings array to a String.
static java.lang.String	csvStringFromArray(java.lang.Object[] values) Returns helper method to return a string of comma separated values from an array of objects
static java.lang.String	decodeSafevalue(java.lang.String value) Deprecated. Use HTML.decode(String)
static java.lang.String	doubleUpQuotes(java.lang.String inputData) This function takes a passed in string and returns it with all single quotes 'Doubled Up' to prevent then from being parsed by Oracle as being the end of the field.
static java.lang.String	escapeForJScript(java.lang.String str) Escapes the characters for JScript alert() method
static java.lang.String	findAttribute(java.lang.String name, org.w3c.dom.Element element)
static org.w3c.dom.Element	findChildElement(org.w3c.dom.Element element, java.lang.String id, boolean isCaseSensitive) Finds the first child element with attribute 'id' equal to the parameter id.
static org.w3c.dom.Element	findChildElementByTagName(org.w3c.dom.Element element, java.lang.String tagName) Finds the first child element with tagName Walks recursively the child tree
static org.w3c.dom.Element	findElement(org.w3c.dom.Element element, java.lang.String id) Finds the first element with attribute 'id' equal to the parameter id.
static org.w3c.dom.Element	findElement(org.w3c.dom.Element element, java.lang.String id, boolean isCaseSensitive) Finds the first element with attribute 'id' equal to the parameter id.
static org.w3c.dom.Element	findElementByTagName(org.w3c.dom.Element element, java.lang.String tagName) Finds the first element with tagName Walks recursively the child tree
static java.lang.String	formatDataString(java.lang.String dataString) Deprecated. Deprecated as of 7.5.0.1: It is not possible to escape all characters using this method. Use something like this instead: decodeURIComponent('<%=URLEncode.encode(value)%>')
static java.lang.String	formatStringForTags(java.lang.String str) Deprecated. Since 7.5.0.2 Use HTML.encodeTolerant(String)
static long	formatStringUniqueId(java.lang.String tempStr, java.util.Locale userlocale) Formats a string meant for uniqueid, by stripping off, the seperator and decimal seperator based on current locale
static java.lang.String	getAppDescFromCache(java.lang.String appId, MXSession mxs) Added to support calling with no language Code
static java.lang.String	getAppDescFromCache(java.lang.String appId, MXSession mxs, java.lang.String langCode) Method to catch application description
AppDescriptor	getAppDescriptor(java.lang.String appName) Method to get an app descriptor by app name out of the descriptor index.
AppDescriptor	getAppDescriptor(java.lang.String appName, WebClientSession wcs) factory method to return an app descriptor.
static java.lang.String	getAppName(org.w3c.dom.Element element) Searches the element dom to get the name of the presentation.
static java.util.Map<java.lang.String,SigOptionInfo>	getAppSigOptionList(java.lang.String appId) Returns a Map containing all possible sigoption for an application regardless of whether or not the user has access to them.
java.lang.String	getAppXML(java.lang.String appName) Return Save string object of the presentation xml
static java.lang.String	getCacheIdForAppName(java.lang.String Id) getCacheIdForAppName return String the app name with suffix , if tenant enable it will return appname with tenant id .
CmsMenuDescriptor	getCmsMenuDescriptor(java.lang.String mboName, java.lang.String menuItem)
com.ibm.json.java.JSONObject	getCmsMenuDescriptorObject(DataBean bean, java.lang.String menuId)
com.ibm.tivoli.contextmenuservice.ICmsRegistry	getCMSRegistry()
ComponentDescriptor	getComponentDescriptor(java.lang.String type)
ControlDescriptor	getControlDescriptor(java.lang.String type)
int	getDateFieldSize()
int	getDateTimeFieldSize()
com.ibm.tivoli.dataintegration.DataIntegrationServices	getDisObject()
static java.lang.String	getDojoDirectory(javax.servlet.http.HttpServletRequest request) Returns the directory under the /webclient/javascript path that contains the latest version of Dojo.
java.lang.String	getElementProperty(org.w3c.dom.Element xmlControlElement, ControlDescriptor cd, java.lang.String propName) Get's the property value from the descriptor or the XML element for the control.
EntityRelationshipModel	getEntityRelationshipModel(java.lang.String app) Returns the EntityRelationshipModel for the given app.
java.util.Properties	getExcludeApps(java.lang.String appName)
FieldClassInfo	getFieldClassInfo(java.lang.String name) Method to get a fieldClassInfo by class name out of the index.
int	getFieldPadding()
int	getFieldSize(boolean onTable, int maxtype, int datalength) Returns the size of the field based on its data type and data length.
int	getFieldSize(boolean onTable, java.lang.String maxtype, int datalength) Translates the textual representation of the maxtype and delegates to getFieldSize(int, int)
double	getFieldSizeFactor()
int	getFieldSizeMaximum()
static java.lang.String[]	getHelpString(java.lang.String propvalue) Get help string array of packagename and filename.
java.lang.String	getHelpUrl(java.lang.String packagename, java.lang.String filename, java.lang.String langcode) Get help url value
static java.lang.String	getHost()
static java.lang.String	getHostAddress()
LibraryDescriptor	getLibraryDescriptor(java.lang.String libraryName, WebClientSession wcs)
static java.lang.Object[]	getLocaleFromRequest(javax.servlet.http.HttpServletRequest request) Returns an object array with two objects.
static java.lang.String	getMaximoBaseURL(javax.servlet.http.HttpServletRequest request) Reconstructs the BASE URL the client used to make the request.
static java.lang.String	getMaximoRequestContextURL(javax.servlet.http.HttpServletRequest request) Reconstructs the Maximo Request Context Path.
static java.lang.String	getMaximoRequestURL(javax.servlet.http.HttpServletRequest request) Reconstructs the URL the client used to make the request.
static int	getMaxTypeAsInt(java.lang.String type) Converts the string representation of a MAXTYPE to integer code.
static int	getMTtenantId() getMTtenantId() to get the tenant Id, for thread , it returns ID Of the tenant
static MXSession	getMXSession(javax.servlet.http.HttpSession session)
java.lang.String	getOptionMenu(java.lang.String appName, java.lang.String sigOption)
static java.lang.String	getPrependValue(java.lang.String prependString) Used to get the prepend value which are otheriwse unsafe characters in XML
PresentationCache	getPresentationCache() Returns the PresentationCache for this jvm
java.lang.String	getPropFromElement(org.w3c.dom.Element xmlControlElement, java.lang.String propName)
java.util.HashMap<java.lang.String,java.io.InputStream>	getPropsFromJar(java.lang.String productDir)
static int	getRowFromId(java.lang.String id) Parse the row out of an id String
java.lang.String	getSkin() Return the current skin being used system-wide.
java.util.HashMap<java.lang.String,java.io.InputStream>	getStreamFromJar(java.lang.String productDir)
java.util.HashMap<java.lang.String,java.lang.String>	getSupportedContainer(java.lang.String ctrlType)
int	getTablecolSizeDefault()
double	getTablecolSizeFactor()
int	getTimeFieldSize()
ToolBoxDescriptor	getToolBoxDescriptor(java.lang.String toolboxName, WebClientSession wcs)
static java.lang.String	getTranslatableLabels(java.lang.String type, java.lang.String key)
static java.lang.String	getWebClientProperty(java.lang.String prop) Retrieves a property from the webclient.property file.
static java.lang.String	getWebClientProperty(java.lang.String prop, java.lang.String defaultValue) Retrieves a property from the webclient.property file.
static WebClientRuntime	getWebClientRuntime() Factory method that returns a reference to a webclientruntime object.
WebClientSession	getWebClientSession(javax.servlet.http.HttpServletRequest request) Returns the WebClientSession associated with the passed in request.
static java.lang.String	getWebClientSystemProperty(java.lang.String prop) Retrieves a property from the System Properties application.
static java.lang.String	getWebClientSystemProperty(java.lang.String prop, java.lang.String defaultValue) Retrieves a property from the System Properties application.
static boolean	hasInvalidXMLChars(java.lang.String value)
boolean	hasLicenseAccess(java.lang.String licensevalue)
static boolean	isAllLatin(java.lang.String titleString) Determines if a string has a character that is not from LATIN based unicode blocks This method is used in determining when and how much a graph titled can be wrapped. Non latin based characters take more pixels to display.
boolean	isCmsEnabled()
static boolean	isMTEnabled() isMTEnabled() checks, is tenant enabled or not, it checks with MXserver
static boolean	isNull(java.lang.String val) Returns true if the specified string is null or empty string
static boolean	isNullCheck(java.lang.String val)
static boolean	isNumeric(MboValueData mvData)
static boolean	isParam(javax.servlet.http.HttpServletRequest request, java.lang.String val)
static boolean	isRunningInWebLogic() Returns true to indicate that the application is running in Oracle WebLogic Server, otherwise false.
static java.lang.String	lineBreakString(java.lang.String toProcess, int chunckSize) Deprecated. Since 7.5.0.3 Use wrapText(String, int)
static org.w3c.dom.Document	loadDOM(java.io.InputStream inputStream) Utility method to load a dom from a string and return the element
static org.w3c.dom.Document	loadDOM(java.lang.String input) Utility method to load a dom from a string and return the element
void	loadHelpTaxonomy()
static java.lang.String	makesafejavascriptstringparameter(java.lang.String value) Deprecated. Deprecated as of 7.5.0.1: It is not possible to escape all characters using this method. Use something like this instead: decodeURIComponent('<%=URLEncode.encode(value)%>')
static java.lang.String	makesafevalue(java.lang.String value) Deprecated. Since 7.5.0.2 Use HTML.encodeTolerant(String)
static java.lang.String	makesafeWithAmpersand(java.lang.String value) Deprecated. Since 7.5.0.1
static java.lang.String	padString(java.lang.String value, java.lang.String pad, int length)
static java.lang.String[]	parseParamForRow(java.lang.String param) Parse a request param and get a component id and row number
static java.lang.String[]	parseParamForRow(WebClientSession wcs, java.lang.String param) Parse a request param and get a component id (original id, not the appreviated render id) and row number
AppDescriptor	removeAppDescriptor(java.lang.String appName) Removes the named app from the app descriptor index
java.lang.String	removeAppXML(java.lang.String appName) Remove string object of the presentation xml from Map
void	removeControl(ControlInstance control)
static java.lang.String	removeInvalidXMLChars(java.lang.String value)
LibraryDescriptor	removeLibraryDescriptor(java.lang.String name) Removes the named library from the library descriptor index
static java.lang.String	removePrepend(java.lang.String value)
static java.lang.String	removeQuotes(java.lang.String value) Only replaces double quote to allow placing as a field value
static java.lang.String	removeRowMarker(java.lang.String id) Remove a rowmarker from a string
static java.lang.String	removeSharedAttributeRowMarker(java.lang.String id) Removes the row marker and tablebody render id from the passed in id for a shared attribute component
WebClientSession	removeWebClientSession(javax.servlet.http.HttpSession httpSession) Add the webclient session to the session index.
static java.lang.String	replaceLogicalsWithSymbols(java.lang.String value) Deprecated. Since 7.5.0.1
static java.lang.String	replaceParams(java.lang.String message, java.lang.String[] params) Takes a String and params for replacement and returns new string
static java.lang.String	replaceString(java.lang.String str, java.lang.String pattern, java.lang.String replacement) Replace all occurrences of a pattern string with a replacement string.
void	reset() Reset all the internal structures to their initial states
static void	resetAppDescCache() Method to reset application description cache
static boolean	send503Error(javax.servlet.http.HttpServletResponse response, MXSession s, boolean maxUserSessions) If the maximo system property mxe.webclient.maxuisessionsend503 equals 1 (the default is 0) this method will send a HttpServletResponse.SC_SERVICE_UNAVAILABLE error to the response and return true.
static boolean	send503Error(javax.servlet.http.HttpServletResponse response, MXSession s, java.lang.String url) Deprecated. see send503Error(HttpServletResponse response, MXSession s, boolean maxUserSessions)
static int	sendEvent(WebClientEvent event) A shorcut method to handleEvent(WebClientSession, WebClientEvent)
static int	sendEvent(WebClientSession wcs, java.lang.String targetId, java.lang.String event, java.lang.Object value) A shortcut method that sonstructs a WebClientEvent and sends it to the event handler
void	setAppXML(java.lang.String appName, java.lang.String appXML) Save string object of the presentation xml to avoid mbo calls to the database
void	setRuntimeAppdescripterIndex(java.lang.String newApp, AppDescriptor runTimeAd)
void	setSkin(java.lang.String skin) Sets the current skin being used system-wide.
static java.lang.String	shortenString(java.lang.String orig, int checklength) Returns a truncated string with training dots.
static java.lang.String	stringToCodepoints(java.lang.String theString, boolean escapeSpace, boolean escapeUnicode) Converts unicodes to encoded \uxxxx and writes out any of the characters in specialSaveChars with a preceding slash
static char	toHex(int nibble) Convert a nibble to a hex character
static java.lang.String	unFormatString(java.lang.String str) Deprecated. Since 7.5.0.2 Use HTML.decode(String)
static java.lang.String	updateString(DataBean attrSource, java.lang.String str, java.lang.String attributes) Formats a string with tokens {0}, {1} etc.
static java.lang.String	wrapText(java.lang.String text, int lineLength) Wraps a string of text and puts a '\n' where breaks are needed but words are not truncated or broken.
static java.lang.String	wrapText(java.lang.String text, int lineLength, boolean canBreakWords, boolean hyphenateBreaks)
static java.lang.String	wrapText(java.lang.String text, java.lang.String wrapString, int lineLength) Wraps a string of text and puts wrapString in the end where breaks are needed but words are not truncated or broken.

Methods inherited from class java.lang.Object

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

Field Detail

ROWMARKID

public static final java.lang.String ROWMARKID

See Also:

Constant Field Values

MSG_BTNOK

public static final int MSG_BTNOK

See Also:

Constant Field Values

MSG_BTNCANCEL

public static final int MSG_BTNCANCEL

See Also:

Constant Field Values

MSG_BTNYES

public static final int MSG_BTNYES

See Also:

Constant Field Values

MSG_BTNNO

public static final int MSG_BTNNO

See Also:

Constant Field Values

SPECIALSAVECHARS

public static final java.lang.String SPECIALSAVECHARS

Deprecated. Since 7.5.0.1

special characters that that need to have a slash when converting to unicode

See Also:

Constant Field Values

HEXDIGITS

public static final char[] HEXDIGITS

A table of hex digits

keycode

public static final java.util.HashMap<java.lang.Character,java.lang.Integer> keycode

serviceability

public final RuntimeServiceability serviceability

MXE_WEBCLIENT_MAXASYNCREQUESTSBEFORERENDER

public static final java.lang.String MXE_WEBCLIENT_MAXASYNCREQUESTSBEFORERENDER

A constant for the Tpae system property mxe.webclient.maxasyncrequestsbeforerender which is used to determine the maximum number of asynchronous requests to be handled before a render is sent to the page.

See Also:

Constant Field Values

MXE_WEBCLIENT_ASYNCRENDERTIMELIMIT

public static final java.lang.String MXE_WEBCLIENT_ASYNCRENDERTIMELIMIT

A constant for the Tpae system property which is used to determine maximum amount of seconds to elapse between rendering of the page when handling asynchronous requests.

See Also:

Constant Field Values

STARTCENTER_CACHE_NAME

public static final java.lang.String STARTCENTER_CACHE_NAME

A constant for naming the cache of start center list and info for the current user

See Also:

Constant Field Values

PORTLETLAYOUT_CACHE_NAME

public static final java.lang.String PORTLETLAYOUT_CACHE_NAME

A constant for naming the cache of portlet layout for a current start center

See Also:

Constant Field Values

PORTLETLAYOUT_CACHE_UID

public static final java.lang.String PORTLETLAYOUT_CACHE_UID

A constant for naming the cache that contains the uid for the contents in the Portlet Layout cache

See Also:

Constant Field Values

PORTLET_CACHE_PREFIX

public static final java.lang.String PORTLET_CACHE_PREFIX

A constant for naming the cache of portlet specific info in the current start center. This is a prefix and LAYOUTID will be concatenated to it

See Also:

Constant Field Values

PORTLETS_ALLOWED_CACHE

public static final java.lang.String PORTLETS_ALLOWED_CACHE

A constant for naming the cache of portlets that are allowed. Portlet name and app name are same.

See Also:

Constant Field Values

STARTCENTER_UID_CACHE_NAME

public static final java.lang.String STARTCENTER_UID_CACHE_NAME

A constant for naming the uid of a start center.

See Also:

Constant Field Values

MXE_WEBCLIENT_DEEPREQUIREDCHECK

public static final java.lang.String MXE_WEBCLIENT_DEEPREQUIREDCHECK

A constant for the Tpae system property which is used to determine if the framework will perform a a check for all required fields when saving

See Also:

Constant Field Values

Method Detail

getWebClientRuntime

public static WebClientRuntime getWebClientRuntime()

Factory method that returns a reference to a webclientruntime object.

loadDOM

public static org.w3c.dom.Document loadDOM(java.io.InputStream inputStream)

Utility method to load a dom from a string and return the element

loadDOM

public static org.w3c.dom.Document loadDOM(java.lang.String input)

Utility method to load a dom from a string and return the element

getWebClientSession

public WebClientSession getWebClientSession(javax.servlet.http.HttpServletRequest request)

Returns the WebClientSession associated with the passed in request. The WebClientSession is found by the request parameter, or request attribute uisessionid. Change for 7.1.1.6 - If the uisessionid parameter/attribute doesn't exist or there isn't WebClientSession with that uisessionid, this method will return null. In prior versions this method created a WebClientSession if it didn't exist. This was changed as part of the WebClientSession limitation changes. To create a new WebClientSession you need to call the createSession method on the new 7.1.1.6 class psdi.webclient.system.session.WebClientSessionFactory.

See Also:

psdi.webclient.system.session.WebClientSessionFactory.createSession(HttpServletRequest request, HttpServletResponse response)

addWebClientSession

public void addWebClientSession(javax.servlet.http.HttpSession httpSession,
                                WebClientSession wcs)

Deprecated. use WebClientSessionFactory createSession()

Add the webclient session to the session index. the key is httpsession and the return value is a webclientsession

See Also:

psdi.webclient.system.session.WebClientSessionFactory.createSession(HttpServletRequest request, HttpServletResponse response)

removeWebClientSession

public WebClientSession removeWebClientSession(javax.servlet.http.HttpSession httpSession)

Add the webclient session to the session index. the key is httpsession and the return value is a webclientsession

getAppDescriptor

public AppDescriptor getAppDescriptor(java.lang.String appName,
                                      WebClientSession wcs)

factory method to return an app descriptor. creates it if it doesn't exist, and requires a WebClientSession Object for the database connection

getPresentationCache

public PresentationCache getPresentationCache()

Returns the PresentationCache for this jvm

getAppDescriptor

public AppDescriptor getAppDescriptor(java.lang.String appName)

Method to get an app descriptor by app name out of the descriptor index. will return NULL if the descriptor doesn't exist

getAppName

public static java.lang.String getAppName(org.w3c.dom.Element element)

Searches the element dom to get the name of the presentation. should only be used by the descriptors appInstance.getAppName() should be used when session/app instance is available

getLibraryDescriptor

public LibraryDescriptor getLibraryDescriptor(java.lang.String libraryName,
                                              WebClientSession wcs)

getToolBoxDescriptor

public ToolBoxDescriptor getToolBoxDescriptor(java.lang.String toolboxName,
                                              WebClientSession wcs)

getCmsMenuDescriptor

public CmsMenuDescriptor getCmsMenuDescriptor(java.lang.String mboName,
                                              java.lang.String menuItem)

getCMSRegistry

public com.ibm.tivoli.contextmenuservice.ICmsRegistry getCMSRegistry()
                                                              throws com.ibm.tivoli.contextmenuservice.exception.CmsException

Throws:

com.ibm.tivoli.contextmenuservice.exception.CmsException

isCmsEnabled

public boolean isCmsEnabled()

loadHelpTaxonomy

public void loadHelpTaxonomy()

getDisObject

public com.ibm.tivoli.dataintegration.DataIntegrationServices getDisObject()

getCmsMenuDescriptorObject

public com.ibm.json.java.JSONObject getCmsMenuDescriptorObject(DataBean bean,
                                                               java.lang.String menuId)

getControlDescriptor

public ControlDescriptor getControlDescriptor(java.lang.String type)

getComponentDescriptor

public ComponentDescriptor getComponentDescriptor(java.lang.String type)

getElementProperty

public java.lang.String getElementProperty(org.w3c.dom.Element xmlControlElement,
                                           ControlDescriptor cd,
                                           java.lang.String propName)

Get's the property value from the descriptor or the XML element for the control. This method looks at the propery's flag. If the property's flag is marked as SYSTEM, then the value in set in the XML element is ignored, and only the value from the descriptor is returned.

getStreamFromJar

public java.util.HashMap<java.lang.String,java.io.InputStream> getStreamFromJar(java.lang.String productDir)
                                                                         throws java.lang.Exception

Throws:

java.lang.Exception

getOptionMenu

public java.lang.String getOptionMenu(java.lang.String appName,
                                      java.lang.String sigOption)

getFieldSize

public int getFieldSize(boolean onTable,
                        java.lang.String maxtype,
                        int datalength)

Translates the textual representation of the maxtype and delegates to getFieldSize(int, int)

Parameters:

maxtype - the type of the field, such as ALN, UPPER, YORN

datalength - the data length of the field

Returns:

the display size of the field

See Also:

getFieldSize(int, int)

getFieldSize

public int getFieldSize(boolean onTable,
                        int maxtype,
                        int datalength)

Returns the size of the field based on its data type and data length. The configuration scale factor is automatically applied to the input data length, but not to any other configuration value.

If range values are found for this maxtype, the method will return the size of the largest configuration range which range value ("upper" or "below", does not actually matter) does not exceed the field size obtained as desctibed in the previous paragraph, or the size of the last range. It is assumed that the ranges in the configuration are ordered by increasing range value.

The field size can exceed the maximum field size from the configuration if the particular data type is configured so. the maxtype code for the field (see MXFormat)

Parameters:

datalength - the data length of the field

Returns:

the display size of the field

See Also:

getMaxTypeAsInt(String)

getMaxTypeAsInt

public static int getMaxTypeAsInt(java.lang.String type)

Converts the string representation of a MAXTYPE to integer code.

See Also:

MXFormat

getFieldPadding

public int getFieldPadding()

Returns:

the value of field_padding from field-size-config.xml

getFieldSizeFactor

public double getFieldSizeFactor()

Returns:

the value of field_size_factor from field-size-config.xml

getFieldSizeMaximum

public int getFieldSizeMaximum()

Returns:

the value of field_size_maximum from field-size-config.xml

getTablecolSizeFactor

public double getTablecolSizeFactor()

Returns:

the value of tablecol_size_factor from field-size-config.xml

getTablecolSizeDefault

public int getTablecolSizeDefault()

Returns:

the value of tablecol_size_default from field-size-config.xml

getDateFieldSize

public int getDateFieldSize()

Returns:

the value of date_field_size from field-size-config.xml

getDateTimeFieldSize

public int getDateTimeFieldSize()

Returns:

the value of date_time_field_size from field-size-config.xml

getTimeFieldSize

public int getTimeFieldSize()

Returns:

the value of time_field_size from field-size-config.xml

getWebClientProperty

public static java.lang.String getWebClientProperty(java.lang.String prop)

Retrieves a property from the webclient.property file.

Parameters:

prop - property to get

Returns:

String value of the property or null.

getWebClientProperty

public static java.lang.String getWebClientProperty(java.lang.String prop,
                                                    java.lang.String defaultValue)

Retrieves a property from the webclient.property file.

Parameters:

prop - property to get

defaultValue - default the value to return if the property doesn't exist.

Returns:

String value of the property or the default value passed in.

getHelpString

public static java.lang.String[] getHelpString(java.lang.String propvalue)

Get help string array of packagename and filename.

Returns:

String [] of the property value.

getHelpUrl

public java.lang.String getHelpUrl(java.lang.String packagename,
                                   java.lang.String filename,
                                   java.lang.String langcode)

Get help url value

Returns:

String value of the help Url.

getWebClientSystemProperty

public static java.lang.String getWebClientSystemProperty(java.lang.String prop)

Retrieves a property from the System Properties application.

Parameters:

prop - name of property to get

Returns:

String value of the property or null.

getWebClientSystemProperty

public static java.lang.String getWebClientSystemProperty(java.lang.String prop,
                                                          java.lang.String defaultValue)

Retrieves a property from the System Properties application.

Parameters:

prop - property to get

defaultValue - default the value to return if the property doesn't exist.

Returns:

String value of the property or the default value passed in.

isNull

@TraceDisabled
public static boolean isNull(java.lang.String val)

Returns true if the specified string is null or empty string

isNullCheck

@TraceDisabled
public static boolean isNullCheck(java.lang.String val)

removeControl

public void removeControl(ControlInstance control)

reset

public void reset()

Reset all the internal structures to their initial states

checkSession

public static WebClientEvent checkSession(WebClientSession wcs,
                                          WebClientEvent event)
                                   throws java.io.IOException

Deprecated. as of MBS 7.1.1.6. Replaced by RequestManager checkSession

Check to see if the user has a valid MXSession and returns a WebClientEvent that should be processed next. If not, it tries to log in the user (only if the request parameter exists). If their isn't a valid connection then the user is sent to the login page. Also check to see if the user's password has expired. If it has the user is sent to the change password app. Otherwise if the user has a valid session and the password isn't expired, then the user is sent to the start page/app, unless the event that is passed into the method isn't null.

Returns:

The MXWebclientEvent to be process from the

Throws:

java.io.IOException

getMaximoRequestURL

public static java.lang.String getMaximoRequestURL(javax.servlet.http.HttpServletRequest request)

Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters. If have a valid WebClientSession use WebClientSession getMaximoBaseURL() for performance reasons.

getMaximoBaseURL

public static java.lang.String getMaximoBaseURL(javax.servlet.http.HttpServletRequest request)

Reconstructs the BASE URL the client used to make the request. The returned URL contains a protocol, server name, port number. If have a valid WebClientSession use WebClientSession getMaximoBaseURL() for performance reasons.

getMaximoRequestContextURL

public static java.lang.String getMaximoRequestContextURL(javax.servlet.http.HttpServletRequest request)

Reconstructs the Maximo Request Context Path. The returned URL contains a protocol, server name, port number and application context.

getMXSession

public static MXSession getMXSession(javax.servlet.http.HttpSession session)

sendEvent

public static int sendEvent(WebClientSession wcs,
                            java.lang.String targetId,
                            java.lang.String event,
                            java.lang.Object value)

A shortcut method that sonstructs a WebClientEvent and sends it to the event handler

Parameters:

wcs - the session context

targetId - event parameter

event - event parameter

value - event parameter

Returns:

the status code returned by the event handler

See Also:

handleEvent(WebClientSession, WebClientEvent), WebClientEvent(String, String, Object, WebClientSession)

sendEvent

public static int sendEvent(WebClientEvent event)

A shorcut method to handleEvent(WebClientSession, WebClientEvent)

Parameters:

event - the event to send

Returns:

the status code returned by the event handler

See Also:

handleEvent(WebClientSession, WebClientEvent)

removePrepend

public static java.lang.String removePrepend(java.lang.String value)

makesafevalue

public static java.lang.String makesafevalue(java.lang.String value)

Deprecated. Since 7.5.0.2 Use HTML.encodeTolerant(String)

Used to protect xml values that may contain special characters. The characters are replaced with their safe equivalent symbols. New unsafe chars/safe symbol combinations should be added to the two private arrays define in this class; UNSAFE_CHARS and SAFE_SYMS

Parameters:

value - the value to be protected

Returns:

the contents of value with the unsafe characters replaced with safe symbols

makesafeWithAmpersand

public static java.lang.String makesafeWithAmpersand(java.lang.String value)

Deprecated. Since 7.5.0.1

decodeSafevalue

public static java.lang.String decodeSafevalue(java.lang.String value)

Deprecated. Use HTML.decode(String)

Used to protect xml values that may contain special characters. The characters are replaced with their safe equivalent symbols. New unsafe chars/safe symbol combinations should be added to the two private arrays define in this class; UNSAFE_CHARS and SAFE_SYMS

Parameters:

value - the value to be protected

Returns:

the contents of value with the unsafe characters replaced with safe symbols

removeQuotes

public static java.lang.String removeQuotes(java.lang.String value)

Only replaces double quote to allow placing as a field value

replaceLogicalsWithSymbols

public static java.lang.String replaceLogicalsWithSymbols(java.lang.String value)

Deprecated. Since 7.5.0.1

The inverse operation to makesafevalue(String)

See Also:

HTML#decode(String)}

makesafejavascriptstringparameter

public static java.lang.String makesafejavascriptstringparameter(java.lang.String value)

Deprecated. Deprecated as of 7.5.0.1: It is not possible to escape all characters using this method. Use something like this instead: decodeURIComponent('<%=URLEncode.encode(value)%>')

Makes Java strings ready for inclusion in a JavaScript from JSP code. Note that the JavaScript call is expected to enclose the parameter in quotes

Replaces: \n Newline. \r Carriage return. \t Horizontal tab. \' Single quote or apostrophe. \" Double quote. \\ Backslash.

Does not replace: \b Backspace. \f Form feed. \O Nul character. \v Vertical tab.

Parameters:

value - the value to be protected

Returns:

the contents of value with the unsafe characters replaced with safe symbols

formatDataString

public static java.lang.String formatDataString(java.lang.String dataString)

Deprecated. Deprecated as of 7.5.0.1: It is not possible to escape all characters using this method. Use something like this instead: decodeURIComponent('<%=URLEncode.encode(value)%>')

Handles the cases where a string has newline, backslash or quotes in it. Need this for JavaScript code to work.

hasInvalidXMLChars

public static boolean hasInvalidXMLChars(java.lang.String value)

See Also:

http://www.w3.org/TR/REC-xml/#charsets}

removeInvalidXMLChars

public static java.lang.String removeInvalidXMLChars(java.lang.String value)

See Also:

http://www.w3.org/TR/REC-xml/#charsets}

getHost

public static java.lang.String getHost()

wrapText

public static java.lang.String wrapText(java.lang.String text,
                                        int lineLength)

Wraps a string of text and puts a '\n' where breaks are needed but words are not truncated or broken.

wrapText

public static java.lang.String wrapText(java.lang.String text,
                                        java.lang.String wrapString,
                                        int lineLength)

Wraps a string of text and puts wrapString in the end where breaks are needed but words are not truncated or broken. Example wrapStrings are "\n", "\r\n", "
", etc.

wrapText

public static java.lang.String wrapText(java.lang.String text,
                                        int lineLength,
                                        boolean canBreakWords,
                                        boolean hyphenateBreaks)

getHostAddress

public static java.lang.String getHostAddress()

Returns:

The IP Address of the host that the JSP engine is running on.

isParam

public static boolean isParam(javax.servlet.http.HttpServletRequest request,
                              java.lang.String val)

Returns:

true if the specified string is a parameter in the request

replaceString

public static java.lang.String replaceString(java.lang.String str,
                                             java.lang.String pattern,
                                             java.lang.String replacement)

Replace all occurrences of a pattern string with a replacement string.

Parameters:

str - String to search

pattern - string to replace

replacement - string to replace patter with

updateString

public static java.lang.String updateString(DataBean attrSource,
                                            java.lang.String str,
                                            java.lang.String attributes)

Formats a string with tokens {0}, {1} etc. and replace them with attributes values passed in comma ',' delimited string.

Parameters:

str - String to search

attrSource - Data source to use

attributes - comma delimited string of attributes

escapeForJScript

public static java.lang.String escapeForJScript(java.lang.String str)

Escapes the characters for JScript alert() method

Parameters:

str - the string that needs to be checked and escaped

Returns:

updated string

isNumeric

public static boolean isNumeric(MboValueData mvData)

replaceParams

public static java.lang.String replaceParams(java.lang.String message,
                                             java.lang.String[] params)

Takes a String and params for replacement and returns new string

getPrependValue

public static java.lang.String getPrependValue(java.lang.String prependString)

Used to get the prepend value which are otheriwse unsafe characters in XML

Parameters:

value - The string to be protected

Returns:

The prepend value that can be used for QBE

formatStringForTags

public static java.lang.String formatStringForTags(java.lang.String str)

Deprecated. Since 7.5.0.2 Use HTML.encodeTolerant(String)

Replaces < and > with < and > so that it can be safely displayed in a text area

Parameters:

the - string that needs to be checked and escaped

Returns:

updated string

unFormatString

public static java.lang.String unFormatString(java.lang.String str)

Deprecated. Since 7.5.0.2 Use HTML.decode(String)

createStatusText

public static java.lang.String createStatusText(MXException[] warnings,
                                                WebClientSession wcs)

Transforms the warnings array to a String.

findAttribute

public static java.lang.String findAttribute(java.lang.String name,
                                             org.w3c.dom.Element element)

findElement

public static org.w3c.dom.Element findElement(org.w3c.dom.Element element,
                                              java.lang.String id)

Finds the first element with attribute 'id' equal to the parameter id. This can be the Element parameter element or any of its children. Walks recursively the child tree. This method is case sensitive. For a case insensitive search, use findElement(Element, String, Boolean)

Parameters:

element - The root of the searched element tree

id - The string id of the element that is been searched in the library

Returns:

Element, or null if not found

findElement

public static org.w3c.dom.Element findElement(org.w3c.dom.Element element,
                                              java.lang.String id,
                                              boolean isCaseSensitive)

Finds the first element with attribute 'id' equal to the parameter id. This can be the Element parameter element or any of its children. Walks recursively the child tree.

Parameters:

element - The root of the searched element tree

id - The string id of the element that is been searched in the library

isCaseSensitive - True for case sensitive search, false for case insensitive search

Returns:

Element, or null if not found

findChildElement

public static org.w3c.dom.Element findChildElement(org.w3c.dom.Element element,
                                                   java.lang.String id,
                                                   boolean isCaseSensitive)

Finds the first child element with attribute 'id' equal to the parameter id. Walks recursively the child tree.

Parameters:

element - The root of the searched element tree

id - The string id of the element that is been searched in the library

isCaseSensitive - True for case sensitive search, false for case insensitive search

Returns:

Element, or null if not found

findElementByTagName

public static org.w3c.dom.Element findElementByTagName(org.w3c.dom.Element element,
                                                       java.lang.String tagName)

Finds the first element with tagName Walks recursively the child tree

findChildElementByTagName

public static org.w3c.dom.Element findChildElementByTagName(org.w3c.dom.Element element,
                                                            java.lang.String tagName)

Finds the first child element with tagName Walks recursively the child tree

stringToCodepoints

public static java.lang.String stringToCodepoints(java.lang.String theString,
                                                  boolean escapeSpace,
                                                  boolean escapeUnicode)

Converts unicodes to encoded \uxxxx and writes out any of the characters in specialSaveChars with a preceding slash

toHex

public static char toHex(int nibble)

Convert a nibble to a hex character

Parameters:

nibble - the nibble to convert.

csvStringFromArray

public static java.lang.String csvStringFromArray(java.lang.Object[] values)

Returns helper method to return a string of comma separated values from an array of objects

Returns:

csv string respresenting comma seperated values

removeAppDescriptor

public AppDescriptor removeAppDescriptor(java.lang.String appName)

Removes the named app from the app descriptor index

Parameters:

appName - the name of the app to remove

Returns:

the AppDescriptor that was removed, or null if there were none by that name

removeLibraryDescriptor

public LibraryDescriptor removeLibraryDescriptor(java.lang.String name)

Removes the named library from the library descriptor index

Parameters:

name - the name of the app to remove

Returns:

the LibraryDescriptor that was removed, or null if there were none by that name

doubleUpQuotes

public static java.lang.String doubleUpQuotes(java.lang.String inputData)

This function takes a passed in string and returns it with all single quotes 'Doubled Up' to prevent then from being parsed by Oracle as being the end of the field.

Parameters:

inputData - The data to be protected

Returns:

The corrected string

getSupportedContainer

public java.util.HashMap<java.lang.String,java.lang.String> getSupportedContainer(java.lang.String ctrlType)

getPropFromElement

public java.lang.String getPropFromElement(org.w3c.dom.Element xmlControlElement,
                                           java.lang.String propName)

setRuntimeAppdescripterIndex

public void setRuntimeAppdescripterIndex(java.lang.String newApp,
                                         AppDescriptor runTimeAd)

formatStringUniqueId

public static long formatStringUniqueId(java.lang.String tempStr,
                                        java.util.Locale userlocale)

Formats a string meant for uniqueid, by stripping off, the seperator and decimal seperator based on current locale

breakupMsgLookup

public static java.lang.String[] breakupMsgLookup(java.lang.String lookup)

Breas messages lookup, generally specified as proeperties into group and key part making it ready to be used for getMessage call.
For.e.g
ui#startlable will be broken into an array of 2 of ui and startlable

Returns:

String[] of length 2

getAppXML

public java.lang.String getAppXML(java.lang.String appName)

Return Save string object of the presentation xml

setAppXML

public void setAppXML(java.lang.String appName,
                      @TraceMaskValue
                      java.lang.String appXML)

Save string object of the presentation xml to avoid mbo calls to the database

removeAppXML

public java.lang.String removeAppXML(java.lang.String appName)

Remove string object of the presentation xml from Map

hasLicenseAccess

public boolean hasLicenseAccess(java.lang.String licensevalue)

getSkin

public java.lang.String getSkin()

Return the current skin being used system-wide.

setSkin

public void setSkin(java.lang.String skin)

Sets the current skin being used system-wide.

parseParamForRow

public static java.lang.String[] parseParamForRow(WebClientSession wcs,
                                                  java.lang.String param)

Parse a request param and get a component id (original id, not the appreviated render id) and row number

parseParamForRow

public static java.lang.String[] parseParamForRow(java.lang.String param)

Parse a request param and get a component id and row number

addRowMarker

public static java.lang.String addRowMarker(java.lang.String id,
                                            int row)

Adds a row marker to a String (used for id's)

removeSharedAttributeRowMarker

public static java.lang.String removeSharedAttributeRowMarker(java.lang.String id)

Removes the row marker and tablebody render id from the passed in id for a shared attribute component

removeRowMarker

public static java.lang.String removeRowMarker(java.lang.String id)

Remove a rowmarker from a string

getRowFromId

public static int getRowFromId(java.lang.String id)

Parse the row out of an id String

containsRowMarker

public static boolean containsRowMarker(java.lang.String value)

lineBreakString

public static java.lang.String lineBreakString(java.lang.String toProcess,
                                               int chunckSize)

Deprecated. Since 7.5.0.3 Use wrapText(String, int)

Splits a string for given chunk size and puts a line break after each string
splitString("Hello Maximo World!",5, "\n") results in

Hello
Maxi
mo Wo
rld

isAllLatin

public static boolean isAllLatin(java.lang.String titleString)

Determines if a string has a character that is not from LATIN based unicode blocks
This method is used in determining when and how much a graph titled can be wrapped.
Non latin based characters take more pixels to display.

Returns:

true if all character in string belong to one of the following unicode blocks
-BASIC_LATIN
-LATIN_1_SUPPLEMENT
-LATIN_EXTENDED_A
-LATIN_EXTENDED_B

shortenString

public static java.lang.String shortenString(java.lang.String orig,
                                             int checklength)

Returns a truncated string with training dots.

addToTranslatableLabels

public static void addToTranslatableLabels(java.lang.String type,
                                           java.lang.String key)

getTranslatableLabels

public static java.lang.String getTranslatableLabels(java.lang.String type,
                                                     java.lang.String key)

getExcludeApps

public java.util.Properties getExcludeApps(java.lang.String appName)

cacheExcludeApps

public void cacheExcludeApps()

getPropsFromJar

public java.util.HashMap<java.lang.String,java.io.InputStream> getPropsFromJar(java.lang.String productDir)
                                                                        throws java.lang.Exception

Throws:

java.lang.Exception

getLocaleFromRequest

public static java.lang.Object[] getLocaleFromRequest(javax.servlet.http.HttpServletRequest request)

Returns an object array with two objects. The first object will be a language code string and the second object will be a Locale object. The language code is obtained by fisrt looking for the langcode request parameter. If that doesn't exist check for the langcode session attribute. If that doesn't exist, it's obtained from the build it out of the request's accept-language. If that doesn't exist, then Object[0] will be null; return null. The locale is obtained by looking for the _locale_ session attribute. If that doesn't exist the locale will be created from the request's accept language. If that doesn't exist then Object[1] will be null.

send503Error

public static boolean send503Error(javax.servlet.http.HttpServletResponse response,
                                   MXSession s,
                                   boolean maxUserSessions)
                            throws java.io.IOException

If the maximo system property mxe.webclient.maxuisessionsend503 equals 1 (the default is 0) this method will send a HttpServletResponse.SC_SERVICE_UNAVAILABLE error to the response and return true. This method will also set the Retry-After header to the value specidfied by the maximo system property mxe.webclient.503_retry-after.

Throws:

java.io.IOException

send503Error

public static boolean send503Error(javax.servlet.http.HttpServletResponse response,
                                   MXSession s,
                                   java.lang.String url)
                            throws java.io.IOException

Deprecated. see send503Error(HttpServletResponse response, MXSession s, boolean maxUserSessions)

If the maximo system property mxe.webclient.maxuisessionsend503 equals 1 (the default is 0) this method will send a HttpServletResponse.SC_SERVICE_UNAVAILABLE error to the response and return true. This method will also set the Retry-After header to the value specidfied by the maximo system property mxe.webclient.503_retry-after.

Parameters:

url - - Not used

Throws:

java.io.IOException

getDojoDirectory

public static java.lang.String getDojoDirectory(javax.servlet.http.HttpServletRequest request)

Returns the directory under the /webclient/javascript path that contains the latest version of Dojo. This directory must be in the format dojo_#-#-#_YYYYMMDD. #-#-# is the Dojo version number and YYYYMMDD is the build date.

Parameters:

request - A servlet request that is used gain access to the /webclient/javascript resource path.

Returns:

The directory name under /webclient/javascript that contains the latest version of Dojo.

getEntityRelationshipModel

public EntityRelationshipModel getEntityRelationshipModel(java.lang.String app)

Returns the EntityRelationshipModel for the given app. Will reutrn null if the app doesn't have an EntityRelationshipModel.

Parameters:

app - the id of the app to get the EntityRelationshipModel for

Returns:

EntityRelationshipModel of the application

createSendEventString

public static java.lang.String createSendEventString(java.lang.String event,
                                                     java.lang.String target,
                                                     java.lang.String val,
                                                     int jsMethod)

Creates a sendEvent string to be used in jsp's where components cannot do the same thing.

Parameters:

event - e.g changeapp

target - e.g startcntr

val - e.g. asset

jsMethod - {1 for onclick, 2 for onkeypress, 3 or default for both)

Returns:

canUseStaticIds

public boolean canUseStaticIds()

Returns true if UI should use static mxids rather than sequence based sceheme

Returns:

true if static ids enabled

addFieldClassInfo

public FieldClassInfo addFieldClassInfo(FieldClassInfo fci)

Adds a FieldClassInfo object to the fieldClassInfo cache

getFieldClassInfo

public FieldClassInfo getFieldClassInfo(java.lang.String name)

Method to get a fieldClassInfo by class name out of the index. will return NULL if the class file is not in there

getAppDescFromCache

public static java.lang.String getAppDescFromCache(java.lang.String appId,
                                                   MXSession mxs)

Added to support calling with no language Code

Parameters:

appId - Application Id

mxs - MXSession

Returns:

App Description

getAppDescFromCache

public static java.lang.String getAppDescFromCache(java.lang.String appId,
                                                   MXSession mxs,
                                                   java.lang.String langCode)

Method to catch application description

Parameters:

appId - Application Id

mxs - MXSession

langCode - Language Code

Returns:

App Description

Throws:

MXException

java.rmi.RemoteException

resetAppDescCache

public static void resetAppDescCache()

Method to reset application description cache

isMTEnabled

public static boolean isMTEnabled()

isMTEnabled() checks, is tenant enabled or not, it checks with MXserver

getMTtenantId

public static int getMTtenantId()

getMTtenantId() to get the tenant Id, for thread , it returns ID Of the tenant

getCacheIdForAppName

public static java.lang.String getCacheIdForAppName(java.lang.String Id)

getCacheIdForAppName return String the app name with suffix , if tenant enable it will return appname with tenant id .

Parameters:

appId - Application Id

Returns:

Application id with tenant id if Multi Tenancy is enabled else it will return appId

canBeUsedInRecordHover

public boolean canBeUsedInRecordHover(java.lang.String controlType)

Returns true if the passed in control type is support within a recordhover control. Only controls with useinrecordhover set to true in the control-registry are allowed in a recordhover.

getAppSigOptionList

public static java.util.Map<java.lang.String,SigOptionInfo> getAppSigOptionList(java.lang.String appId)

Returns a Map containing all possible sigoption for an application regardless of whether or not the user has access to them.

Returns:

Map - A map of all the app's sigoptions.

Throws:

MXException

java.rmi.RemoteException

padString

public static java.lang.String padString(java.lang.String value,
                                         java.lang.String pad,
                                         int length)

isRunningInWebLogic

public static boolean isRunningInWebLogic()

Returns true to indicate that the application is running in Oracle WebLogic Server, otherwise false.

Returns:

true to indicate that the application is running in Oracle WebLogic Server, otherwise false.