Java Portlet API V3.0 3.0.1 · javax.portlet.annotations.PortletConfiguration

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the method supports asynchronous mode. asyncSupported() Declares whether the portlet supports asynchronous operation mode.
public int	Returns: The expiration time cacheExpirationTime() Expiration-time defines the time in seconds after which the portlet output expires.
public boolean	Returns: The cache scope cacheScopePublic() The cache scope, which defines whether generated portlet content is private for the user or can be shared across different users.
public Dependency[]	Returns: The dependencies dependencies() The dependencies the portlet may have on external resources.
public LocaleString[]	Returns: The portlet description description() The portlet description.
public LocaleString[]	Returns: The display name displayName() The display-name type contains a locale-specific short name that is intended to be displayed by tools.
public InitParameter[]	Returns: An array of initialization parameters initParams() The portlet initialization parameters.
public LocaleString[]	Returns: The keywords keywords() Locale specific keywords associated with this portlet.
public Multipart	Returns: The multipart configuration data. multipart() Provides multipart configuration data for the portlet.
public String	Returns: The portlet name portletName() The portlet name for the annotated type.
public Preference[]	Returns: The portlet preferences prefs() The portlet preferences.
public String[]	Returns: The array of public render parameters. publicParams() The public render parameter identifiers used by the portlet.
public String	Returns: The resource bundle name resourceBundle() The resource bundle name for this portlet.
public SecurityRoleRef[]	Returns: The security role references roleRefs() The security role references.
public RuntimeOption[]	Returns: An array of portlet runtime options runtimeOptions() The portlet container runtime options.
public LocaleString[]	Returns: The short title shortTitle() Locale specific short version of the static title.
public String[]	Returns: An array of language tag strings supportedLocales() The locales supported by the portlet.
public Supports[]	Returns: The supported portlet modes and window states supports() The supported portlet modes and window states for a given `MIME` type.
public LocaleString[]	Returns: The portlet title title() Locale specific static title for this portlet.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

asyncSupported back to summary

asyncSupported	back to summary
public boolean asyncSupported() Declares whether the portlet supports asynchronous operation mode. If this flag is set, any resource method used by this portlet will be marked as supporting asynchronous operation. Asynchronous support applies to resource methods only. Returns:boolean `true` if the method supports asynchronous mode.

public boolean asyncSupported()

Declares whether the portlet supports asynchronous operation mode.

If this flag is set, any resource method used by this portlet will be marked as supporting asynchronous operation. Asynchronous support applies to resource methods only.

Returns:boolean: true if the method supports asynchronous mode.

cacheExpirationTime	back to summary
public int cacheExpirationTime() Expiration-time defines the time in seconds after which the portlet output expires. A value of -1 indicates that the output never expires. This value is set before the annotated method is called. Returns:int The expiration time

cacheExpirationTime

back to summary

public int cacheExpirationTime()

Expiration-time defines the time in seconds after which the portlet output expires. A value of -1 indicates that the output never expires.

This value is set before the annotated method is called.

Returns:int: The expiration time

cacheScopePublic back to summary

cacheScopePublic	back to summary
public boolean cacheScopePublic() The cache scope, which defines whether generated portlet content is private for the user or can be shared across different users. If this field is set to `TRUE`, cached information can be shared between users. Otherwise cached information will be considered private to the user. This value is set before the annotated method is called. Returns:boolean The cache scope

public boolean cacheScopePublic()

The cache scope, which defines whether generated portlet content is private for the user or can be shared across different users.

If this field is set to TRUE, cached information can be shared between users. Otherwise cached information will be considered private to the user.

This value is set before the annotated method is called.

Returns:boolean: The cache scope

dependencies	back to summary
public Dependency[] dependencies() The dependencies the portlet may have on external resources. The resources can represent client-side prerequisites such as JavaScript libraries or stylesheet resources that are shared among portlets. Returns:Dependency[] The dependencies

dependencies

back to summary

public Dependency[] dependencies()

The dependencies the portlet may have on external resources. The resources can represent client-side prerequisites such as JavaScript libraries or stylesheet resources that are shared among portlets.

Returns:Dependency[]: The dependencies

description	back to summary
public LocaleString[] description() The portlet description. It provides locale-specific text describing the portlet for use by the portal application or by tools. Returns:LocaleString[] The portlet description

description

back to summary

public LocaleString[] description()

The portlet description. It provides locale-specific text describing the portlet for use by the portal application or by tools.

Returns:LocaleString[]: The portlet description

displayName	back to summary
public LocaleString[] displayName() The display-name type contains a locale-specific short name that is intended to be displayed by tools. It is used by display-name elements. The display name need not be unique. Returns:LocaleString[] The display name

displayName

back to summary

public LocaleString[] displayName()

The display-name type contains a locale-specific short name that is intended to be displayed by tools. It is used by display-name elements. The display name need not be unique.

Returns:LocaleString[]: The display name

initParams	back to summary
public InitParameter[] initParams() The portlet initialization parameters. Returns:InitParameter[] An array of initialization parameters

initParams

back to summary

public InitParameter[] initParams()

The portlet initialization parameters.

Returns:InitParameter[]: An array of initialization parameters

keywords back to summary

keywords	back to summary
public LocaleString[] keywords() Locale specific keywords associated with this portlet. The keywords are separated by commas within the value of the `LocaleString` array element. Returns:LocaleString[] The keywords

public LocaleString[] keywords()

Locale specific keywords associated with this portlet. The keywords are separated by commas within the value of the LocaleString array element.

Returns:LocaleString[]: The keywords

multipart back to summary

multipart	back to summary
public Multipart multipart() Provides multipart configuration data for the portlet. The `@Multipart` annotation `supported` element must be set to `true` to activate multipart form support. Returns:Multipart The multipart configuration data.

public Multipart multipart()

Provides multipart configuration data for the portlet.

The @Multipart annotation supported element must be set to true to activate multipart form support.

Returns:Multipart: The multipart configuration data.

portletName	back to summary
public String portletName() The portlet name for the annotated type. Returns:String The portlet name

portletName

back to summary

public String portletName()

The portlet name for the annotated type.

Returns:String: The portlet name

prefs	back to summary
public Preference[] prefs() The portlet preferences. Returns:Preference[] The portlet preferences

prefs

back to summary

public Preference[] prefs()

The portlet preferences.

Returns:Preference[]: The portlet preferences

publicParams	back to summary
public String[] publicParams() The public render parameter identifiers used by the portlet. Returns:String[] The array of public render parameters.

publicParams

back to summary

public String[] publicParams()

The public render parameter identifiers used by the portlet.

Returns:String[]: The array of public render parameters.

resourceBundle	back to summary
public String resourceBundle() The resource bundle name for this portlet. Name of the resource bundle containing the language specific portlet information in different languages. the file name is specified without the language specific part (e.g. _en) or the file extension. Returns:String The resource bundle name

resourceBundle

back to summary

public String resourceBundle()

The resource bundle name for this portlet. Name of the resource bundle containing the language specific portlet information in different languages.

the file name is specified without the language specific part (e.g. _en) or the file extension.

Returns:String: The resource bundle name

roleRefs	back to summary
public SecurityRoleRef[] roleRefs() The security role references. Returns:SecurityRoleRef[] The security role references

roleRefs

back to summary

public SecurityRoleRef[] roleRefs()

The security role references.

Returns:SecurityRoleRef[]: The security role references

runtimeOptions	back to summary
public RuntimeOption[] runtimeOptions() The portlet container runtime options. Returns:RuntimeOption[] An array of portlet runtime options

runtimeOptions

back to summary

public RuntimeOption[] runtimeOptions()

The portlet container runtime options.

Returns:RuntimeOption[]: An array of portlet runtime options

shortTitle	back to summary
public LocaleString[] shortTitle() Locale specific short version of the static title. Returns:LocaleString[] The short title

shortTitle

back to summary

public LocaleString[] shortTitle()

Locale specific short version of the static title.

Returns:LocaleString[]: The short title

supportedLocales back to summary

supportedLocales	back to summary
public String[] supportedLocales() The locales supported by the portlet. An array of String values, each of which represents a single locale. The locale is specified as a language tag as defined in IETF BCP 47, "Tags for Identifying Languages". Returns:String[] An array of language tag strings See Also `java.util.Locale`, `forLanguageTag`, IETF BCP 47

public String[] supportedLocales()

The locales supported by the portlet. An array of String values, each of which represents a single locale.

The locale is specified as a language tag as defined in IETF BCP 47, "Tags for Identifying Languages".

Returns:String[]: An array of language tag strings
See Also: java.util.Locale, forLanguageTag, IETF BCP 47

supports back to summary

supports	back to summary
public Supports[] supports() The supported portlet modes and window states for a given `MIME` type. Returns:Supports[] The supported portlet modes and window states

public Supports[] supports()

The supported portlet modes and window states for a given MIME type.

Returns:Supports[]: The supported portlet modes and window states

title	back to summary
public LocaleString[] title() Locale specific static title for this portlet. Returns:LocaleString[] The portlet title

title

back to summary

public LocaleString[] title()

Locale specific static title for this portlet.

Returns:LocaleString[]: The portlet title

public @Interface PortletConfiguration

Method Summary

Method Detail