当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

WSRPPortletInfo - JBOSS Portal 2.6 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jboss.portal.wsrp.consumer.portlet.info
Class WSRPPortletInfo

java.lang.Object
  org.jboss.portal.wsrp.consumer.portlet.info.WSRPPortletInfo

All Implemented Interfaces:

PortletInfo

---

public class WSRPPortletInfo

extends java.lang.Object

implements PortletInfo

Since:

2.4 (Apr 30, 2006)

Version:

$Revision: 5440 $

Author:

Chris Laprun

---

Nested Class Summary
(package private)  class	WSRPPortletInfo.BasicModeInfo
(package private)  class	WSRPPortletInfo.BasicWindowStateInfo
(package private)  class	WSRPPortletInfo.MIMETypeInfo

 

Field Summary
private  CapabilitiesInfo	capabilities
private  boolean	defaultMarkupSecure
private  boolean	doesUrlTemplateProcessing
private  java.lang.String	groupId
private  boolean	hasUserSpecificState
private  MetaInfo	metaInfo
private  boolean	onlySecure
private  boolean	templatesStoredInSession
private  boolean	userContextStoredInSession
private  boolean	usesMethodGet

 

Constructor Summary

WSRPPortletInfo(PortletDescription portletDescription)

 

Method Summary
private  void	createCapabilitiesInfo(PortletDescription portletDescription)
private  void	createMetaInfo(PortletDescription portletDescription)
private  LocalizedString	createPortalLocalizedStringFrom(LocalizedString wsrpLocalizedString)
private  void	createWSRPInfo(PortletDescription portletDescription)
CacheInfo	getCache()           Retrieves caching-related information for the described portlet.
CapabilitiesInfo	getCapabilities()           Retrieves the capabilities of supported by the described portlet.
java.lang.String	getGroupId()
MetaInfo	getMeta()           Retrieves the portlet description (title, keywords, etc).
PreferencesInfo	getPreferences()           Return null for now as the wsrp implementation does not support management.
SecurityInfo	getSecurity()           Retrieves the security information for the described portlet.
SessionInfo	getSession()           Retrieves session-related information for the described portlet.
boolean	isDefaultMarkupSecure()
boolean	isDoesUrlTemplateProcessing()
boolean	isHasUserSpecificState()
boolean	isOnlySecure()
java.lang.Boolean	isRemotable()           Determines whether the described portlet can be accessed remotely (such as via WSRP) or not.
boolean	isTemplatesStoredInSession()
boolean	isUserContextStoredInSession()
boolean	isUsesMethodGet()

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

capabilities

private CapabilitiesInfo capabilities

---

metaInfo

private MetaInfo metaInfo

---

usesMethodGet

private boolean usesMethodGet

---

defaultMarkupSecure

private boolean defaultMarkupSecure

---

onlySecure

private boolean onlySecure

---

hasUserSpecificState

private boolean hasUserSpecificState

---

userContextStoredInSession

private boolean userContextStoredInSession

---

templatesStoredInSession

private boolean templatesStoredInSession

---

doesUrlTemplateProcessing

private boolean doesUrlTemplateProcessing

---

groupId

private java.lang.String groupId

Constructor Detail

WSRPPortletInfo

public WSRPPortletInfo(PortletDescription portletDescription)

Method Detail

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()

Return null for now as the wsrp implementation does not support management.

Specified by:

getPreferences in interface PortletInfo

Returns:

null

---

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.

---

isUsesMethodGet

public boolean isUsesMethodGet()

---

isDefaultMarkupSecure

public boolean isDefaultMarkupSecure()

---

isOnlySecure

public boolean isOnlySecure()

---

isHasUserSpecificState

public boolean isHasUserSpecificState()

---

isUserContextStoredInSession

public boolean isUserContextStoredInSession()

---

isTemplatesStoredInSession

public boolean isTemplatesStoredInSession()

---

isDoesUrlTemplateProcessing

public boolean isDoesUrlTemplateProcessing()

---

getGroupId

public java.lang.String getGroupId()

---

createWSRPInfo

private void createWSRPInfo(PortletDescription portletDescription)

---

createCapabilitiesInfo

private void createCapabilitiesInfo(PortletDescription portletDescription)

---

createMetaInfo

private void createMetaInfo(PortletDescription portletDescription)

---

createPortalLocalizedStringFrom

private LocalizedString createPortalLocalizedStringFrom(LocalizedString wsrpLocalizedString)

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---