com.sun.portal.providers.containers
Class JSPContainerProviderAdapter

java.lang.Object
  extended bycom.sun.portal.providers.ProviderAdapter
      extended bycom.sun.portal.providers.ProfileProviderAdapter
          extended bycom.sun.portal.providers.jsp.JSPProvider
              extended bycom.sun.portal.providers.containers.JSPContainerProviderAdapter
All Implemented Interfaces:
ContainerProvider, Provider, ProviderEditTypes, ProviderWidths
Direct Known Subclasses:
JSPSingleContainerProvider, JSPTabContainerProvider, JSPTableContainerProvider

public class JSPContainerProviderAdapter
extends JSPProvider
implements ContainerProvider

This class provides default implementations of methods in the ContainerProvider interface implemented using a containerProviderContext object as the persistent store and extends JSPProvider to facilitate the execution of JSPs

For method details, see the descriptions in the ContainerProvider interface.

See Also:
ContainerProviderContext, JSPProvider

Field Summary
 
Fields inherited from interface com.sun.portal.providers.ProviderWidths
WIDTH_FULL_BOTTOM, WIDTH_FULL_TOP, WIDTH_THICK, WIDTH_THIN
 
Fields inherited from interface com.sun.portal.providers.ProviderEditTypes
EDIT_COMPLETE, EDIT_SUBSET
 
Constructor Summary
JSPContainerProviderAdapter()
           
 
Method Summary
 List getAvailableAndUserDefinedChannels()
          Gets the list of available and user defined channel names.
 List getAvailableChannels()
          Gets the list of available channel names.
 ContainerProviderContext getContainerProviderContext()
           
 long getRefreshTime()
          Gets the refresh time for the channel.
 List getSelectedChannels()
          Gets the list of selected channel names.
 int[] getSupportedWindowStates()
          Gets the supported window states.
 int getWindowState(String channelName)
          Gets the window state of the channel.
 void setAvailableChannels(List avail)
          Sets the list of available channel names.
 void setSelectedChannels(List sel)
          Sets the list of selected channel names.
 void setWindowState(String channelName, int windowState)
          Sets the window state of a channel.
 
Methods inherited from class com.sun.portal.providers.jsp.JSPProvider
getCompiledJSPPath, getContent, getContentPage, getEdit, getEditPage, getExistingJSPPath, getMostSpecificJSPPath, getProcessPage, includeJspPage, init, isPresentable, processEdit
 
Methods inherited from class com.sun.portal.providers.ProfileProviderAdapter
existsBooleanProperty, existsIntegerProperty, existsListProperty, existsListProperty, existsStringProperty, existsStringProperty, getBooleanProperty, getBooleanProperty, getBooleanProperty, getBooleanProperty, getClientProperty, getIntegerProperty, getIntegerProperty, getIntegerProperty, getIntegerProperty, getListProperty, getListProperty, getMapProperty, getMapProperty, getMapProperty, getMapProperty, getMapProperty, getMapProperty, getStringAttribute, getStringProperty, getStringProperty, getStringProperty, getStringProperty, getStringProperty, getStringProperty, getTemplate, getTemplate, getTemplatePath, isAllowed, setBooleanProperty, setClientProperty, setIntegerProperty, setListProperty, setMapProperty, setStringAttribute, setStringProperty
 
Methods inherited from class com.sun.portal.providers.ProviderAdapter
getContent, getDescription, getEdit, getEditType, getHelp, getHelp, getName, getProviderContext, getResourceBundle, getResourceBundle, getTitle, getWidth, isEditable, isPresentable, processEdit
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JSPContainerProviderAdapter

public JSPContainerProviderAdapter()
Method Detail

getContainerProviderContext

public ContainerProviderContext getContainerProviderContext()
                                                     throws ProviderException
Throws:
ProviderException

getSelectedChannels

public List getSelectedChannels()
                         throws ProviderException
Description copied from interface: ContainerProvider
Gets the list of selected channel names. Selected Channels are channels that are visible on the portal page.

Specified by:
getSelectedChannels in interface ContainerProvider
Returns:
The list of selected channel names, a list of string names.
Throws:
ProviderException - If the list of channel names cannot be returned.

getAvailableChannels

public List getAvailableChannels()
                          throws ProviderException
Description copied from interface: ContainerProvider
Gets the list of available channel names. Available Channels are channels that are available to be added to the portal page.

Specified by:
getAvailableChannels in interface ContainerProvider
Returns:
The list of available channel names, a list of string names.
Throws:
ProviderException - If the list of channel names cannot be returned.

getAvailableAndUserDefinedChannels

public List getAvailableAndUserDefinedChannels()
                                        throws ProviderException
Gets the list of available and user defined channel names. Available Channels are channels that are available to be added to the portal page. User Defined Channels are channels the user has created.

Returns:
The list of available and user defined channel names, a list of string names.
Throws:
ProviderException - If the list of channel names cannot be returned.

setSelectedChannels

public void setSelectedChannels(List sel)
                         throws ProviderException
Description copied from interface: ContainerProvider
Sets the list of selected channel names.

Specified by:
setSelectedChannels in interface ContainerProvider
Throws:
ProviderException - If the list of channel names cannot be set.

setAvailableChannels

public void setAvailableChannels(List avail)
                          throws ProviderException
Description copied from interface: ContainerProvider
Sets the list of available channel names.

Specified by:
setAvailableChannels in interface ContainerProvider
Throws:
ProviderException - If the list of channel names cannot be set.

getRefreshTime

public long getRefreshTime()
                    throws ProviderException
Description copied from class: ProviderAdapter
Gets the refresh time for the channel. The refresh time for a channel is used to allow containers to implement caching of content for their contained channels. This value is used to indicate the validity of the cached content.

Specified by:
getRefreshTime in interface Provider
Overrides:
getRefreshTime in class ProviderAdapter
Returns:
>0, refresh time in number of seconds that a container should wait before expiring a content cache. 0, container should never cache channel's content. -1, container may cache channel's content indefinitely.
Throws:
ProviderException - If there was an error getting the refresh time for the channel.

getWindowState

public int getWindowState(String channelName)
                   throws ProviderException
Gets the window state of the channel. This method is a default implementation of the ContainerProvider.getWindowState() This method currently has no effect and just returns ProviderWindowStates.NOT_DEFINED. Subclasses that wish to allow getting a WindowState should override this method.

Specified by:
getWindowState in interface ContainerProvider
Parameters:
channelName - channel for which the window state is requested.
Returns:
window state
Throws:
ProviderException
See Also:
ProviderWindowStates.NOT_DEFINED

setWindowState

public void setWindowState(String channelName,
                           int windowState)
                    throws UnsupportedWindowStateException
Sets the window state of a channel. This method is a default implementation of the ContainerProvider.setWindowState() This method currently has no effect and just throws UnsupportedWindowStateException. Subclasses that wish to allow setting a WindowState should override this method.

Specified by:
setWindowState in interface ContainerProvider
Parameters:
channelName - channel for which the window state needs to be set
windowState - The new window state
Throws:
UnsupportedWindowStateException.
UnsupportedWindowStateException - If the window state cannot be set or if the window state passed in is not in supported window states.
See Also:
com.sun.portal.providers.containers.ContainerProvider#getWindowState(), ContainerProvider.getSupportedWindowStates()

getSupportedWindowStates

public int[] getSupportedWindowStates()
                               throws ProviderException
Gets the supported window states. This method is a default implementation of the ContainerProvider.getSupportedWindowStates() This method currently has no effect and just returns an integer array containing ProviderWindowStates.NOT_DEFINED. Subclasses that wish to allow getting supported WindowStates should override this method.

Specified by:
getSupportedWindowStates in interface ContainerProvider
Returns:
Supported Window States as an integer array.
Throws:
ProviderException - If the window states cannot be returned.
See Also:
com.sun.portal.providers.containers.JSPContainerProviderAdapter#getWindowState(), com.sun.portal.providers.containers.JSPContainerProviderAdapter#setWindowState()