站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

ContainerPortletInfo - JBOSS Portal 2.6 API 英文版文档


org.jboss.portal.portlet.container.info
Class ContainerPortletInfo

java.lang.Object
  extended byorg.jboss.portal.portlet.container.info.ContainerPortletInfo
All Implemented Interfaces:
PortletInfo

public class ContainerPortletInfo
extends java.lang.Object
implements PortletInfo

For now implementation that use the portlet container directly.

Version:
$Revision: 5448 $
Author:
Julien Viet, Chris Laprun

Field Summary
private  ContainerCacheInfo cache
           
private  ContainerCapabilities capabilities
           
private  PortletContainer container
           
private  ContainerMetaInfo meta
           
private  ContainerPreferencesInfo preferences
           
private  java.lang.Boolean remotable
           
private  ContainerSecurityInfo security
           
private  ContainerSessionInfo session
           
 
Constructor Summary
ContainerPortletInfo(PortletContainer container, PortletResourceBundleManager bundleMgr, ContentTypes contentTypes)
           
 
Method Summary
 CacheInfo getCache()
          Retrieves caching-related information for the described portlet.
 CapabilitiesInfo getCapabilities()
          Retrieves the capabilities of supported by the described portlet.
 PortletContainer getContainer()
           
 MetaInfo getMeta()
          Retrieves the portlet description (title, keywords, etc).
 PreferencesInfo getPreferences()
          Retrieves information about the preferences supported by the described portlet, it must return null if the portlet cannot be personalized.
 SecurityInfo getSecurity()
          Retrieves the security information for the described portlet.
 SessionInfo getSession()
          Retrieves session-related information for the described portlet.
 java.lang.Boolean isRemotable()
          Determines whether the described portlet can be accessed remotely (such as via WSRP) or not.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

container

private PortletContainer container

capabilities

private ContainerCapabilities capabilities

preferences

private ContainerPreferencesInfo preferences

meta

private ContainerMetaInfo meta

security

private ContainerSecurityInfo security

cache

private ContainerCacheInfo cache

session

private ContainerSessionInfo session

remotable

private java.lang.Boolean remotable
Constructor Detail

ContainerPortletInfo

public ContainerPortletInfo(PortletContainer container,
                            PortletResourceBundleManager bundleMgr,
                            ContentTypes contentTypes)
                     throws java.lang.Exception
Method Detail

getContainer

public PortletContainer getContainer()

getCapabilities

public CapabilitiesInfo getCapabilities()
Description copied from interface: PortletInfo
Retrieves the capabilities of supported by the described portlet.

Specified by:
getCapabilities in interface PortletInfo
Returns:
the capabilities of the portlet

getPreferences

public PreferencesInfo getPreferences()
Description copied from interface: PortletInfo
Retrieves information about the preferences supported by the described portlet, it must return null if the portlet cannot be personalized.

Specified by:
getPreferences in interface PortletInfo
Returns:
the preferences meta data of the portlet

getMeta

public MetaInfo getMeta()
Description copied from interface: PortletInfo
Retrieves the portlet description (title, keywords, etc).

Specified by:
getMeta in interface PortletInfo
Returns:
the portlet description

getSecurity

public SecurityInfo getSecurity()
Description copied from interface: PortletInfo
Retrieves the security information for the described portlet.

Specified by:
getSecurity in interface PortletInfo
Returns:
the security information

getCache

public CacheInfo getCache()
Description copied from interface: PortletInfo
Retrieves caching-related information for the described portlet.

Specified by:
getCache in interface PortletInfo
Returns:
the caching related information

getSession

public SessionInfo getSession()
Description copied from interface: PortletInfo
Retrieves session-related information for the described portlet. If no information is available then it returns the null value.

Specified by:
getSession in interface PortletInfo
Returns:
the session related information

isRemotable

public java.lang.Boolean isRemotable()
Description copied from interface: PortletInfo
Determines whether the described portlet can be accessed remotely (such as via WSRP) or not. Clients of this method should be prepare to handle a null return value expressing the fact that the remotable status hasn't been explicitely set.

Specified by:
isRemotable in interface PortletInfo
Returns:
Boolean.TRUE if the described portlet can be accessed remotely, Boolean.FALSE if the described portlet cannot be accessed remotely, null if the value hasn't been specified explicitely for the associated portlet.