ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

liferay7:Portlet Descriptor to OSGi Service Property Map

2020-10-29 14:04:12  阅读:223  来源: 互联网

标签:Map portlet Service app supported javax Portlet com liferay


参考:https://help.liferay.com/hc/zh-cn/articles/360017890112-Introduction-to-Portlet-Descriptor-to-OSGi-Service-Property-Map-

Portlet Descriptor to OSGi Service Property Map

This section describes the mapping of portlet XML descriptor values to OSGi service properties that can be used when publishing OSGi Portlets.

OSGi services can contain properties in their definitions. Using OSGi service properties makes dealing with configuration concerns simple and cohesive. These properties are typically represented as key-value pairs or, more generally, as a Map-like object.

Portlet spec property keys are prefixed by:

javax.portlet.

Liferay property keys are prefixed by:

com.liferay.portlet.

The mappings essentially flatten what is found in the XML descriptor, sticking relatively closely to the original naming in order to have a memorable relationship with those definitions.

JSR-168 & JSR-286 Descriptor Mappings

Note: XPath notation derived from the Portlet XSD 4 is used in this document for simplicity.

portlet.xml XPathOSGi Portlet Service Property
/portlet-app/portlet/description javax.portlet.description=<String>
/portlet-app/portlet/portlet-name 6 javax.portlet.name=<String> 6
/portlet-app/portlet/display-name javax.portlet.display-name=<String>
/portlet-app/portlet/portlet-class 1
/portlet-app/portlet/init-param/name javax.portlet.init-param.<name>=<value>
/portlet-app/portlet/expiration-cache javax.portlet.expiration-cache=<int>
/portlet-app/portlet/cache-scope not supported
/portlet-app/portlet/supports/mime-type javax.portlet.mime-type=<mime-type>
/portlet-app/portlet/supports/portlet-mode javax.portlet.portlet-mode=<mime-type>;<portlet-mode>[,<portlet-mode>]*
/portlet-app/portlet/supports/window-state javax.portlet.window-state=<mime-type>;<window-state>[,<window-state>]*
/portlet-app/portlet/supported-locale not supported
/portlet-app/portlet/resource-bundle javax.portlet.resource-bundle=<String>
/portlet-app/portlet/portlet-info/title javax.portlet.info.title=<String>
/portlet-app/portlet/portlet-info/short-title javax.portlet.info.short-title=<String>
/portlet-app/portlet/portlet-info/keywords javax.portlet.info.keywords=<String>
/portlet-app/portlet/portlet-preferences javax.portlet.preferences=<String>
OR
javax.portlet.preferences=classpath:<path_to_file_in_jar>
/portlet-app/portlet/security-role-ref javax.portlet.security-role-ref=<String>[,<String>]2
/portlet-app/portlet/supported-processing-event/name javax.portlet.supported-processing-event=<String>
OR
javax.portlet.supported-processing-event=<String>;<QName>2
/portlet-app/portlet/supported-publishing-event javax.portlet.supported-publishing-event=<String>
OR
javax.portlet.supported-publishing-event=<String>;<QName>2
/portlet-app/portlet/supported-public-render-parameter javax.portlet.supported-public-render-parameter=<String>2
/portlet-app/portlet/container-runtime-option not supported
/portlet-app/custom-portlet-mode not supported
/portlet-app/custom-window-state not supported
/portlet-app/user-attribute not supported
/portlet-app/security-constraint not supported
/portlet-app/resource-bundle not supported
/portlet-app/filter
/portlet-app/filter-mapping
3
/portlet-app/default-namespace not supported
/portlet-app/event-definition not supported
/portlet-app/filter/init-param/name javax.portlet.init-param.<name>=<value>
/portlet-app/public-render-parameter not supported
/portlet-app/listener not supported
?javax.portlet.PortletURLGenerationListener?
/portlet-app/container-runtime-option not supported

Liferay Descriptor Mappings

LIFERAY DISPLAY

liferay-display.xml XPathOSGi Portlet Service Property
/display/category\[@name\] com.liferay.portlet.display-category=<value>

LIFERAY PORTLET

Note: XPath notation derived from Liferay Portlet 5 is used in this document for simplicity.

liferay-portlet.xml XPathOSGi Liferay Portlet Service Property
/liferay-portlet-app/portlet/portlet-name not supported
/liferay-portlet-app/portlet/icon com.liferay.portlet.icon=<String>
/liferay-portlet-app/portlet/virtual-path com.liferay.portlet.virtual-path=<String>
/liferay-portlet-app/portlet/struts-path com.liferay.portlet.struts-path=<String>
/liferay-portlet-app/portlet/parent-struts-path com.liferay.portlet.parent-struts-path=<String>
/liferay-portlet-app/portlet/configuration-path com.liferay.portlet.configuration-path=<String>
/liferay-portlet-app/portlet/configuration-action-class 3
/liferay-portlet-app/portlet/indexer-class 3
/liferay-portlet-app/portlet/open-search-class 3
/liferay-portlet-app/portlet/scheduler-entry 3
/liferay-portlet-app/portlet/portlet-url-class 3
/liferay-portlet-app/portlet/friendly-url-mapper-class 3
/liferay-portlet-app/portlet/friendly-url-mapping com.liferay.portlet.friendly-url-mapping=<String>
/liferay-portlet-app/portlet/friendly-url-routes com.liferay.portlet.friendly-url-routes=<String>
/liferay-portlet-app/portlet/url-encoder-class 3
/liferay-portlet-app/portlet/portlet-data-handler-class 3
/liferay-portlet-app/portlet/staged-model-data-handler-class 3
/liferay-portlet-app/portlet/template-handler 3
/liferay-portlet-app/portlet/portlet-layout-listener-class 3
/liferay-portlet-app/portlet/poller-processor-class 3
/liferay-portlet-app/portlet/pop-message-listener-class 3
/liferay-portlet-app/portlet/social-activity-interpreter-class 3
/liferay-portlet-app/portlet/social-request-interpreter-class 3
/liferay-portlet-app/portlet/social-interactions-configuration 3
/liferay-portlet-app/portlet/user-notification-definitions not supported
/liferay-portlet-app/portlet/user-notification-handler-class 3
/liferay-portlet-app/portlet/webdav-storage-token not supported
/liferay-portlet-app/portlet/webdav-storage-class 3
/liferay-portlet-app/portlet/xml-rpc-method-class 3
/liferay-portlet-app/portlet/control-panel-entry-category com.liferay.portlet.control-panel-entry-category=<String>
/liferay-portlet-app/portlet/control-panel-entry-weight com.liferay.portlet.control-panel-entry-weight=<double>
/liferay-portlet-app/portlet/control-panel-entry-class 3
/liferay-portlet-app/portlet/asset-renderer-factory 3
/liferay-portlet-app/portlet/atom-collection-adapter 3
/liferay-portlet-app/portlet/custom-attributes-display 3
/liferay-portlet-app/portlet/ddm-display 3
/liferay-portlet-app/portlet/permission-propagator 3
/liferay-portlet-app/portlet/trash-handler 3
/liferay-portlet-app/portlet/workflow-handler 3
/liferay-portlet-app/portlet/preferences-company-wide com.liferay.portlet.preferences-company-wide=<boolean>
/liferay-portlet-app/portlet/preferences-unique-per-layout com.liferay.portlet.preferences-unique-per-layout=<boolean>
/liferay-portlet-app/portlet/preferences-owned-by-group com.liferay.portlet.preferences-owned-by-group=<boolean>
/liferay-portlet-app/portlet/use-default-template com.liferay.portlet.use-default-template=<boolean>
/liferay-portlet-app/portlet/show-portlet-access-denied com.liferay.portlet.show-portlet-access-denied=<boolean>
/liferay-portlet-app/portlet/show-portlet-inactive com.liferay.portlet.show-portlet-inactive=<boolean>
/liferay-portlet-app/portlet/action-url-redirect com.liferay.portlet.action-url-redirect=<boolean>
/liferay-portlet-app/portlet/restore-current-view com.liferay.portlet.restore-current-view=<boolean>
/liferay-portlet-app/portlet/maximize-edit com.liferay.portlet.maximize-edit=<boolean>
/liferay-portlet-app/portlet/maximize-help com.liferay.portlet.maximize-help=<boolean>
/liferay-portlet-app/portlet/pop-up-print com.liferay.portlet.pop-up-print=<boolean>
/liferay-portlet-app/portlet/layout-cacheable com.liferay.portlet.layout-cacheable=<boolean>
/liferay-portlet-app/portlet/instanceable com.liferay.portlet.instanceable=<boolean>
/liferay-portlet-app/portlet/remoteable com.liferay.portlet.remoteable=<boolean>
/liferay-portlet-app/portlet/scopeable com.liferay.portlet.scopeable=<boolean>
/liferay-portlet-app/portlet/single-page-application com.liferay.portlet.single-page-application=<boolean>
/liferay-portlet-app/portlet/user-principal-strategy com.liferay.portlet.user-principal-strategy=<String>
/liferay-portlet-app/portlet/private-request-attributes com.liferay.portlet.private-request-attributes=<boolean>
/liferay-portlet-app/portlet/private-session-attributes com.liferay.portlet.private-session-attributes=<boolean>
/liferay-portlet-app/portlet/autopropagated-parameters com.liferay.portlet.autopropagated-parameters=<String>2
/liferay-portlet-app/portlet/requires-namespaced-parameters com.liferay.portlet.requires-namespaced-parameters=<boolean>
/liferay-portlet-app/portlet/action-timeout com.liferay.portlet.action-timeout=<int>
/liferay-portlet-app/portlet/render-timeout com.liferay.portlet.render-timeout=<int>
/liferay-portlet-app/portlet/render-weight com.liferay.portlet.render-weight=<int>
/liferay-portlet-app/portlet/ajaxable com.liferay.portlet.ajaxable=<boolean>
/liferay-portlet-app/portlet/header-portal-css com.liferay.portlet.header-portal-css=<String>2
/liferay-portlet-app/portlet/header-portlet-css com.liferay.portlet.header-portlet-css=<String>2
/liferay-portlet-app/portlet/header-portal-javascript com.liferay.portlet.header-portal-javascript=<String>2
/liferay-portlet-app/portlet/header-portlet-javascript com.liferay.portlet.header-portlet-javascript=<String>2
/liferay-portlet-app/portlet/footer-portal-css com.liferay.portlet.footer-portal-css=<String>2
/liferay-portlet-app/portlet/footer-portlet-css com.liferay.portlet.footer-portlet-css=<String>2
/liferay-portlet-app/portlet/footer-portal-javascript com.liferay.portlet.footer-portal-javascript=<String>2
/liferay-portlet-app/portlet/footer-portlet-javascript com.liferay.portlet.footer-portlet-javascript=<String>2
/liferay-portlet-app/portlet/css-class-wrapper com.liferay.portlet.css-class-wrapper=<String>
/liferay-portlet-app/portlet/facebook-integration com.liferay.portlet.facebook-integration=<String>
/liferay-portlet-app/portlet/add-default-resource com.liferay.portlet.add-default-resource=<boolean>
/liferay-portlet-app/portlet/system com.liferay.portlet.system=<boolean>
/liferay-portlet-app/portlet/active com.liferay.portlet.active=<boolean>
/liferay-portlet-app/portlet/include not supported
  • [1] Portlets are registered as concrete objects.

  • [2] Multiples of these properties may be used. This results in an array of values.

  • [3] This type is registered as an OSGi service.

  • [4] http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd

  • [5] http://www.liferay.com/dtd/liferay-portlet-app_7_0_0.dtd

  • [6] Liferay DXP creates each portlet’s ID based on the portlet’s name (i.e., the portlet-name descriptor in liferay-portlet.xml or the javax.portlet.name OSGi service property). Dashes, periods, and spaces are allowed in the portlet name, but they and all other JavaScript unsafe characters are stripped from the name value that’s used for the portlet ID. Therefore, make your portlet name unique in light of the characters that are removed. Otherwise, if you try to deploy a portlet whose ID is the same as a portlet that’s already deployed, your portlet deployment fails and Liferay DXP logs a message like this:

    Portlet id [portletId] is already in use

标签:Map,portlet,Service,app,supported,javax,Portlet,com,liferay
来源: https://www.cnblogs.com/show58/p/13896351.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有