Java Doc for PortletDescriptor.java in » Portal » Open-Portal » com » sun » portal » portletcontainercommon » descriptor » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Portal » Open Portal » com.sun.portal.portletcontainercommon.descriptor

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

com.sun.portal.portletcontainercommon.descriptor .PortletDescriptor

PortletDescriptor

public class PortletDescriptor (Code)

The portlet descriptor is the descriptor for a portlet.

The PortletDescriptor loads all the descriptors for a portlet into memory, it delegates the loading of each descriptor to the sub descriptor classe.

The PortletDescriptor class provides member methods to get to all sub descriptors, the portlet name, portlet class name, as well as the description, if available. The following get**() methods are defined:

getPortletName()
getPortletClassName()
getDescriptions()
getDisplayName()
getDisplayNames()
getDisplayNameMap()
getSupportedLocales()
getPortletPreferencesDescriptor()
getInitParamDescriptors()
getSupportsDescriptors()
getSupportsDescriptorMap()
getSupportedPortletModes
getCacheExpiration
getPortletInfoDescriptor
getSecurityRoleRefDescriptors
getDeploymentExtensionDescriptors

Field Summary
final public static String	DEPLOYMENT_EXTENSION
final public static String	EXPIRATION_CACHE
final public static int	EXPIRATION_CACHE_NOT_DEFINED
final public static String	INIT_PARAM
final public static String	PORTLET
final public static String	PORTLET_CLASS
final public static String	PORTLET_INFO
final public static String	PORTLET_NAME
final public static String	PORTLET_PREFERENCES
final public static String	RESOURCE_BUNDLE
final public static String	SECURITY_ROLE_REF
final public static String	SUPPORTED_LOCALE
final public static String	SUPPORTS

Constructor Summary
public	PortletDescriptor(Logger logger, DeploymentExtensionDescriptor depExtDescriptor)

Method Summary
public int	getCacheExpiration() Returns the cache expiration. `int` of expiration number.
public String	getClassName() Returns portlet class name.
public LinkedHashMap	getConsumeEvents()
public String	getDescription() Returns the description as a `String`.
public Map	getDescriptionMap() Returns portlet descriptions in a Map. `Map` of lang/description pairs of theportlet descriptions.
public List	getDescriptions() Returns portlet descriptions in a List. `List` of `String`s of theportlet descriptions.
public Map	getDisplayNameMap() Returns portlet display names in a Map `Map` of lang/display name pairs of theportlet display names.
public List	getDisplayNames() Returns portlet display names in a List. `List` of `String`s of theportlet display names.
public LinkedHashMap	getGeneratedEvents()
public List	getInitParamDescriptors() Returns the init param descriptors.
public PortletInfoDescriptor	getPortletInfoDescriptor() Returns the portlet info descriptor.
public String	getPortletName() Returns portlet name.
public PortletPreferencesDescriptor	getPortletPreferencesDescriptor() Returns the portlet preferences descriptor.
public String	getResourceBundle() Returns the name of the resource bundle.
public List	getSecurityRoleRefDescriptors() Returns the security role ref descriptors.
public List	getSupportedLocales() Returns the supported locales in a List. `List` of `String`s of thesupported locales.
public List	getSupportedMimeTypes() Returns the supported mime types.
public List	getSupportedPortletModes(String mime) Returns the supported portlet modes of a specified mime type.
public List	getSupportsDescriptors() Returns the supports descriptors.
public void	load(Element element, Namespace namespace) Loads the portlet descriptor and sub descriptors into memory.
public boolean	sessionEnabled()
public String	toString() The toString method.

Field Detail

DEPLOYMENT_EXTENSION
final public static String DEPLOYMENT_EXTENSION(Code)

EXPIRATION_CACHE
final public static String EXPIRATION_CACHE(Code)

EXPIRATION_CACHE_NOT_DEFINED
final public static int EXPIRATION_CACHE_NOT_DEFINED(Code)

INIT_PARAM
final public static String INIT_PARAM(Code)

PORTLET
final public static String PORTLET(Code)

PORTLET_CLASS
final public static String PORTLET_CLASS(Code)

PORTLET_INFO
final public static String PORTLET_INFO(Code)

PORTLET_NAME
final public static String PORTLET_NAME(Code)

PORTLET_PREFERENCES
final public static String PORTLET_PREFERENCES(Code)

RESOURCE_BUNDLE
final public static String RESOURCE_BUNDLE(Code)

SECURITY_ROLE_REF
final public static String SECURITY_ROLE_REF(Code)

SUPPORTED_LOCALE
final public static String SUPPORTED_LOCALE(Code)

SUPPORTS
final public static String SUPPORTS(Code)

Constructor Detail

PortletDescriptor
public PortletDescriptor(Logger logger, DeploymentExtensionDescriptor depExtDescriptor)(Code)

Method Detail

getCacheExpiration
public int getCacheExpiration()(Code)
	Returns the cache expiration. `int` of expiration number. Returns -999 ifexpiration is not defined. A value of -1 means cache is neverexpired, a value of 0 means cache is disabled.

getClassName
public String getClassName()(Code)
	Returns portlet class name. `String` of the portlet class name.

getConsumeEvents
public LinkedHashMap getConsumeEvents()(Code)

getDescription
public String getDescription()(Code)
	Returns the description as a `String`. If there's more than one descriptions are defined, returns the first one. `String` of the description. The returnvalue could be null if no description is defined.

getDescriptionMap
public Map getDescriptionMap()(Code)
	Returns portlet descriptions in a Map. `Map` of lang/description pairs of theportlet descriptions. Empty `Map` will be returned if not defined.

getDescriptions
public List getDescriptions()(Code)
	Returns portlet descriptions in a List. `List` of `String`s of theportlet descriptions. Empty `List` will be returned if not defined.

getDisplayNameMap
public Map getDisplayNameMap()(Code)
	Returns portlet display names in a Map `Map` of lang/display name pairs of theportlet display names. Empty `Map` will be returned if not defined.

getDisplayNames
public List getDisplayNames()(Code)
	Returns portlet display names in a List. `List` of `String`s of theportlet display names. Empty `List` will be returned if not defined.

getGeneratedEvents
public LinkedHashMap getGeneratedEvents()(Code)

getInitParamDescriptors
public List getInitParamDescriptors()(Code)
	Returns the init param descriptors. `List` of `InitParamDescriptor`s.

getPortletInfoDescriptor
public PortletInfoDescriptor getPortletInfoDescriptor()(Code)
	Returns the portlet info descriptor. `PortletInfoDescriptor`

getPortletName
public String getPortletName()(Code)
	Returns portlet name. `String` of the portlet name.

getPortletPreferencesDescriptor
public PortletPreferencesDescriptor getPortletPreferencesDescriptor()(Code)
	Returns the portlet preferences descriptor. `PortletPreferencesDescriptor`

getResourceBundle
public String getResourceBundle()(Code)
	Returns the name of the resource bundle. Clients should call this method only if `getType`() returns RESOURCE_TYPE_RB. `String` of the resource bundle.

getSecurityRoleRefDescriptors
public List getSecurityRoleRefDescriptors()(Code)
	Returns the security role ref descriptors. `List` of `SecurityRoleRefDescriptor`s.

getSupportedLocales
public List getSupportedLocales()(Code)
	Returns the supported locales in a List. `List` of `String`s of thesupported locales. Empty `List` will be returned if not defined.

getSupportedMimeTypes
public List getSupportedMimeTypes()(Code)
	Returns the supported mime types. `List` of supported mime types.

getSupportedPortletModes
public List getSupportedPortletModes(String mime)(Code)
	Returns the supported portlet modes of a specified mime type. `List` of supported portlet modes.

getSupportsDescriptors
public List getSupportsDescriptors()(Code)
	Returns the supports descriptors. `List` of `SupportsDescriptor`s.

load

public void load(Element element, Namespace namespace) throws DeploymentDescriptorException(Code)

Loads the portlet descriptor and sub descriptors into memory.

The portlet sub descriptors includes:

SupportsDescriptor()
PortletPreferencesDescriptor()
InitParamDescriptor()
PortletInfoDescriptor()

Parameters:
  The - portlet descriptor Element
See Also:   SupportsDescriptor
See Also:   PortletPreferencesDescriptor
See Also:   InitParamDescriptor
See Also:   PortletInfoDescriptor

sessionEnabled
public boolean sessionEnabled()(Code)

toString
public String toString()(Code)
	The toString method. the `String` representation of the portletdescriptor.

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.