Class VirtualHostLocalServiceUtil

Object
com.liferay.portal.kernel.service.VirtualHostLocalServiceUtil

public class VirtualHostLocalServiceUtil extends Object
Provides the local service utility for VirtualHost. This utility wraps com.liferay.portal.service.impl.VirtualHostLocalServiceImpl 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:
{$generated.description}
  • Constructor Details

    • VirtualHostLocalServiceUtil

      public VirtualHostLocalServiceUtil()
  • Method Details

    • addVirtualHost

      public static VirtualHost addVirtualHost(VirtualHost virtualHost)
      Adds the virtual host to the database. Also notifies the appropriate model listeners.

      Important: Inspect VirtualHostLocalServiceImpl 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:
      virtualHost - the virtual host
      Returns:
      the virtual host that was added
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • createVirtualHost

      public static VirtualHost createVirtualHost(long virtualHostId)
      Creates a new virtual host with the primary key. Does not add the virtual host to the database.
      Parameters:
      virtualHostId - the primary key for the new virtual host
      Returns:
      the new virtual host
    • deletePersistedModel

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deleteVirtualHost

      public static VirtualHost deleteVirtualHost(long virtualHostId) throws PortalException
      Deletes the virtual host with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect VirtualHostLocalServiceImpl 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:
      virtualHostId - the primary key of the virtual host
      Returns:
      the virtual host that was removed
      Throws:
      PortalException - if a virtual host with the primary key could not be found
    • deleteVirtualHost

      public static VirtualHost deleteVirtualHost(VirtualHost virtualHost)
      Deletes the virtual host from the database. Also notifies the appropriate model listeners.

      Important: Inspect VirtualHostLocalServiceImpl 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:
      virtualHost - the virtual host
      Returns:
      the virtual host that was removed
    • 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> 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> 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.VirtualHostModelImpl.

      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> 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.VirtualHostModelImpl.

      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
    • fetchVirtualHost

      public static VirtualHost fetchVirtualHost(long virtualHostId)
    • fetchVirtualHost

      @Deprecated public static VirtualHost fetchVirtualHost(long companyId, long layoutSetId)
      Deprecated.
      As of Mueller (7.2.x), replaced by getVirtualHosts(long, long)
    • fetchVirtualHost

      public static VirtualHost fetchVirtualHost(String hostname)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getVirtualHost

      public static VirtualHost getVirtualHost(long virtualHostId) throws PortalException
      Returns the virtual host with the primary key.
      Parameters:
      virtualHostId - the primary key of the virtual host
      Returns:
      the virtual host
      Throws:
      PortalException - if a virtual host with the primary key could not be found
    • getVirtualHost

      @Deprecated public static VirtualHost getVirtualHost(long companyId, long layoutSetId) throws PortalException
      Deprecated.
      As of Mueller (7.2.x), replaced by getVirtualHosts(long, long)
      Throws:
      PortalException
    • getVirtualHost

      public static VirtualHost getVirtualHost(String hostname) throws PortalException
      Throws:
      PortalException
    • getVirtualHosts

      public static List<VirtualHost> getVirtualHosts(int start, int end)
      Returns a range of all the virtual hosts.

      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.VirtualHostModelImpl.

      Parameters:
      start - the lower bound of the range of virtual hosts
      end - the upper bound of the range of virtual hosts (not inclusive)
      Returns:
      the range of virtual hosts
    • getVirtualHosts

      public static List<VirtualHost> getVirtualHosts(long companyId)
    • getVirtualHosts

      public static List<VirtualHost> getVirtualHosts(long companyId, long layoutSetId)
    • getVirtualHostsCount

      public static int getVirtualHostsCount()
      Returns the number of virtual hosts.
      Returns:
      the number of virtual hosts
    • getVirtualHostsCount

      public static long getVirtualHostsCount(long excludedLayoutSetId, String[] virtualHostNames)
    • updateVirtualHost

      @Deprecated public static VirtualHost updateVirtualHost(long companyId, long layoutSetId, String hostname)
      Deprecated.
      As of Mueller (7.2.x), replaced by updateVirtualHosts(long, long, TreeMap)
    • updateVirtualHost

      public static VirtualHost updateVirtualHost(VirtualHost virtualHost)
      Updates the virtual host in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect VirtualHostLocalServiceImpl 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:
      virtualHost - the virtual host
      Returns:
      the virtual host that was updated
    • updateVirtualHosts

      public static List<VirtualHost> updateVirtualHosts(long companyId, long layoutSetId, TreeMap<String,String> hostnames)
    • getService

      public static VirtualHostLocalService getService()
    • setService

      public static void setService(VirtualHostLocalService service)