Table 62-1 desktopProviderContext.tld Normal Tags with Attributes
|
Tag Name
|
Description
|
Attributes
|
|
getStringProperty
|
Returns a string with the property value. This is an overloaded method that can return alternately the default or localized version of the property value.
|
key (required) - the name of the property
localized (optional)
id (optional)
scope (optional)
pflist (optional)
|
|
getBooleanProperty
|
Returns a Boolean that gives the value of the property.
|
key (required) - the name of the property
id (optional)
scope (optional)
pflist (optional)
|
|
getCollectionProperty
|
Returns a Java Map with the collection property. Here, a collection refers to a multi-value property. Depending on the context, it is either the analogue of Java Maps or Lists. For Lists, the returned Java Map object contains key-value pairs where the key equals the value. This is an overloaded method that can return alternately the default or localized version of the collection property.
|
key (required) - the name of the property
id (optional)
scope (optional)
pflist (optional)
|
|
getIntegerProperty
|
Returns an integer with the integer property. This method returns a default value if the property does not exist.
|
key (required) - the name of the property
id (optional)
scope (optional)
pflist (optional)
|
|
getProperty
|
Returns a Java Object with a property. The value returned from this method is a Java Object of type String, Integer, Boolean, or Map. If the property does not exist, then the default value is returned.
|
key (required) - the name of the property
id (optional)
scope (optional)
|
|
setStringProperty
|
Sets a string property.
|
key (required) - the name of the property
value (required) - the value of the property to be set
pflist (optional)
|
|
setBooleanProperty
|
Sets a Boolean property.
|
key (required) - the name of the property
value (required) - the value of the property to be set
pflist (optional)
|
|
setCollectionProperty
|
Sets a collection property.
|
key (required) - the name of the property
value (required) - the value of the property to be set
pflist (optional)
|
|
setIntegerProperty
|
Sets an integer property.
|
key (required) - the name of the property
value (required) - the value of the property to be set
pflist (optional)
|
|
getLocalePropertiesFilters
|
|
id (optional)
scope (optional)
|
|
getClientPropertiesFilters
|
|
id (optional)
scope (optional)
|
|
getClientAndLocalePropertiesFilters
|
|
id (optional)
scope (optional)
|
|
getClassName
|
Returns a string with the class name for the provider class that this object is providing an environment for. The class name returned must implement the provider interface. This method is used to construct the provider object. It is used by container channels.
|
id (optional)
scope (optional)
|
|
getTemplate
|
Returns a string buffer with the desktop template. The actual template buffer returned is based on the Desktop type, locale, channel, client type, and the template name.
|
file (required) - name of template to return
table (optional) - hashtable - tag table used for tag swapping
id (optional)
scope (optional)
|
|
getDesktopURL
|
Returns a string with the Desktop URL. The Desktop URL is the absolute URL used to access the Desktop application. For example: http://server:port/portal/dt. The request object parameter is included to facilitate implementations. It may be used to build the Desktop URL by supplying the server, port, and protocol of the request. It is not required that the request object be utilized to generate the Desktop URL.
|
querymap (optional)
querystring (optional)
pathinfo (optional)
escape (optional)
id (optional)
scope (optional)
|
|
getDesktopType
|
Returns a string with the Desktop type. The Desktop type, also known as template type, is a string that is one of several indexes used to lookup Desktop templates and JSP files. The Desktop type is typically used to group Desktop customization files to provide different themes.
|
id (optional)
scope (optional)
|
|
getLocaleString
|
Returns a string representation of the locale.
|
id (optional)
scope (optional)
|
|
getLocale
|
Returns Java Locale object representation of the locale.
|
id (optional)
scope (optional)
|
|
getLogoutURL
|
Returns a string with the logout URL. The result of making a connection to the logout URL is typically the termination of the user’s session. What actually happens is dependent on the application receiving the URL connection. Providers may use this value to generate links that allow the user to end their session.
|
id (optional)
scope (optional)
|
|
getStringAttribute
|
Returns a string with the value of the string attribute or null if the attribute is not found. Attributes are settings that are not channel-specific. An example of an attribute might be the user’s first and last name. Channel-specific settings are called properties. Properties can be retrieved by calling the get*Property() methods. Whether a particular value is considered a property or an attribute depends on the underlying implementation of ProviderContext.
|
key (required) - the name of the attribute
id (optional)
scope (optional)
|
|
setStringAttribute
|
Sets a string attribute. Attributes are settings that are not channel-specific. An example of an attribute might be the user’s first and last name. Channel-specific settings are called properties. Properties can be set by calling the set*Property() methods. Whether a particular value is considered a property or an attribute depends on the underlying implementation of ProviderContext.
|
key (required)- the name of the attribute
value (required) - the value of the attribute
|
|
getClientTypeProperty
|
|
key (required)
clientType (optional)
id (optional)
scope (optional)
|
|
getClientType
|
Returns a string with the client type. There is no requirement as to how the client type is determined. It may be hardcoded, derived from the session, or otherwise.
|
id (optional)
scope (optional)
|
|
getDefaultClientType
|
Returns a string with the default client type.
|
id (optional)
scope (optional)
|
|
getCharset
|
Returns a string with the character set. The character set is used for decoding input and encoding output.
|
id (optional)
scope (optional)
|
|
getClientPath
|
Returns a string with the client path. The client path is one of several components used to lookup Desktop templates and JSPs.This allows the lookup to be client-specific.
|
id (optional)
scope (optional)
|
|
getContentType
|
Returns a string with the content type. This value is used to determine if a provider is able to produce content for the client’s device.
|
id (optional)
scope (optional)
|
|
getSessionID
|
Returns a string with the unique session identifier. The format of the return value is implementation specific. The only guarantee is that it is unique (each user session has a unique session ID).
|
id (optional)
scope (optional)
|
|
getUserID
|
Returns a string with the user identifier. The format of the return value is implementation specific. There is no guarantee that this value is unique (there may be multiple user sessions for a given user identifier).
|
id (optional)
scope (optional)
|
|
setClientProperty
|
Sets a client property.
|
name (required) - the name of the property
value (required) - the value of the property to be set
|
|
getClientProperty
|
Returns a string with the client property.
|
name (required)
id (optional)
scope (optional)
|
|
isLogMessageEnabled
|
Returns a Boolean; true if the log level is set to message or higher; otherwise false.
|
id (optional)
scope (optional)
|
|
isLogWarningEnabled
|
Returns a Boolean; true if the log level is set to warning or higher; otherwise false.
|
id (optional)
scope (optional)
|
|
logError
|
Logs a message (any Java Object) if the logging level is error. The location to store logging messages is implementation dependent.
|
value (required) - message to log
throwable (optional)
|
|
logMessage
|
Logs a message (any Java Object) if the logging level is message or higher. The location to store logging messages is implementation dependent.
|
value (required) - message to log
throwable (optional)
|
|
logWarning
|
Logs a message (any Java Object) if the logging level is warning or higher. The location to store logging messages is implementation dependent.
|
value (required) - message to log
throwable (optional)
|
|
getDefaultChannelName
|
Returns a string with the default channel name.
|
id (optional)
scope (optional)
|
|
getTopChannelName
|
Returns the top channel name for the current request.
|
id (optional)
scope (optional)
|
|
getStaticContentPath
|
Gets the URI prefix to web server static content.
|
id (optional)
scope (optional)
|
|
getProviderVersion
|
Get the version of the provider schema for the current channel.
|
id (optional)
scope (optional)
|
|
encodeURLParameter
|
URL encodes a unicode string.
|
id (optional)
scope (optional)
key (required)
|
|
decodeURLParameter
|
Decodes the URL encoded Unicode string. This tag just returns back the original string passed in.
|
id (optional)
scope (optional)
key (required)
|
|
encodeURL
|
Encodes a URL. Rewrites the URL to include the session id.
|
url (required)
id (optional)
scope (optional)
|
|
escape
|
Escapes a String using an encoder class that encodes a specific type of markup. This tag is used to allow provider code to encode content in a device-unaware manner.
|
id (optional)
scope (optional)
unescaped (required)
|
