石灰石与浓盐酸:liferay 配置文件说明

portlet.xmlportlet定义描述文件，它描述portlet的类型，支持Mode, preferenes和role等，遵循JSR168标准实现，以便于移植（需要针对性的做一些小改过）。下面是一个简单的定义: 2 My Account com.liferay.portlet.StrutsPortlet view-action /my_account/view 0 text/html com.liferay.portlet.StrutsResourceBundle 在JSR168标准中，定义了view/edit/help三种模式，liferay对其进行了扩展，增加了config/about/preview/print等模式。liferay-portlet.xmlliferay的portlet定义描述文件，是liferay对portlet.xml的扩展描述，允许我们对portlet的呈现、功能和行为进行更深入的定制。它与com.liferay.portal.model.Portlet类对应，下面是一个较为详细的liferay-portlet定义： 19 message_boards /message_boards/edit_configuration com.liferay.portlet.messageboards.util.Indexer com.liferay.portlet.messageboards.MBFriendlyPortletURL com.liferay.portlet.messageboards.MBFriendlyURLPortletPlugin false false false false portlet类中常用的属性:// strtus 路径，对portlet的请求应该限制在这个路径下 private String _strutsPath; // 配置路径，即action定义private String _configurationPath;// portlet实现类private String _portletClass;// lucene索引类private String _indexerClass;// scheduler类private String _schedulerClass;// portletURL处理类private String _portletURLClass;// friendURL插件private String _friendlyURLPluginClass;// 默认的preferencesprivate String _defaultPreferences;// preferences的验证类private String _prefsValidator;// 是否实例化，为true时可添加多个portlet到layout上private boolean _instanceable;// 是否为系统portlet，private boolean _system;// 初始化参数private Map _initParams;// portlet支持的模式private Map _portletModes;// portlet支持的语言private Set _supportedLocales;// PortletInfoprivate PortletInfo _portletInfo;// 是否静态portlet, 静态portlet不能移动.private boolean _staticPortlet;// 是否为开始的静态portlet.private boolean _staticPortletStart;portlet解析 com.liferay.portal.service.impl.PortletLocalServiceImpl public void initEAR(String[] xmls) { String scpId = PortletServiceImpl.class.getName() + "." + _SHARED_KEY; Map portletsPool = (Map)SimpleCachePool.get(scpId); if (portletsPool == null) { portletsPool = CollectionFactory.getSyncHashMap(); SimpleCachePool.put(scpId, portletsPool); } try { List servletURLPatterns = _readWebXML(xmls[4]); Set portletIds = _readPortletXML(xmls[0], portletsPool, servletURLPatterns); portletIds.addAll( _readPortletXML(xmls[1], portletsPool, servletURLPatterns)); Set liferayPortletIds = _readLiferayPortletXML(xmls[2], portletsPool); liferayPortletIds.addAll( _readLiferayPortletXML(xmls[3], portletsPool)); // Check for missing entries in liferay-portlet.xml // 检查在liferay-portlet中丢失的portlet实体... // Remove portlets that should not be included // 移去不应该包括的portlet实体... } catch (Exception e) { _log.error(StackTraceUtil.getStackTrace(e)); } } // 解析portlet.xml private Set _readPortletXML( String servletContextName, String xml, Map portletsPool, List servletURLPatterns) throws DocumentException, IOException { Set portletIds = new HashSet(); if (xml == null) { return portletIds; } SAXReader reader = SAXReaderFactory.getInstance(); Document doc = reader.read(new StringReader(xml)); Element root = doc.getRootElement(); Set userAttributes = new HashSet(); Iterator itr1 = root.elements("user-attribute").iterator(); // 用户属性处理... itr1 = root.elements("portlet").iterator(); while (itr1.hasNext()) { Element portlet = (Element)itr1.next(); String portletId = portlet.elementText("portlet-name"); if (servletContextName != null) { portletId = portletId + Portlet.WAR_SEPARATOR + servletContextName; } portletId = PortalUtil.getJsSafePortletName(portletId); if (_log.isDebugEnabled()) { _log.debug("Reading portlet " + portletId); } portletIds.add(portletId); Portlet portletModel = (Portlet)portletsPool.get(portletId); if (portletModel == null) { portletModel = new Portlet( new PortletPK(portletId, _SHARED_KEY)); portletsPool.put(portletId, portletModel); } if (servletContextName != null) { portletModel.setWARFile(true); } if (servletURLPatterns != null) { portletModel.setServletURLPatterns(servletURLPatterns); } portletModel.setPortletClass(portlet.elementText("portlet-class")); Iterator itr2 = portlet.elements("init-param").iterator(); // 初始化参数处理... Element expirationCache = portlet.element("expiration-cache"); // cache过期处理... itr2 = portlet.elements("supports").iterator(); // 支持模式处理... Set supportedLocales = portletModel.getSupportedLocales(); // 支持语言处理... // 资源 portletModel.setResourceBundle( portlet.elementText("resource-bundle")); Element portletInfo = portlet.element("portlet-info"); // portlet-info处理... Element portletPreferences = portlet.element("portlet-preferences"); // preferences处理... Set unlikedRoles = portletModel.getUnlinkedRoles(); itr2 = portlet.elements("security-role-ref").iterator(); // role处理... portletModel.getUserAttributes().addAll(userAttributes); } return portletIds; } // 解析liferay-portlet.xml private Set _readLiferayPortletXML( String servletContextName, String xml, Map portletsPool) throws DocumentException, IOException { Set liferayPortletIds = new HashSet(); if (xml == null) { return liferayPortletIds; } SAXReader reader = SAXReaderFactory.getInstance(); Document doc = reader.read(new StringReader(xml)); Element root = doc.getRootElement(); Map roleMappers = new HashMap(); Iterator itr1 = root.elements("role-mapper").iterator(); // role-mapper处理... Map customUserAttributes = new HashMap(); itr1 = root.elements("custom-user-attribute").iterator(); // 定制用户属性处理... Map friendlyURLPlugins = _getFriendlyURLPlugins(); itr1 = root.elements("portlet").iterator(); while (itr1.hasNext()) { Element portlet = (Element)itr1.next(); String portletId = portlet.elementText("portlet-name"); if (servletContextName != null) { portletId = portletId + Portlet.WAR_SEPARATOR + servletContextName; } portletId = PortalUtil.getJsSafePortletName(portletId); if (_log.isDebugEnabled()) { _log.debug("Reading portlet extension " + portletId); } liferayPortletIds.add(portletId); Portlet portletModel = (Portlet)portletsPool.get(portletId); if (portletModel != null) { // 设置portlet属性... // 处理FriendURL插件 portletModel.setFriendlyURLPluginClass(GetterUtil.getString( portlet.elementText("friendly-url-plugin-class"), portletModel.getFriendlyURLPluginClass())); if (Validator.isNull( portletModel.getFriendlyURLPluginClass())) { friendlyURLPlugins.remove(portletId); } else { friendlyURLPlugins.put( portletId, portletModel.getFriendlyURLPluginClass()); } // 绑定role. portletModel.getRoleMappers().putAll(roleMappers); portletModel.linkRoles(); portletModel.getCustomUserAttributes().putAll( customUserAttributes); } } return liferayPortletIds; }从上面的代码可看出，liferay将portlet的描述定义存储在一个Map中.liferay-display.xmlportlet的类别定义文件，下面是一个简单的例子: 要注意的是，在portlet.xml/liferay-portlet.xml/liferay-display.xml三个文件中的portlet-name, portlet-id必须是一致的。liferay-layout-templates.xmllayout模板定义文件.liferay-look-and-feel.xml主题定义文件.portlet的web.xml如果以war的方式发布portlet，那么它的web.xml也要进行一些特定的说明,下面是liferay中sample-jsp-portlet示例的web.xml: sample-jsp-portlet company_id liferay.com com.liferay.portal.kernel.servlet.PortletContextListener sample_jsp_portlet com.liferay.portal.kernel.servlet.PortletServlet portlet-class com.sample.jsp.portlet.JSPPortlet 0 sample_jsp_portlet /sample_jsp_portlet/* http://java.sun.com/portlet /WEB-INF/tld/liferay-portlet.tld 上面的listener是必须的，它用于通知liferay进行热部署,portlet-class指定Portlet的实现类，它必须遵循JSR168标准，直接或间接的从javax.portlet.GenericPortlet继承。