uPortal 2.4.1
API Documentation

Package org.jasig.portal

Interface Summary
IAnchoringSerializer An anchoring serializer allows an external client to control its anchor identifier.
IBasicEntity Minimal interface describes an entity that has only a key and a type.
ICacheable An interface that a cacheable channel must implement.
IChannel An interface presented by a channel to a portal.
IChannelRegistryStore Interface defining how the portal reads and writes its channel types, definitions, and categories.
IChannelRenderer The IChannelRenderer defines channel rendering interface.
IChannelRendererFactory The IChannelRendererFactory interface defines the factory interface for IChannelRenderer objects.
ICharacterChannel An optional channel interface that allows channels to provide their content in a character form (as opposed to XML form).
IDirectResponse An interface that a channel that wants to have direct access to the HttpServletResponse object must implement.
IMimeResponse An interface that a channel that wants to download MIME files must implement.
IMultithreadedCacheable A cacheable interface for the multithreaded channels
IMultithreadedChannel An interface for multithreaded channels.
IMultithreadedCharacterChannel A multithreaded version of a ICharacterChannel.
IMultithreadedDirectResponse An interface that a multithreaded channel that wants to have direct access to the HttpServletResponse object must implement.
IMultithreadedMimeResponse An interface that a multithreaded channel that wants to download MIME files must implement.
IMultithreadedPrivileged An interface that a multithreaded privileged channel must implement.
IOIDGenerator A very basic interface for returning oids.
IPermissible This interface represents the set of questions any channel or service ("Owner") must answer if it wants to delegate the responsibility of assigning and viewing permissions to the Permissions Manager channel.
IPortletPreferencesStore The IPortletPreferenceStore allows a portlet to atomicly persist preferences at two different levels.
IPrivileged This is an ancestor of the IPrivilegedChannel interface, allows for more general handling of both regular and multithreaded (IMultithreadedChannel) privileged channels in the framework.
IPrivilegedChannel Channels implementing this interface are considered "privileged" because they will have access to internal portal control structures such as the HttpServletRequest, HttpServletReponse, and UserPreferencesManager.
ISequenceGenerator An interface for returning sequences derived from named counters.
ISequenceGeneratorFactory A factory for ISequenceGenerators.
IServant An interface that a Servant Channel must implement.
IUserIdentityStore Interface for managing creation and removal of User Portal Data
IUserLayoutStore  
IUserPreferencesManager Interface to user preferences management class.
IWorkerRequestProcessor An interface for worker request processors.
RDBMServices.IJoinQueryString  
 

Class Summary
BrowserInfo  
ChannelCacheEntry This class takes care of initiating channel rendering thread, monitoring it for timeouts, retreiving cache, and returning rendering results and status.
ChannelCacheKey A general channel cache key class.
ChannelCategory A channel category.
ChannelDefinition Describes a published channel.
ChannelFactory A factory class that produces IChannel instances.
ChannelIncorporationFilter A filter that incorporates content rendered by the channels in to the main transformation stream.
ChannelManager ChannelManager shall have the burden of squeezing content out of channels.
ChannelParameter Describes a channel definition parameter A channel can have zero or more parameters.
ChannelRegistryManager Manages the channel registry which is a listing of published channels that one can subscribe to (add to their layout).
ChannelRegistryStoreFactory Produces an implementation of IChannelRegistryStore
ChannelRenderer This class takes care of initiating channel rendering thread, monitoring it for timeouts, retreiving cache, and returning rendering results and status.
ChannelRendererFactory The ChannelRendererFactory creates IChannelRendererFactory objects which are used to construct IChannelRenderer objects with implementation specific parameters.
ChannelRendererFactoryImpl The ChannelRendererFactoryImpl creates IChannelRenderer objects which use a bounded thread pool.
ChannelRenderingBuffer Channel Rendering buffer allows portal to accumulate a list of all channels that will have to be rendered.
ChannelRuntimeData A set of runtime data accessible by a channel.
ChannelRuntimeProperties Used to store Runtime channel properties.
ChannelSAXStreamFilter Filters out startDocument and endDocument from the channel content.
ChannelStaticData Used to store channel configuration items and parameters.
ChannelType A channel type references a particular java class that implements the IChannel interface.
CharacterCacheEntry This class is used by UserInstance.
CharacterCachingChannelIncorporationFilter A filter that incorporates channel content into the main SAX stream.
Constants Houses constants used in the portal code base.
CoreStylesheetDescription CoreStyleSheetDescription contains properties common to all core stylesheets.
CoreXSLTStylesheetDescription CoreXSLTStyleSheetDescription contains properties of core XSLT stylesheets.
DownloadDispatchWorker Provides file download capability for the portal.
EntityIdentifier A key and type that uniquely identify a portal entity.
EntityTypes This class provides access to the entity types used by IBasicEntities and the classes in org.jasig.portal.groups and org.jasig.portal.concurrency.
ErrorID Represents a portal error or problem.
Errors Contains common ErrorIDs.
ExceptionHelper  
GuestUserInstance A multithreaded version of a UserInstance.
GuestUserPreferencesManager Multithreaded version of UserPreferencesManager.
GuestUserPreferencesManagerWrapper A class that allows GuestUserPreferencesManager to be presented as IUserpreferencesManager.
HttpProxyServlet Proxy embedded content such as images for portal sessions.
ICCRegistry A proxy class that allows channels to contribute to inter channel communication registry.
InternalPortalException A serious internal portal exception.
LdapServices Deprecated. As of uPortal 2.4, use LdapServices.
LoginServlet Receives the username and password and tries to authenticate the user.
LogoutServlet Simple servlet to handle user logout.
MediaManager A tool for managing various media properties.
MultipartDataSource  
MultithreadedCacheableChannelAdapter Internal adapter for a multithreaded channel that is also cacheable.
MultithreadedCacheableCharacterChannelAdapter Internal adapter for a multithreaded character channel that is also cacheable.
MultithreadedCacheableMimeResponseChannelAdapter Internal adapter for a multithreaded channel that is also cacheable and implements IMimeResponse (capable of using DonwloadWorker)
MultithreadedCacheableMimeResponseCharacterChannelAdapter Internal adapter for a multithreaded character channel that is also cacheable and implements IMimeResponse (capable of using DonwloadWorker)
MultithreadedChannelAdapter Internal adaptor class that presents IMultithreadedChannel as a simple IChannel
MultithreadedCharacterChannelAdapter Internal adaptor class that presents IMultithreadedCharacterChannel as a simple IChannel
MultithreadedMimeResponseChannelAdapter Internal adapter for a multithreaded channel that also implements IMimeResponse (capable of using DonwloadWorker)
MultithreadedMimeResponseCharacterChannelAdapter Internal adapter for a multithreaded character channel that also implements IMimeResponse (capable of using DonwloadWorker)
MultithreadedPrivilegedCacheableChannelAdapter Internal adapter for a multithreaded channel that is also both privileged and cacheable.
MultithreadedPrivilegedCacheableCharacterChannelAdapter Internal adapter for a multithreaded character channel that is also both privileged and cacheable.
MultithreadedPrivilegedCacheableDirectResponseCharacterChannelAdapter  
MultithreadedPrivilegedCacheableMimeResponseChannelAdapter Internal adapter for a multithreaded privileged channel that is also cacheable and implements IMimeResponse (capable of using DonwloadWorker)
MultithreadedPrivilegedCacheableMimeResponseCharacterChannelAdapter Internal adapter for a multithreaded privileged character channel that is also cacheable and implements IMimeResponse (capable of using DonwloadWorker)
MultithreadedPrivilegedChannelAdapter Internal adapter for a multithreaded channel that is also privileged.
MultithreadedPrivilegedCharacterChannelAdapter Internal adapter for a multithreaded character channel that is also privileged.
MultithreadedPrivilegedMimeResponseChannelAdapter Internal adapter for a multithreaded channel that is also privileged.
MultithreadedPrivilegedMimeResponseCharacterChannelAdapter Internal adapter for a multithreaded character channel that is also privileged.
OracleUserLayoutStore Sequence numbers have the form of {Table Name}_SEQ and, at the moment, they must have been created by hand before uPortal is started.
PortalControlStructures This object is passed to special channels.
PortalEvent Signifies an event generated at the Layout level that is passed on to a channel.
PortalSessionManager This is an entry point into the uPortal.
PortletPreferencesStoreFactory Locates and creates an implementation of IPortletPreferencesStore as specified by the "org.jasig.portal.PortletPreferencesStoreFactory.implementation" property in portal.properties
Problems A servlet that reports portal problems.
ProblemsTable A cache of recently reported PortalExceptions.
PropertiesManager Deprecated. since uPortal 2.4, this class has moved to org.jasig.portal.properties
RDBMChannelRegistryStore Reference implementation of IChannelRegistryStore.
RDBMPortletPreferencesStore An implementation of IPortletPreferencesStore which uses a RDBM data source to persist the data.
RDBMServices Provides relational database access and helper methods.
RDBMServices.JdbcDb  
RDBMServices.JoinQueryString  
RDBMServices.OracleDb  
RDBMServices.PostgreSQLDb  
RDBMServices.PreparedStatement Wrapper for/Emulator of PreparedStatement class
RDBMUserIdentityStore SQL implementation for managing creation and removal of User Portal Data
RDBMUserLayoutStore SQL implementation for the 2.x relational database model
ReferenceSequenceGenerator  
ReferenceSequenceGeneratorFactory  
RequestParamWrapper Wraps an http request object to prevent unverified requests from accessing any of the request parameters.
ResponseSubstitutionWrapper Replaces tags in the markup with the tag for the current request.
StandaloneChannelRenderer StandaloneChannelRenderer is meant to be used as a base class for channels that might be rendered outside of the standard user-layout driven scheme.
StructureAttributesIncorporationFilter Filter incorporating channel and folder attributes for the structure transformation
StructureStylesheetDescription Stylesheet description for stylesheets performing structure transformation
StructureStylesheetUserPreferences User preferences for stylesheets performing structure transformation
StylesheetDescription Combines all of the information required to describe an XSLT stylesheet.
StylesheetSet A tool for managing a collection of stylesheets.
StylesheetUserPreferences Description of user preferences that are common to all of the core stylesheets
ThemeAttributesIncorporationFilter  
ThemeStylesheetDescription Stylesheet description for stylesheets performing theme transformation
ThemeStylesheetUserPreferences User preferences for stylesheets performing theme transformation
UPFileSpec This helper class allows for easy access to the information contained in the ever-changing uP file URL spec.
UserIdentityStoreFactory Produces an implementation of IUserIdentityStore
UserInstance A class handling holding all user state information.
UserInstanceManager Determines which user instance object to use for a given user.
UserLayoutStoreFactory Produces an implementation of IUserLayoutStore
UserPreferences Object managing user preferences.
UserPreferencesManager UserPreferencesManager is responsible for keeping: user id, user layout, user preferences and stylesheet descriptions.
UserProfile A user profile associates a user layout with a structure and theme stylesheet.
Version Contains version information about the current release.
 

Exception Summary
AuthorizationException This exception would inform uPortal that an authorization violation has occured within a channel.
GeneralRenderingException This exception would inform uPortal that a general rendering problem has caused a channel to throw an exception.
InternalTimeoutException This exception would inform uPortal that a a channel has encountered an internal timeout exception.
PortalException Base portal exception class.
ResourceMissingException This exception would inform uPortal that a particular resource required to complete channel operation is missing.
 


uPortal 2.4.1
API Documentation