com.liferay.portal.service.impl

Class PortletLocalServiceImpl

java.lang.Object

com.liferay.portal.kernel.service.BaseLocalServiceImpl

com.liferay.portal.service.base.PortletLocalServiceBaseImpl

com.liferay.portal.service.impl.PortletLocalServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService, com.liferay.portal.kernel.service.PortletLocalService

public class PortletLocalServiceImpl
extends PortletLocalServiceBaseImpl

Author:

Brian Wing Shun Chan, Raymond Augé, Eduardo Lundgren, Wesley Gong, Shuyang Zhou, Neil Griffin

Field Summary

Fields inherited from class com.liferay.portal.service.base.PortletLocalServiceBaseImpl

counterLocalService, counterPersistence, persistedModelLocalServiceRegistry, portletLocalService, portletPersistence, portletPreferencesFinder, portletPreferencesLocalService, portletPreferencesPersistence, resourceLocalService, resourcePermissionFinder, resourcePermissionLocalService, resourcePermissionPersistence, roleFinder, roleLocalService, rolePersistence

Constructor Summary

Constructors

Constructor and Description
PortletLocalServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addPortletCategory(long companyId, java.lang.String categoryName)
void	afterPropertiesSet()
void	checkPortlet(com.liferay.portal.kernel.model.Portlet portlet)
void	checkPortlets(long companyId)
void	clearCache()
void	clearCompanyPortletsPool() Deprecated. As of Wilberforce (7.0.x), replaced by clearPortletsMap()
void	clearPortletsMap()
com.liferay.portal.kernel.model.Portlet	clonePortlet(java.lang.String portletId)
void	deletePortlet(long companyId, java.lang.String portletId, long plid)
void	deletePortlets(long companyId, java.lang.String[] portletIds, long plid)
void	deployPortlet(com.liferay.portal.kernel.model.Portlet portlet)
com.liferay.portal.kernel.model.Portlet	deployRemotePortlet(com.liferay.portal.kernel.model.Portlet portlet, java.lang.String categoryName)
com.liferay.portal.kernel.model.Portlet	deployRemotePortlet(com.liferay.portal.kernel.model.Portlet portlet, java.lang.String[] categoryNames)
com.liferay.portal.kernel.model.Portlet	deployRemotePortlet(com.liferay.portal.kernel.model.Portlet portlet, java.lang.String[] categoryNames, boolean eagerDestroy)
void	destroy()
void	destroyPortlet(com.liferay.portal.kernel.model.Portlet portlet)
void	destroyRemotePortlet(com.liferay.portal.kernel.model.Portlet portlet)
com.liferay.portal.kernel.model.Portlet	fetchPortletById(long companyId, java.lang.String portletId)
java.util.List<com.liferay.expando.kernel.model.CustomAttributesDisplay>	getCustomAttributesDisplays()
com.liferay.portal.kernel.model.PortletCategory	getEARDisplay(java.lang.String xml)
java.util.List<com.liferay.portal.kernel.model.Portlet>	getFriendlyURLMapperPortlets()
java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper>	getFriendlyURLMappers()
com.liferay.portal.kernel.model.PortletApp	getPortletApp(java.lang.String servletContextName)
com.liferay.portal.kernel.model.Portlet	getPortletById(long companyId, java.lang.String portletId)
com.liferay.portal.kernel.model.Portlet	getPortletById(java.lang.String portletId)
com.liferay.portal.kernel.model.Portlet	getPortletByStrutsPath(long companyId, java.lang.String strutsPath)
protected java.lang.String	getPortletId(java.lang.String securityPath)
java.util.List<com.liferay.portal.kernel.model.Portlet>	getPortlets()
java.util.List<com.liferay.portal.kernel.model.Portlet>	getPortlets(long companyId)
java.util.List<com.liferay.portal.kernel.model.Portlet>	getPortlets(long companyId, boolean showSystem, boolean showPortal)
protected java.util.List<com.liferay.portal.kernel.model.Portlet>	getPortletsByPortletName(java.lang.String portletName, java.lang.String servletContextName, java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> portletsMap)
protected java.util.List<com.liferay.portal.kernel.model.Portlet>	getPortletsByServletContextName(java.lang.String servletContextName, java.lang.String portletNamePrefix, java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> portletsMap)
int	getPortletsCount(long companyId)
protected java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet>	getPortletsMap(long companyId)
java.util.List<com.liferay.portal.kernel.model.Portlet>	getScopablePortlets()
com.liferay.portal.kernel.model.PortletCategory	getWARDisplay(java.lang.String servletContextName, java.lang.String xml)
boolean	hasPortlet(long companyId, java.lang.String portletId)
void	initEAR(javax.servlet.ServletContext servletContext, java.lang.String[] xmls, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
protected void	initPortletAddToPagePermissions(com.liferay.portal.kernel.model.Portlet portlet)
java.util.List<com.liferay.portal.kernel.model.Portlet>	initWAR(java.lang.String servletContextName, javax.servlet.ServletContext servletContext, java.lang.String[] xmls, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet>	loadGetPortletsMap(long companyId)
java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet>	loadGetPortletsPool(long companyId) Deprecated. As of Wilberforce (7.0.x), replaced by loadGetPortletsMap(long)
protected void	readLiferayDisplay(java.lang.String servletContextName, com.liferay.portal.kernel.xml.Element element, com.liferay.portal.kernel.model.PortletCategory portletCategory, java.util.Set<java.lang.String> portletIds)
protected com.liferay.portal.kernel.model.PortletCategory	readLiferayDisplayXML(java.lang.String xml)
protected com.liferay.portal.kernel.model.PortletCategory	readLiferayDisplayXML(java.lang.String servletContextName, java.lang.String xml)
protected void	readLiferayPortletXML(java.lang.String servletContextName, javax.servlet.ServletContext servletContext, java.util.Set<java.lang.String> liferayPortletIds, java.util.Map<java.lang.String,java.lang.String> roleMappers, com.liferay.portal.kernel.xml.Element portletElement, java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> portletsMap, java.util.Map<java.lang.String,java.lang.String> portletIdsByStrutsPath, com.liferay.portal.kernel.configuration.Configuration configuration)
protected java.util.Set<java.lang.String>	readLiferayPortletXML(java.lang.String servletContextName, javax.servlet.ServletContext servletContext, java.lang.String xml, java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> portletsMap, java.util.Map<java.lang.String,java.lang.String> portletIdsByStrutsPath, com.liferay.portal.kernel.configuration.Configuration configuration)
protected void	readPortletXML(java.lang.String servletContextName, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage, com.liferay.portal.kernel.model.PortletApp portletApp, com.liferay.portal.kernel.xml.Element portletElement, java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> portletsMap, java.util.Set<java.lang.String> validCustomPortletModes)
protected java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet>	readPortletXML(java.lang.String servletContextName, javax.servlet.ServletContext servletContext, java.lang.String xml, java.util.Set<java.lang.String> servletURLPatterns, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
protected java.util.Set<java.lang.String>	readWebXML(java.lang.String xml)
void	removeCompanyPortletsPool(long companyId)
protected void	setSpriteImages(javax.servlet.ServletContext servletContext, com.liferay.portal.kernel.model.PortletApp portletApp, java.lang.String resourcePath)
protected com.liferay.portal.kernel.model.Portlet	updatePortlet(long companyId, java.lang.String portletId, java.lang.String roles)
com.liferay.portal.kernel.model.Portlet	updatePortlet(long companyId, java.lang.String portletId, java.lang.String roles, boolean active)
void	visitPortlets(long companyId, java.util.function.Consumer<com.liferay.portal.kernel.model.Portlet> consumer)

Methods inherited from class com.liferay.portal.service.base.PortletLocalServiceBaseImpl

addPortlet, createPortlet, deletePersistedModel, deletePortlet, deletePortlet, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQueryCount, dynamicQueryCount, fetchPortlet, getActionableDynamicQuery, getBasePersistence, getCounterLocalService, getCounterPersistence, getIndexableActionableDynamicQuery, getModelClass, getModelClassName, getOSGiServiceIdentifier, getPersistedModel, getPortlet, getPortletLocalService, getPortletPersistence, getPortletPreferencesFinder, getPortletPreferencesLocalService, getPortletPreferencesPersistence, getPortlets, getPortletsCount, getResourceLocalService, getResourcePermissionFinder, getResourcePermissionLocalService, getResourcePermissionPersistence, getRoleFinder, getRoleLocalService, getRolePersistence, initActionableDynamicQuery, runSQL, setCounterLocalService, setCounterPersistence, setPortletLocalService, setPortletPersistence, setPortletPreferencesFinder, setPortletPreferencesLocalService, setPortletPreferencesPersistence, setResourceLocalService, setResourcePermissionFinder, setResourcePermissionLocalService, setResourcePermissionPersistence, setRoleFinder, setRoleLocalService, setRolePersistence, updatePortlet

Methods inherited from class com.liferay.portal.kernel.service.BaseLocalServiceImpl

getClassLoader, getLocalizationMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletLocalServiceImpl

public PortletLocalServiceImpl()

Method Detail

addPortletCategory

@Skip
public void addPortletCategory(long companyId,
                                     java.lang.String categoryName)

afterPropertiesSet

public void afterPropertiesSet()

Overrides:

afterPropertiesSet in class PortletLocalServiceBaseImpl

checkPortlet

public void checkPortlet(com.liferay.portal.kernel.model.Portlet portlet)
                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

checkPortlets

public void checkPortlets(long companyId)
                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

clearCache

@Skip
public void clearCache()

clearCompanyPortletsPool

@Clusterable
 @Deprecated
 @Transactional(enabled=false)
public void clearCompanyPortletsPool()

Deprecated. As of Wilberforce (7.0.x), replaced by clearPortletsMap()

clearPortletsMap

@Clusterable
 @Transactional(enabled=false)
public void clearPortletsMap()

clonePortlet

@Skip
public com.liferay.portal.kernel.model.Portlet clonePortlet(java.lang.String portletId)

deletePortlet

public void deletePortlet(long companyId,
                          java.lang.String portletId,
                          long plid)
                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deletePortlets

public void deletePortlets(long companyId,
                           java.lang.String[] portletIds,
                           long plid)
                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deployPortlet

@Skip
public void deployPortlet(com.liferay.portal.kernel.model.Portlet portlet)
                         throws java.lang.Exception

Throws:

java.lang.Exception

deployRemotePortlet

public com.liferay.portal.kernel.model.Portlet deployRemotePortlet(com.liferay.portal.kernel.model.Portlet portlet,
                                                                   java.lang.String categoryName)
                                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deployRemotePortlet

public com.liferay.portal.kernel.model.Portlet deployRemotePortlet(com.liferay.portal.kernel.model.Portlet portlet,
                                                                   java.lang.String[] categoryNames)
                                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deployRemotePortlet

public com.liferay.portal.kernel.model.Portlet deployRemotePortlet(com.liferay.portal.kernel.model.Portlet portlet,
                                                                   java.lang.String[] categoryNames,
                                                                   boolean eagerDestroy)
                                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

destroy

public void destroy()

Overrides:

destroy in class PortletLocalServiceBaseImpl

destroyPortlet

@Skip
public void destroyPortlet(com.liferay.portal.kernel.model.Portlet portlet)

destroyRemotePortlet

@Skip
public void destroyRemotePortlet(com.liferay.portal.kernel.model.Portlet portlet)

fetchPortletById

@Skip
public com.liferay.portal.kernel.model.Portlet fetchPortletById(long companyId,
                                                                      java.lang.String portletId)

getCustomAttributesDisplays

@Skip
public java.util.List<com.liferay.expando.kernel.model.CustomAttributesDisplay> getCustomAttributesDisplays()

getEARDisplay

@Skip
public com.liferay.portal.kernel.model.PortletCategory getEARDisplay(java.lang.String xml)

getFriendlyURLMapperPortlets

@Skip
public java.util.List<com.liferay.portal.kernel.model.Portlet> getFriendlyURLMapperPortlets()

getFriendlyURLMappers

@Skip
public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers()

getPortletApp

@Skip
public com.liferay.portal.kernel.model.PortletApp getPortletApp(java.lang.String servletContextName)

getPortletById

@Skip
public com.liferay.portal.kernel.model.Portlet getPortletById(long companyId,
                                                                    java.lang.String portletId)

getPortletById

@Skip
public com.liferay.portal.kernel.model.Portlet getPortletById(java.lang.String portletId)

getPortletByStrutsPath

@Skip
public com.liferay.portal.kernel.model.Portlet getPortletByStrutsPath(long companyId,
                                                                            java.lang.String strutsPath)

getPortlets

@Skip
public java.util.List<com.liferay.portal.kernel.model.Portlet> getPortlets()

getPortlets

@Skip
public java.util.List<com.liferay.portal.kernel.model.Portlet> getPortlets(long companyId)

getPortlets

@Skip
public java.util.List<com.liferay.portal.kernel.model.Portlet> getPortlets(long companyId,
                                                                                 boolean showSystem,
                                                                                 boolean showPortal)

getPortletsCount

public int getPortletsCount(long companyId)

getScopablePortlets

@Skip
public java.util.List<com.liferay.portal.kernel.model.Portlet> getScopablePortlets()

getWARDisplay

@Skip
public com.liferay.portal.kernel.model.PortletCategory getWARDisplay(java.lang.String servletContextName,
                                                                           java.lang.String xml)

hasPortlet

@Skip
public boolean hasPortlet(long companyId,
                                java.lang.String portletId)

initEAR

@Skip
public void initEAR(javax.servlet.ServletContext servletContext,
                          java.lang.String[] xmls,
                          com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)

initWAR

@Skip
public java.util.List<com.liferay.portal.kernel.model.Portlet> initWAR(java.lang.String servletContextName,
                                                                             javax.servlet.ServletContext servletContext,
                                                                             java.lang.String[] xmls,
                                                                             com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)

loadGetPortletsMap

public java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> loadGetPortletsMap(long companyId)

loadGetPortletsPool

@Deprecated
public java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> loadGetPortletsPool(long companyId)

Deprecated. As of Wilberforce (7.0.x), replaced by loadGetPortletsMap(long)

removeCompanyPortletsPool

@Clusterable
 @Transactional(enabled=false)
public void removeCompanyPortletsPool(long companyId)

updatePortlet

public com.liferay.portal.kernel.model.Portlet updatePortlet(long companyId,
                                                             java.lang.String portletId,
                                                             java.lang.String roles,
                                                             boolean active)

visitPortlets

@Skip
public void visitPortlets(long companyId,
                                java.util.function.Consumer<com.liferay.portal.kernel.model.Portlet> consumer)

getPortletId

protected java.lang.String getPortletId(java.lang.String securityPath)

getPortletsByPortletName

protected java.util.List<com.liferay.portal.kernel.model.Portlet> getPortletsByPortletName(java.lang.String portletName,
                                                                                           java.lang.String servletContextName,
                                                                                           java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> portletsMap)

getPortletsByServletContextName

protected java.util.List<com.liferay.portal.kernel.model.Portlet> getPortletsByServletContextName(java.lang.String servletContextName,
                                                                                                  java.lang.String portletNamePrefix,
                                                                                                  java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> portletsMap)

getPortletsMap

protected java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> getPortletsMap(long companyId)

initPortletAddToPagePermissions

protected void initPortletAddToPagePermissions(com.liferay.portal.kernel.model.Portlet portlet)
                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

readLiferayDisplay

protected void readLiferayDisplay(java.lang.String servletContextName,
                                  com.liferay.portal.kernel.xml.Element element,
                                  com.liferay.portal.kernel.model.PortletCategory portletCategory,
                                  java.util.Set<java.lang.String> portletIds)

readLiferayDisplayXML

protected com.liferay.portal.kernel.model.PortletCategory readLiferayDisplayXML(java.lang.String xml)
                                                                         throws java.lang.Exception

Throws:

java.lang.Exception

readLiferayDisplayXML

protected com.liferay.portal.kernel.model.PortletCategory readLiferayDisplayXML(java.lang.String servletContextName,
                                                                                java.lang.String xml)
                                                                         throws java.lang.Exception

Throws:

java.lang.Exception

readLiferayPortletXML

protected void readLiferayPortletXML(java.lang.String servletContextName,
                                     javax.servlet.ServletContext servletContext,
                                     java.util.Set<java.lang.String> liferayPortletIds,
                                     java.util.Map<java.lang.String,java.lang.String> roleMappers,
                                     com.liferay.portal.kernel.xml.Element portletElement,
                                     java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> portletsMap,
                                     java.util.Map<java.lang.String,java.lang.String> portletIdsByStrutsPath,
                                     com.liferay.portal.kernel.configuration.Configuration configuration)

readLiferayPortletXML

protected java.util.Set<java.lang.String> readLiferayPortletXML(java.lang.String servletContextName,
                                                                javax.servlet.ServletContext servletContext,
                                                                java.lang.String xml,
                                                                java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> portletsMap,
                                                                java.util.Map<java.lang.String,java.lang.String> portletIdsByStrutsPath,
                                                                com.liferay.portal.kernel.configuration.Configuration configuration)
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

readPortletXML

protected void readPortletXML(java.lang.String servletContextName,
                              com.liferay.portal.kernel.plugin.PluginPackage pluginPackage,
                              com.liferay.portal.kernel.model.PortletApp portletApp,
                              com.liferay.portal.kernel.xml.Element portletElement,
                              java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> portletsMap,
                              java.util.Set<java.lang.String> validCustomPortletModes)
                       throws com.liferay.portal.kernel.exception.PortletIdException

Throws:

com.liferay.portal.kernel.exception.PortletIdException

readPortletXML

protected java.util.Map<java.lang.String,com.liferay.portal.kernel.model.Portlet> readPortletXML(java.lang.String servletContextName,
                                                                                                 javax.servlet.ServletContext servletContext,
                                                                                                 java.lang.String xml,
                                                                                                 java.util.Set<java.lang.String> servletURLPatterns,
                                                                                                 com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
                                                                                          throws java.lang.Exception

Throws:

java.lang.Exception

readWebXML

protected java.util.Set<java.lang.String> readWebXML(java.lang.String xml)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

setSpriteImages

protected void setSpriteImages(javax.servlet.ServletContext servletContext,
                               com.liferay.portal.kernel.model.PortletApp portletApp,
                               java.lang.String resourcePath)
                        throws java.lang.Exception

Throws:

java.lang.Exception

updatePortlet

protected com.liferay.portal.kernel.model.Portlet updatePortlet(long companyId,
                                                                java.lang.String portletId,
                                                                java.lang.String roles)