com.liferay.portal.kernel.service

Class PortletLocalServiceUtil

java.lang.Object

com.liferay.portal.kernel.service.PortletLocalServiceUtil

public class PortletLocalServiceUtil
extends java.lang.Object

Provides the local service utility for Portlet. This utility wraps com.liferay.portal.service.impl.PortletLocalServiceImpl and is an access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

PortletLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
PortletLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static Portlet	addPortlet(Portlet portlet) Adds the portlet to the database.
static void	addPortletCategory(long companyId, java.lang.String categoryName)
static void	checkPortlet(Portlet portlet)
static void	checkPortlets(long companyId)
static void	clearCache()
static void	clearPortletsMap()
static Portlet	clonePortlet(java.lang.String portletId)
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static Portlet	createPortlet(long id) Creates a new portlet with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static Portlet	deletePortlet(long id) Deletes the portlet with the primary key from the database.
static void	deletePortlet(long companyId, java.lang.String portletId, long plid)
static Portlet	deletePortlet(Portlet portlet) Deletes the portlet from the database.
static void	deletePortlets(long companyId, java.lang.String[] portletIds, long plid)
static void	deployPortlet(Portlet portlet)
static Portlet	deployRemotePortlet(long[] companyIds, Portlet portlet, java.lang.String[] categoryNames, boolean eagerDestroy, boolean clearCache)
static Portlet	deployRemotePortlet(Portlet portlet, java.lang.String categoryName)
static Portlet	deployRemotePortlet(Portlet portlet, java.lang.String[] categoryNames)
static Portlet	deployRemotePortlet(Portlet portlet, java.lang.String[] categoryNames, boolean eagerDestroy)
static void	destroyPortlet(Portlet portlet)
static void	destroyRemotePortlet(Portlet portlet)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static Portlet	fetchPortlet(long id)
static Portlet	fetchPortletById(long companyId, java.lang.String portletId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static java.util.List<CustomAttributesDisplay>	getCustomAttributesDisplays()
static PortletCategory	getEARDisplay(java.lang.String xml)
static java.util.List<Portlet>	getFriendlyURLMapperPortlets()
static java.util.List<FriendlyURLMapper>	getFriendlyURLMappers()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static Portlet	getPortlet(long id) Returns the portlet with the primary key.
static PortletApp	getPortletApp(java.lang.String servletContextName)
static Portlet	getPortletById(long companyId, java.lang.String portletId)
static Portlet	getPortletById(java.lang.String portletId)
static Portlet	getPortletByStrutsPath(long companyId, java.lang.String strutsPath)
static java.util.List<Portlet>	getPortlets()
static java.util.List<Portlet>	getPortlets(int start, int end) Returns a range of all the portlets.
static java.util.List<Portlet>	getPortlets(long companyId)
static java.util.List<Portlet>	getPortlets(long companyId, boolean showSystem, boolean showPortal)
static int	getPortletsCount() Returns the number of portlets.
static int	getPortletsCount(long companyId)
static java.util.List<Portlet>	getScopablePortlets()
static PortletLocalService	getService()
static PortletCategory	getWARDisplay(java.lang.String servletContextName, java.lang.String xml)
static boolean	hasPortlet(long companyId, java.lang.String portletId)
static void	initEAR(javax.servlet.ServletContext servletContext, java.lang.String[] xmls, PluginPackage pluginPackage)
static java.util.List<Portlet>	initWAR(java.lang.String servletContextName, javax.servlet.ServletContext servletContext, java.lang.String[] xmls, PluginPackage pluginPackage)
static java.util.Map<java.lang.String,Portlet>	loadGetPortletsMap(long companyId)
static void	removeCompanyPortletsPool(long companyId)
static Portlet	updatePortlet(long companyId, java.lang.String portletId, java.lang.String roles, boolean active)
static Portlet	updatePortlet(Portlet portlet) Updates the portlet in the database or adds it if it does not yet exist.
static void	visitPortlets(long companyId, java.util.function.Consumer<Portlet> consumer)

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletLocalServiceUtil

public PortletLocalServiceUtil()

Method Detail

addPortlet

public static Portlet addPortlet(Portlet portlet)

Adds the portlet to the database. Also notifies the appropriate model listeners.

Important: Inspect PortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

portlet - the portlet

Returns:

the portlet that was added

addPortletCategory

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

checkPortlet

public static void checkPortlet(Portlet portlet)
                         throws PortalException

Throws:

PortalException

checkPortlets

public static void checkPortlets(long companyId)
                          throws PortalException

Throws:

PortalException

clearCache

public static void clearCache()

clearPortletsMap

public static void clearPortletsMap()

clonePortlet

public static Portlet clonePortlet(java.lang.String portletId)

createPersistedModel

public static PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

createPortlet

public static Portlet createPortlet(long id)

Creates a new portlet with the primary key. Does not add the portlet to the database.

Parameters:

id - the primary key for the new portlet

Returns:

the new portlet

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deletePortlet

public static Portlet deletePortlet(long id)
                             throws PortalException

Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect PortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

id - the primary key of the portlet

Returns:

the portlet that was removed

Throws:

PortalException - if a portlet with the primary key could not be found

deletePortlet

public static void deletePortlet(long companyId,
                                 java.lang.String portletId,
                                 long plid)
                          throws PortalException

Throws:

PortalException

deletePortlet

public static Portlet deletePortlet(Portlet portlet)

Deletes the portlet from the database. Also notifies the appropriate model listeners.

Important: Inspect PortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

portlet - the portlet

Returns:

the portlet that was removed

deletePortlets

public static void deletePortlets(long companyId,
                                  java.lang.String[] portletIds,
                                  long plid)
                           throws PortalException

Throws:

PortalException

deployPortlet

public static void deployPortlet(Portlet portlet)
                          throws java.lang.Exception

Throws:

java.lang.Exception

deployRemotePortlet

public static Portlet deployRemotePortlet(long[] companyIds,
                                          Portlet portlet,
                                          java.lang.String[] categoryNames,
                                          boolean eagerDestroy,
                                          boolean clearCache)
                                   throws PortalException

Throws:

PortalException

deployRemotePortlet

public static Portlet deployRemotePortlet(Portlet portlet,
                                          java.lang.String categoryName)
                                   throws PortalException

Throws:

PortalException

deployRemotePortlet

public static Portlet deployRemotePortlet(Portlet portlet,
                                          java.lang.String[] categoryNames)
                                   throws PortalException

Throws:

PortalException

deployRemotePortlet

public static Portlet deployRemotePortlet(Portlet portlet,
                                          java.lang.String[] categoryNames,
                                          boolean eagerDestroy)
                                   throws PortalException

Throws:

PortalException

destroyPortlet

public static void destroyPortlet(Portlet portlet)

destroyRemotePortlet

public static void destroyRemotePortlet(Portlet portlet)

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PortletModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PortletModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchPortlet

public static Portlet fetchPortlet(long id)

fetchPortletById

public static Portlet fetchPortletById(long companyId,
                                       java.lang.String portletId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getCustomAttributesDisplays

public static java.util.List<CustomAttributesDisplay> getCustomAttributesDisplays()

getEARDisplay

public static PortletCategory getEARDisplay(java.lang.String xml)

getFriendlyURLMapperPortlets

public static java.util.List<Portlet> getFriendlyURLMapperPortlets()

getFriendlyURLMappers

public static java.util.List<FriendlyURLMapper> getFriendlyURLMappers()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getPortlet

public static Portlet getPortlet(long id)
                          throws PortalException

Returns the portlet with the primary key.

Parameters:

id - the primary key of the portlet

Returns:

the portlet

Throws:

PortalException - if a portlet with the primary key could not be found

getPortletApp

public static PortletApp getPortletApp(java.lang.String servletContextName)

getPortletById

public static Portlet getPortletById(long companyId,
                                     java.lang.String portletId)

getPortletById

public static Portlet getPortletById(java.lang.String portletId)

getPortletByStrutsPath

public static Portlet getPortletByStrutsPath(long companyId,
                                             java.lang.String strutsPath)

getPortlets

public static java.util.List<Portlet> getPortlets()

getPortlets

public static java.util.List<Portlet> getPortlets(int start,
                                                  int end)

Returns a range of all the portlets.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PortletModelImpl.

Parameters:

start - the lower bound of the range of portlets

end - the upper bound of the range of portlets (not inclusive)

Returns:

the range of portlets

getPortlets

public static java.util.List<Portlet> getPortlets(long companyId)

getPortlets

public static java.util.List<Portlet> getPortlets(long companyId,
                                                  boolean showSystem,
                                                  boolean showPortal)

getPortletsCount

public static int getPortletsCount()

Returns the number of portlets.

Returns:

the number of portlets

getPortletsCount

public static int getPortletsCount(long companyId)

getScopablePortlets

public static java.util.List<Portlet> getScopablePortlets()

getWARDisplay

public static PortletCategory getWARDisplay(java.lang.String servletContextName,
                                            java.lang.String xml)

hasPortlet

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

initEAR

public static void initEAR(javax.servlet.ServletContext servletContext,
                           java.lang.String[] xmls,
                           PluginPackage pluginPackage)

initWAR

public static java.util.List<Portlet> initWAR(java.lang.String servletContextName,
                                              javax.servlet.ServletContext servletContext,
                                              java.lang.String[] xmls,
                                              PluginPackage pluginPackage)

loadGetPortletsMap

public static java.util.Map<java.lang.String,Portlet> loadGetPortletsMap(long companyId)

removeCompanyPortletsPool

public static void removeCompanyPortletsPool(long companyId)

updatePortlet

public static Portlet updatePortlet(long companyId,
                                    java.lang.String portletId,
                                    java.lang.String roles,
                                    boolean active)

updatePortlet

public static Portlet updatePortlet(Portlet portlet)

Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect PortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

portlet - the portlet

Returns:

the portlet that was updated

visitPortlets

public static void visitPortlets(long companyId,
                                 java.util.function.Consumer<Portlet> consumer)

getService

public static PortletLocalService getService()