TM, Version 6.1.0.0
API Specification">

IBM WebSphere Portal^TM, Version 6.1.0.0
API Specification

Packages

com.ibm.lotus.search.providers.content.seedlist	Root package for the IBM Seedlist API.
com.ibm.lotus.search.providers.content.seedlist.common	Package contains common Seedlist Retriever and Formatter API interfaces.
com.ibm.lotus.search.providers.content.seedlist.formatter	Package contains interfaces for formatting retrieved content from a content provider application.
com.ibm.lotus.search.providers.content.seedlist.retriever	Package contains interfaces for retrieving content from specific content provider.
com.ibm.lotus.search.providers.content.seedlist.url	Package contains a single interface which allows generation of different URLs, which are required for successive navigation over the content.
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.admin	This package defines elements of the portal occurring in several administrable models.
com.ibm.portal.app.component
com.ibm.portal.app.exceptions
com.ibm.portal.app.extensions
com.ibm.portal.app.model
com.ibm.portal.app.service.backup	This package defines a service that can be used by business components to backup/restore arbitrary binary data.
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.content	This package defines content elements of the portal and its surrounding infrastructure.
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.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.model	This package defines ways to obtain models through JNDI lookups.
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.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.portlet	This package defines IBM API extension for portlets using the Java Portlet API, which implement the javax.portlet.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.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.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	This package provides a Java Portlet API service that is used to obtain a TaskManagerDelegate instance.
com.ibm.portal.portlet.service.taskui	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.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.url
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.cai.helper
com.ibm.portal.resolver.data	Provides for the interfaces required to serve data via the POC resolution framework.
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.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.mashup
com.ibm.portal.resolver.service
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.xml
com.ibm.portal.resolver.xml.helper
com.ibm.portal.resolver.xul
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.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.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 contains interfaces related to url generation.
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.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.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.struts.action	This package and its subpackages define the API for the Struts Actions extensions in the Struts Portlet Framework.
com.ibm.portal.struts.command	This package and its subpackages define the API for the commands for the Struts application Struts Portlet Framework.
com.ibm.portal.struts.common	This package and its subpackages define the common APIs for the Struts Portlet Framework.
com.ibm.portal.struts.data	This package and its subpackages define the API for storing and retrieving data with Struts Portlet Framework.
com.ibm.portal.struts.logging
com.ibm.portal.struts.plugins	This package and its subpackages define the API for the plugins for the Struts application Struts Portlet Framework.
com.ibm.portal.struts.portlet	This package and its subpackages define the API for the extension points for the Struts application Struts Portlet Framework.
com.ibm.portal.struts.upload	This package and its subpackages define the API for the file upload extension points for the Struts application Struts Portlet Framework.
com.ibm.portal.taskmanager	This package defines the interfaces used by the TaskManagerDelegateFactoryService.
com.ibm.portal.taskui	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.um
com.ibm.portal.um.exceptions
com.ibm.portal.um.portletservice
com.ibm.portal.um.portletservice.legacy
com.ibm.portal.wire	This package defines information about communication connections between two endpoints or communication, i.e.
com.ibm.struts.data	This package and its subpackages define the API for storing and retrieving data with Struts Portlet Framework.
com.ibm.struts.taglib.html
com.ibm.wps.ai.model
com.ibm.wps.engine.tags
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.policy.services
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.portlets.struts	This package and its subpackages define the API for the extension points for the Struts application Struts Portlet Framework.
com.ibm.wps.portlets.struts.logging
com.ibm.wps.portlets.struts.plugins	This package and its subpackages define the API for the plugins used by the Struts Portlet Framework.
com.ibm.wps.portlets.struts.upload	This package and its subpackages define the API for the file upload support in the Struts Portlet Framework.
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	This package provides a IBM Portlet API service that is used to obtain a TaskManagerDelegate instance.
com.ibm.wps.portletservice.taskui	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.globalization
com.ibm.wps.struts.action	This package and its subpackages define the API for the Portal friendly Struts Action support in the Struts Portlet Framework.
com.ibm.wps.struts.common	This package and its subpackages define the Common API for the Struts Portlet Framework.
com.ibm.wps.wsrp.consumer.security
org.apache.jetspeed.portlet	This package and its subpackages define the Portlet API and provide interfaces for portlets.
org.apache.jetspeed.portlet.event	This package defines interfaces for events and listeners.
org.apache.jetspeed.portlet.service	This package defines interfaces which allow to access portlet services provided by other programmers.
org.apache.jetspeed.portlet.service.spi	This package defines the Service Provider Interface (SPI) and provides interfaces which programmers may use to implement new portlet services.