Package jakarta.portlet.annotations

Annotation Type PortletConfiguration

  • @Retention(RUNTIME)
@Target(TYPE)
public @interface PortletConfiguration
    Annotation for the portlet configuration. Many of these configuration parameters also appear in the portlet deployment descriptor.

    The portlet deployment descriptor can continue to be used. Values of configuration parameters appearing in the deployment descriptor have precedence over the corresponding values defined in the annotation.

    Since:
    3.0

    • Element Detail

      • portletName

        String portletName
        The portlet name for the annotated type.
        Returns:
        The portlet name

      • initParams

        InitParameter[] initParams
        The portlet initialization parameters.
        Returns:
        An array of initialization parameters
        Default:
        {}

      • runtimeOptions

        RuntimeOption[] runtimeOptions
        The portlet container runtime options.
        Returns:
        An array of portlet runtime options
        Default:
        {}

      • supportedLocales

        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:
        An array of language tag strings
        See Also:
        Locale, forLanguageTag, IETF BCP 47
        Default:
        {"en"}

      • title

        LocaleString[] title
        Locale specific static title for this portlet.
        Returns:
        The portlet title
        Default:
        {}

      • shortTitle

        LocaleString[] shortTitle
        Locale specific short version of the static title.
        Returns:
        The short title
        Default:
        {}

      • displayName

        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:
        The display name
        Default:
        {}

      • description

        LocaleString[] description
        The portlet description. It provides locale-specific text describing the portlet for use by the portal application or by tools.
        Returns:
        The portlet description
        Default:
        {}

      • keywords

        LocaleString[] keywords
        Locale specific keywords associated with this portlet. The keywords are separated by commas within the value of the LocaleString array element.
        Returns:
        The keywords
        Default:
        {}

      • prefs

        Preference[] prefs
        The portlet preferences.
        Returns:
        The portlet preferences
        Default:
        {}

      • publicParams

        String[] publicParams
        The public render parameter identifiers used by the portlet.
        Returns:
        The array of public render parameters.
        Default:
        {}

      • resourceBundle

        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:
        The resource bundle name
        Default:
        ""

      • supports

        Supports[] supports
        The supported portlet modes and window states for a given MIME type.
        Returns:
        The supported portlet modes and window states
        Default:
        {@jakarta.portlet.annotations.Supports(mimeType="text/html")}

      • cacheScopePublic

        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:
        The cache scope
        Default:
        false

      • cacheExpirationTime

        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:
        The expiration time
        Default:
        0

      • dependencies

        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:
        The dependencies
        Default:
        {}

      • roleRefs

        SecurityRoleRef[] roleRefs
        The security role references.
        Returns:
        The security role references
        Default:
        {}

      • asyncSupported

        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:
        true if the method supports asynchronous mode.
        Default:
        false

      • multipart

        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:
        The multipart configuration data.
        Default:
        @jakarta.portlet.annotations.Multipart(supported=false)