EGL library portalLib

portalLib is the EGL system library for EGL programs that are designed to run in a portal web environment. In this environment, you can launch the application from a web browser, but the majority of the processing is performed within a portlet running on IBM® WebSphere® Portal Server V6.0.

These functions are only useful within a JSF handler that runs as part of a portal application. Calls to portalLib functions that are made outside of a portlet container will produce an error.

The following table lists the system functions in the library portalLib.

Function Description
clearPortletSessionAttr(key, scope) Removes the value that is associated with the specified key from the specified PortletSession scope.
value = createVaultSlot(resourceName, secretType, active, portletPrivate) Creates a new credential vault slot in the user managed vault segment.
deleteVaultSlot(slotID) Deletes the user vault slot with the given slotId
getCredential(slotID, userid, password) Retrieves the user ID and password from the specified Credential Vault slot
value = getPortletMode() Returns the current portlet mode
value = getPorteltSessionAttr(key, scope) Uses the specified key to retrieve a value from the specified scope of the PortletSession
value = getPreferenceValue(key, defaultValue?) Retrieves the first value associated with the given key from the portal preference store
value = getPreferenceValues(key, defaultValue[]) Returns an array of strings that are associated with a given preference key.
value[] = getWindowState() Returns the current window state
value = isPreferenceReadOnly(key) Returns true if the preference with the given key is read only
resetPreference(key) Resets or removes the preference value associated with the specified key
savePreferences() Commits all changes made to the preferences via the set methods to the persistent preference store
setCredential(slotId, userId, password) Sets the user ID and password values for the credential vault slot with the given ID
setPortletMode(mode) Sets the portlet mode
setPortletSessionAttr(key, value, scope) Uses the given key to set the value of a PortletSession attribute in the given scope
setPreferenceValue(key, value) Associates the specified value with the specified key in the preference store
setPreferenceValues(key, values) Associates the specified array of values with the given key in the preference store
setWindowState(state) Changes the portlet's window state

Compatibility

Table 1. Compatibility considerations for portalLib
Platform Issue
COBOL generation None of the portalLib functions are supported.

Feedback