Class SamlSpSessionLocalServiceUtil

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

public class SamlSpSessionLocalServiceUtil extends Object
Provides the local service utility for SamlSpSession. This utility wraps com.liferay.saml.persistence.service.impl.SamlSpSessionLocalServiceImpl 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

    • SamlSpSessionLocalServiceUtil

      public SamlSpSessionLocalServiceUtil()
  • Method Details

    • addSamlSpSession

      public static SamlSpSession addSamlSpSession(SamlSpSession samlSpSession)
      Adds the saml sp session to the database. Also notifies the appropriate model listeners.

      Important: Inspect SamlSpSessionLocalServiceImpl 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:
      samlSpSession - the saml sp session
      Returns:
      the saml sp session that was added
    • addSamlSpSession

      public static SamlSpSession addSamlSpSession(String assertionXml, String jSessionId, String nameIdFormat, String nameIdNameQualifier, String nameIdSPNameQualifier, String nameIdValue, String samlIdpEntityId, String samlSpSessionKey, String sessionIndex, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • createSamlSpSession

      public static SamlSpSession createSamlSpSession(long samlSpSessionId)
      Creates a new saml sp session with the primary key. Does not add the saml sp session to the database.
      Parameters:
      samlSpSessionId - the primary key for the new saml sp session
      Returns:
      the new saml sp session
    • 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
    • deleteSamlSpSession

      public static SamlSpSession deleteSamlSpSession(long samlSpSessionId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the saml sp session with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static SamlSpSession deleteSamlSpSession(SamlSpSession samlSpSession)
      Deletes the saml sp session from the database. Also notifies the appropriate model listeners.

      Important: Inspect SamlSpSessionLocalServiceImpl 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:
      samlSpSession - the saml sp session
      Returns:
      the saml sp session 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.SamlSpSessionModelImpl.

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

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

      public static SamlSpSession fetchSamlSpSession(long samlSpSessionId)
    • fetchSamlSpSessionByJSessionId

      public static SamlSpSession fetchSamlSpSessionByJSessionId(String jSessionId)
    • fetchSamlSpSessionBySamlSpSessionKey

      public static SamlSpSession fetchSamlSpSessionBySamlSpSessionKey(String samlSpSessionKey)
    • fetchSamlSpSessionBySessionIndex

      public static SamlSpSession fetchSamlSpSessionBySessionIndex(long companyId, String sessionIndex)
    • fetchSamlSpSessionsBySessionIndex

      public static List<SamlSpSession> fetchSamlSpSessionsBySessionIndex(long companyId, String sessionIndex)
    • 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
    • getSamlSpSession

      public static SamlSpSession getSamlSpSession(long samlSpSessionId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the saml sp session with the primary key.
      Parameters:
      samlSpSessionId - the primary key of the saml sp session
      Returns:
      the saml sp session
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a saml sp session with the primary key could not be found
    • getSamlSpSessionByJSessionId

      public static SamlSpSession getSamlSpSessionByJSessionId(String jSessionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSamlSpSessionBySamlSpSessionKey

      public static SamlSpSession getSamlSpSessionBySamlSpSessionKey(String samlSpSessionKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSamlSpSessionBySessionIndex

      public static SamlSpSession getSamlSpSessionBySessionIndex(long companyId, String sessionIndex) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSamlSpSessions

      public static List<SamlSpSession> getSamlSpSessions(int start, int end)
      Returns a range of all the saml sp sessions.

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

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

      public static List<SamlSpSession> getSamlSpSessions(long companyId, String nameIdFormat, String nameIdNameQualifier, String nameIdSPNameQualifier, String nameIdValue, String samlIdpEntityId)
    • getSamlSpSessionsCount

      public static int getSamlSpSessionsCount()
      Returns the number of saml sp sessions.
      Returns:
      the number of saml sp sessions
    • updateSamlSpSession

      public static SamlSpSession updateSamlSpSession(long samlSpSessionId, String jSessionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSamlSpSession

      public static SamlSpSession updateSamlSpSession(long samlSpSessionId, String assertionXml, String jSessionId, String nameIdFormat, String nameIdNameQualifier, String nameIdSPNameQualifier, String nameIdValue, String samlIdpEntityId, String samlSpSessionKey, String sessionIndex, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSamlSpSession

      public static SamlSpSession updateSamlSpSession(SamlSpSession samlSpSession)
      Updates the saml sp session in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect SamlSpSessionLocalServiceImpl 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:
      samlSpSession - the saml sp session
      Returns:
      the saml sp session that was updated
    • getService

      public static SamlSpSessionLocalService getService()