Class SamlSpMessageLocalServiceUtil

java.lang.Object
com.liferay.saml.persistence.service.SamlSpMessageLocalServiceUtil

public class SamlSpMessageLocalServiceUtil extends Object
Provides the local service utility for SamlSpMessage. This utility wraps com.liferay.saml.persistence.service.impl.SamlSpMessageLocalServiceImpl 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.
See Also:
Generated:
  • Constructor Details

    • SamlSpMessageLocalServiceUtil

      public SamlSpMessageLocalServiceUtil()
  • Method Details

    • addSamlSpMessage

      public static SamlSpMessage addSamlSpMessage(SamlSpMessage samlSpMessage)
      Adds the saml sp message to the database. Also notifies the appropriate model listeners.

      Important: Inspect SamlSpMessageLocalServiceImpl 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:
      samlSpMessage - the saml sp message
      Returns:
      the saml sp message that was added
    • addSamlSpMessage

      public static SamlSpMessage addSamlSpMessage(String samlIdpEntityId, String samlIdpResponseKey, Date expirationDate, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    • createPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createSamlSpMessage

      public static SamlSpMessage createSamlSpMessage(long samlSpMessageId)
      Creates a new saml sp message with the primary key. Does not add the saml sp message to the database.
      Parameters:
      samlSpMessageId - the primary key for the new saml sp message
      Returns:
      the new saml sp message
    • deleteExpiredSamlSpMessages

      public static void deleteExpiredSamlSpMessages()
    • deletePersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSamlSpMessage

      public static SamlSpMessage deleteSamlSpMessage(long samlSpMessageId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the saml sp message with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect SamlSpMessageLocalServiceImpl 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:
      samlSpMessageId - the primary key of the saml sp message
      Returns:
      the saml sp message that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a saml sp message with the primary key could not be found
    • deleteSamlSpMessage

      public static SamlSpMessage deleteSamlSpMessage(SamlSpMessage samlSpMessage)
      Deletes the saml sp message from the database. Also notifies the appropriate model listeners.

      Important: Inspect SamlSpMessageLocalServiceImpl 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:
      samlSpMessage - the saml sp message
      Returns:
      the saml sp message 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 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.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.saml.persistence.model.impl.SamlSpMessageModelImpl.

      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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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.saml.persistence.model.impl.SamlSpMessageModelImpl.

      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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.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
    • fetchSamlSpMessage

      public static SamlSpMessage fetchSamlSpMessage(long samlSpMessageId)
    • fetchSamlSpMessage

      public static SamlSpMessage fetchSamlSpMessage(String samlIdpEntityId, String samlIdpResponseKey)
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSamlSpMessage

      public static SamlSpMessage getSamlSpMessage(long samlSpMessageId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the saml sp message with the primary key.
      Parameters:
      samlSpMessageId - the primary key of the saml sp message
      Returns:
      the saml sp message
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a saml sp message with the primary key could not be found
    • getSamlSpMessage

      public static SamlSpMessage getSamlSpMessage(String samlIdpEntityId, String samlIdpResponseKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSamlSpMessages

      public static List<SamlSpMessage> getSamlSpMessages(int start, int end)
      Returns a range of all the saml sp messages.

      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.saml.persistence.model.impl.SamlSpMessageModelImpl.

      Parameters:
      start - the lower bound of the range of saml sp messages
      end - the upper bound of the range of saml sp messages (not inclusive)
      Returns:
      the range of saml sp messages
    • getSamlSpMessagesCount

      public static int getSamlSpMessagesCount()
      Returns the number of saml sp messages.
      Returns:
      the number of saml sp messages
    • updateSamlSpMessage

      public static SamlSpMessage updateSamlSpMessage(SamlSpMessage samlSpMessage)
      Updates the saml sp message in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect SamlSpMessageLocalServiceImpl 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:
      samlSpMessage - the saml sp message
      Returns:
      the saml sp message that was updated
    • getService

      public static SamlSpMessageLocalService getService()