HCL Digital ExperienceTM, Version 8.5.0.0
SPI Specification

Packages
com.ibm.mashups.proxy.ext  
com.ibm.policy.manager This package includes the API of the Policy Manager runtime.
com.ibm.policy.manager.portal This package includes the WebSphere Portal specific public implementations for use in the Policy Manager runtime.
com.ibm.portal This package and its subpackages define the portal programming model.
com.ibm.portal.ac This package and its sub packages define the portal access control (PAC) API.
com.ibm.portal.ac.data This package defines some read-only data interfaces of the portal access control (PAC) API.
com.ibm.portal.ac.exception This package defines exceptions that are thrown by the portal access control (PAC) API.
com.ibm.portal.admin This package defines elements of the portal occurring in several administrable models.
com.ibm.portal.admin.runtime  
com.ibm.portal.auth This package contains interfaces related to the portal authentication component.
com.ibm.portal.auth.exceptions This package contains exceptions related to the portal authentication component.
com.ibm.portal.auth.stepup This package defines the IBM SPI for the step up authentication function.
com.ibm.portal.cache  
com.ibm.portal.content This package defines content elements of the portal and its surrounding infrastructure.
com.ibm.portal.cor.service  
com.ibm.portal.cp  
com.ibm.portal.cp.ac  
com.ibm.portal.cp.rating  
com.ibm.portal.cp.rating.controller  
com.ibm.portal.cp.resources  
com.ibm.portal.cp.resources.builder  
com.ibm.portal.cp.services  
com.ibm.portal.cp.tagging  
com.ibm.portal.cp.tagging.controller  
com.ibm.portal.cp.xml  
com.ibm.portal.devicesupport This package defines interfaces for device support.
com.ibm.portal.dnd This package provides the Java API through which developers can add "drag and drop" function to their portlets and/or portals.
com.ibm.portal.dynamicui This package provides the core interfaces for dynamic ui management.
com.ibm.portal.dynamicui.service  
com.ibm.portal.eventing.service  
com.ibm.portal.ibmportlet.service.model This package defines ways to obtain models from within an IBM-conform portlet.
com.ibm.portal.identification  
com.ibm.portal.impersonation This package contains the Portal Impersonation API.
com.ibm.portal.impersonation.exceptions This package contains exception classes for the the Portal Impersonation API.
com.ibm.portal.mappingurl  
com.ibm.portal.mmi  
com.ibm.portal.model This package defines ways to obtain models through JNDI lookups.
com.ibm.portal.model.command  
com.ibm.portal.model.command.instantiation  
com.ibm.portal.model.controller The com.ibm.portal.model.controller package contains home and provider interfaces for model controllers.
com.ibm.portal.model.controller.context  
com.ibm.portal.model.controller.exceptions This package contains exceptions thrown by controllers.
com.ibm.portal.navigation This package defines navigation information used during rendering of portal content and in user interaction.
com.ibm.portal.outbound.config  
com.ibm.portal.outbound.config.impl  
com.ibm.portal.outbound.config.service  
com.ibm.portal.outbound.service  
com.ibm.portal.pcm  
com.ibm.portal.pcm.ac  
com.ibm.portal.pcm.dialog.dcx  
com.ibm.portal.pcm.dialog.model  
com.ibm.portal.pcm.dialog.stack  
com.ibm.portal.pcm.dialog.state  
com.ibm.portal.pcm.events  
com.ibm.portal.pcm.exception  
com.ibm.portal.pool  
com.ibm.portal.pool.exceptions  
com.ibm.portal.portlet This package defines IBM API extension for portlets using the Java Portlet API, which implement the Portlet interface.
com.ibm.portal.portlet.apiconvert This package allows to write portlet API extensions (portlet services) that have a single implementation but provide interfaces for both IBM portlets and portlets written to the Java portlet API.
com.ibm.portal.portlet.service This package defines the IBM API for portlet services for portlets written to the Java Portlet API.
com.ibm.portal.portlet.service.contentaccess  
com.ibm.portal.portlet.service.credentialvault This package defines the Credential Vault Portlet Service.
com.ibm.portal.portlet.service.credentialvault.credentials This package defines the portal provided credential objects that can be used to retrieve user credentials from the vault with the credential portlet service.
com.ibm.portal.portlet.service.credentialvault.spi This package defines the Credential Vault SPI.
com.ibm.portal.portlet.service.credentialvault.spi.secrets This package defines the portal provided secret objects that are used for SSO to authenticate the user at another application.
com.ibm.portal.portlet.service.dynamicui This package contains a Java Portlet API portlet service that acts as a factory for the DynamicUIInfo and DynamicUICtrl .
com.ibm.portal.portlet.service.impersonation  
com.ibm.portal.portlet.service.login This package defines the IBM API for the portlet service that allows to trigger a portal login from within a portlet.
com.ibm.portal.portlet.service.model This package defines ways to obtain models from within a JSR 168 portlet.
com.ibm.portal.portlet.service.siteanalyzer  
com.ibm.portal.portlet.service.spi This package defines the IBM API for portlet service providers.
com.ibm.portal.portlet.service.state This package contains a Java Portlet API portlet service that acts as a factory for the RedirectURLGenerator .
com.ibm.portal.portlet.service.taskmanager DEPRECATED - This package provides a Java Portlet API service that is used to obtain a TaskManagerDelegate instance.
com.ibm.portal.portlet.service.taskui DEPRECATED - This package provides a Java Portlet API service that is used by TaskProcessingPortlets to manage the UI to process a task.
com.ibm.portal.portlet.service.url This package provides an API to generate portal URLs inside of Java Portlets.
com.ibm.portal.portletconversion This package specifies a SPI for explicit conversion of portlet settings and portlet data during conversion of a IBM API portlet to a standard API portlet.
com.ibm.portal.portletmodel This package defines interfaces for the portal's representation of portlets and their configuration data.
com.ibm.portal.portletmodel.admin This package defines interfaces for administrative access to the portal's representation of portlets and their configuration data.
com.ibm.portal.portletservice.rememberme  
com.ibm.portal.propertybroker.property This package contains public interfaces of objects (such as Property and Action) which are used to support brokered communication between components.
com.ibm.portal.propertybroker.service This package contains the public interface PropertyBrokerService provided by the Property Broker for portlets compliant with JSR 168.
com.ibm.portal.resolver Contains the main interfaces that extenders of the URI resolution infrastructure must implement.
com.ibm.portal.resolver.accessors  
com.ibm.portal.resolver.accessors.portlet  
com.ibm.portal.resolver.accessors.url  
com.ibm.portal.resolver.admin  
com.ibm.portal.resolver.atom
com.ibm.portal.resolver.atom.helper  
com.ibm.portal.resolver.bindings Interfaces that define particular bindings to the URI resolution service as defined in Binding.
com.ibm.portal.resolver.cache  
com.ibm.portal.resolver.cor  
com.ibm.portal.resolver.cor.helper  
com.ibm.portal.resolver.data Provides for the interfaces required to serve data via the POC resolution framework.
com.ibm.portal.resolver.data.events  
com.ibm.portal.resolver.exceptions Exceptions defined by the URI resolution framework.
com.ibm.portal.resolver.friendly Provides for the friendly selection API artifacts.
com.ibm.portal.resolver.friendly.accessors.url Provides for the accessors that are required to generate friendly URLs.
com.ibm.portal.resolver.friendly.cache  
com.ibm.portal.resolver.friendly.helper Provides for convenience classes to facilitate the use of the friendly selection APIs.
com.ibm.portal.resolver.friendly.service Provides for the portal and portlet services required to access the friendly selection APIs.
com.ibm.portal.resolver.helper Helper classes to facilitate to use and implement the resolution infrastructure interfaction.
com.ibm.portal.resolver.helper.cor Helper classes that facilitate the implementation of the com.ibm.content.operations.registry.spi.ContentLocationFactory interface.
com.ibm.portal.resolver.helper.eclipse  
com.ibm.portal.resolver.http.xml  
com.ibm.portal.resolver.iwidget.xml  
com.ibm.portal.resolver.iwidget.xml.helper  
com.ibm.portal.resolver.mashup  
com.ibm.portal.resolver.mashup.helper  
com.ibm.portal.resolver.opensearch  
com.ibm.portal.resolver.operations  
com.ibm.portal.resolver.operations.exceptions  
com.ibm.portal.resolver.portlet  
com.ibm.portal.resolver.proxy.service  
com.ibm.portal.resolver.service  
com.ibm.portal.resolver.servlet  
com.ibm.portal.resolver.streams Provides for interfaces and a factory to work with streaming APIs.
com.ibm.portal.resolver.streams.helper Provides convenience classes to work with the stream APIs.
com.ibm.portal.resolver.uri Classes to represent URIs that carry special semantics.
com.ibm.portal.resolver.webdav  
com.ibm.portal.resolver.webdav.commands  
com.ibm.portal.resolver.webdav.tree  
com.ibm.portal.resolver.webdav.tree.helper  
com.ibm.portal.resolver.xml
com.ibm.portal.resolver.xml.exception  
com.ibm.portal.resolver.xml.helper  
com.ibm.portal.resolver.xul  
com.ibm.portal.resourceaggregator.combiner  
com.ibm.portal.runtime  
com.ibm.portal.security This package defines general portal security interfaces.
com.ibm.portal.security.exceptions This package defines general portal security exceptions.
com.ibm.portal.serialize  
com.ibm.portal.services.contentmapping This package provides the Content Mapping Service APIs.
com.ibm.portal.services.contentmapping.exceptions This package provides the exception classes for the Content Mapping Service APIs.
com.ibm.portal.services.contentmapping.model  
com.ibm.portal.services.globalization This package provides an API to retrieve an extended version of the Portal defined language list.
com.ibm.portal.services.globalization.preferences This package provides an API to retrieve the globalization preferences for a user or locale.
com.ibm.portal.services.project  
com.ibm.portal.services.siteanalyzer  
com.ibm.portal.services.url  
com.ibm.portal.sitemanagement.command This package contains the command layer for triggering Sitemanagement scenarios.
com.ibm.portal.sitemanagement.exception This package provides all exceptions thrown by the Sitemanagement commands
com.ibm.portal.spa  
com.ibm.portal.spa.data  
com.ibm.portal.spa.parser  
com.ibm.portal.spa.parser.helper  
com.ibm.portal.spa.renderer  
com.ibm.portal.spa.renderer.helper  
com.ibm.portal.spa.service  
com.ibm.portal.state This package defines state representation of portal resources.
com.ibm.portal.state.accesscheck This package allows to attach access control checks to EngineURLs.
com.ibm.portal.state.accessors This package contains accessor to read and write different aspects of the state.
com.ibm.portal.state.accessors.action.engine This package contains accessors to read and write portal engine action aspects of the state.
com.ibm.portal.state.accessors.action.engine.deleteportlet This package contains accessors to read and write portal delete engine actions.
com.ibm.portal.state.accessors.action.engine.login This package contains accessors to read and write portal login engine actions.
com.ibm.portal.state.accessors.action.engine.logout This package contains accessors to read and write portal logout engine actions.
com.ibm.portal.state.accessors.action.engine.moveportlet This package contains accessors to read and write move portlet engine actions.
com.ibm.portal.state.accessors.deviceclass  
com.ibm.portal.state.accessors.exceptions This package contains exceptions that may be thrown by the accessors.
com.ibm.portal.state.accessors.expansionstates This package contains accessor to read and write the expansion state of navigation nodes.
com.ibm.portal.state.accessors.generic This package contains generic base interfaces used by other accessors.
com.ibm.portal.state.accessors.locale  
com.ibm.portal.state.accessors.navigationshift This package contains accessors for reading and writing the navigation shift information.
com.ibm.portal.state.accessors.pagemode  
com.ibm.portal.state.accessors.portlet This package contains accessors for reading and writing portlet information.
com.ibm.portal.state.accessors.portlet.exceptions  
com.ibm.portal.state.accessors.screentemplate This package contains accessors for getting the current screen and setting a new screen.
com.ibm.portal.state.accessors.selection This package contains accessors for reading and manipulating the selection information.
com.ibm.portal.state.accessors.showtools This package contains accessors for reading and writing the show tools information.
com.ibm.portal.state.accessors.solo This package contains accessors for manipulating the solo state.
com.ibm.portal.state.accessors.statepartition This package contains accessors for reading and setting new state partition information.
com.ibm.portal.state.accessors.themetemplate This package contains accessors for the selected theme template for a given state.
com.ibm.portal.state.accessors.url This package contains accessors for creating URLs out of a given state.
com.ibm.portal.state.dom This package contains the dom document model.
com.ibm.portal.state.exceptions This package contains the exceptions used by the state interfaces.
com.ibm.portal.state.service This package contains the services for accessing the state manager.
com.ibm.portal.state.service.parameters This package contains service for accessing dealing with portlet parameters within the navigational state SPI.
com.ibm.portal.streaming.json This package defines an API for writing and parsing JSON in a stream based manner.
com.ibm.portal.streaming.json.helper  
com.ibm.portal.streaming.json.xml  
com.ibm.portal.streaming.json.xml.helper  
com.ibm.portal.taskmanager DEPRECATED - This package defines the interfaces used by the TaskManagerDelegateFactoryService.
com.ibm.portal.taskui DEPRECATED - This package defines the interfaces used by the TaskUIManager.
com.ibm.portal.taskui.dynamicui  
com.ibm.portal.theme.plugin This package defines ways to contribute content to defined "extension points" in the theme.
com.ibm.portal.theme.plugin.exception  
com.ibm.portal.theme.plugin.impl This package provides default implementations of the theme extension interfaces that may be sub-classed and reused by developers.
com.ibm.portal.toolbar  
com.ibm.portal.um  
com.ibm.portal.um.exceptions  
com.ibm.portal.um.portletservice  
com.ibm.portal.um.portletservice.legacy  
com.ibm.portal.vanityurl.model This package contains the main interfaces for the vanity URL model.
com.ibm.portal.vanityurl.model.controller This package contains the main interfaces for the vanity URL model controller.
com.ibm.portal.virtualportal  
com.ibm.portal.wcm.plr This package defines the interfaces for the Pluggable List Rendering (PLR) Framework.
com.ibm.portal.wire This package defines information about communication connections between two endpoints or communication, i.e.
com.ibm.utilities.collections  
com.ibm.utilities.collections.collections  
com.ibm.utilities.collections.lists  
com.ibm.utilities.collections.maps  
com.ibm.utilities.collections.sets  
com.ibm.utilities.streams  
com.ibm.utilities.streams.charset  
com.ibm.websphere.personalization  
com.ibm.websphere.personalization.applicationObjects  
com.ibm.websphere.personalization.context  
com.ibm.websphere.personalization.resources  
com.ibm.websphere.personalization.resources.cache  
com.ibm.websphere.personalization.security  
com.ibm.websphere.personalization.transformation  
com.ibm.websphere.query.base  
com.ibm.websphere.query.callbacks  
com.ibm.wkplc.people.portal.taglib  
com.ibm.workplace.wcm.api This package defines the IBM Web Content Manager API.
com.ibm.workplace.wcm.api.authoring  
com.ibm.workplace.wcm.api.custom This package defines the IBM Web Content Manager API interfaces for custom code.
com.ibm.workplace.wcm.api.digitalasset  
com.ibm.workplace.wcm.api.editions This package defines the IBM Web Content Manager Edition API.
com.ibm.workplace.wcm.api.editions.query  
com.ibm.workplace.wcm.api.exceptions This package defines the exceptions used in the IBM Web Content Manager API.
com.ibm.workplace.wcm.api.extensions.authoring  
com.ibm.workplace.wcm.api.extensions.authoring.directive  
com.ibm.workplace.wcm.api.extensions.digitalasset  
com.ibm.workplace.wcm.api.extensions.operation  
com.ibm.workplace.wcm.api.extensions.resolution This package defines the IBM Web Content Manager API interfaces for the ContentPageResolution Filter
com.ibm.workplace.wcm.api.extensions.resolution.exceptions This package defines exceptions used by IBM Web Content Manager API interfaces for the ContentPageResolution filter.
com.ibm.workplace.wcm.api.extensions.syndication  
com.ibm.workplace.wcm.api.extensions.url This package defines the IBM Web Content Manager API interfaces for the content URL generation.
com.ibm.workplace.wcm.api.extensions.validation  
com.ibm.workplace.wcm.api.identity  
com.ibm.workplace.wcm.api.messaging  
com.ibm.workplace.wcm.api.pagecontext  
com.ibm.workplace.wcm.api.plugin  
com.ibm.workplace.wcm.api.plugin.rendering  
com.ibm.workplace.wcm.api.plugin.textprovider  
com.ibm.workplace.wcm.api.prerender  
com.ibm.workplace.wcm.api.pzn  
com.ibm.workplace.wcm.api.query  
com.ibm.workplace.wcm.api.security  
com.ibm.workplace.wcm.api.versioning  
com.ibm.wps.cp.tagging.federation.connections.resolution  
com.ibm.wps.outbound.config  
com.ibm.wps.pb.portlet  
com.ibm.wps.pb.property This package contains public interfaces of objects (such as Property and Action) passed by the Property Broker to portlet written to the IBM portlet API, and vice-versa.
com.ibm.wps.pb.service This package contains the public interface PropertyBrokerService provided by the Property Broker to portlet written to the IBM portlet API.
com.ibm.wps.pb.wrapper  
com.ibm.wps.pe.pc.legacy  
com.ibm.wps.pe.pc.legacy.cache  
com.ibm.wps.pe.pc.legacy.cmpf  
com.ibm.wps.portlet.event This package defines interfaces for portlets using the IBM porlet API to receive event notifications.
com.ibm.wps.portlet.menu This package defines interfaces for portlets to contribute portlet menus to the navigation of the portal.
com.ibm.wps.portlets.menu This package contains convenience implementations for portlets that expose portlet menus.
com.ibm.wps.portletservice.credentialvault This package defines the Credential Vault Portlet Service.
com.ibm.wps.portletservice.credentialvault.credentials This package defines the portal provided credential objects that can be used to retrieve user credentials from the vault with the credential portlet service.
com.ibm.wps.portletservice.portletmenu This package contains convenience implementations of menu trees that can be used out-of-the-box.
com.ibm.wps.portletservice.taskmanager DEPRECATED - This package provides a IBM Portlet API service that is used to obtain a TaskManagerDelegate instance.
com.ibm.wps.portletservice.taskui DEPRECATED - This package provides a IBM Portlet API service that is used by TaskProcessingPortlets to manage the UI to process a task
com.ibm.wps.services.credentialvault This package contains the legacy EncryptionExit interface for the Credential Vault Portlet Service.
com.ibm.wps.services.federateddocuments  
com.ibm.wps.services.plr  
com.ibm.wps.wsrp.consumer.security