Interface SamlSpIdpConnectionLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
SamlSpIdpConnectionLocalServiceWrapper

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface SamlSpIdpConnectionLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for SamlSpIdpConnection. 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:
  • Method Details

    • addSamlSpIdpConnection

      SamlSpIdpConnection addSamlSpIdpConnection(boolean assertionSignatureRequired, long clockSkew, boolean enabled, boolean forceAuthn, boolean ldapImportEnabled, String metadataUrl, InputStream metadataXmlInputStream, String name, String nameIdFormat, String samlIdpEntityId, boolean signAuthnRequest, boolean unknownUsersAreStrangers, String userAttributeMappings, String userIdentifierExpression, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addSamlSpIdpConnection

      @Indexable(type=REINDEX) SamlSpIdpConnection addSamlSpIdpConnection(SamlSpIdpConnection samlSpIdpConnection)
      Adds the saml sp idp connection to the database. Also notifies the appropriate model listeners.

      Important: Inspect SamlSpIdpConnectionLocalServiceImpl 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:
      samlSpIdpConnection - the saml sp idp connection
      Returns:
      the saml sp idp connection that was added
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createSamlSpIdpConnection

      @Transactional(enabled=false) SamlSpIdpConnection createSamlSpIdpConnection(long samlSpIdpConnectionId)
      Creates a new saml sp idp connection with the primary key. Does not add the saml sp idp connection to the database.
      Parameters:
      samlSpIdpConnectionId - the primary key for the new saml sp idp connection
      Returns:
      the new saml sp idp connection
    • deletePersistedModel

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSamlSpIdpConnection

      @Indexable(type=DELETE) SamlSpIdpConnection deleteSamlSpIdpConnection(long samlSpIdpConnectionId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the saml sp idp connection with the primary key from the database. Also notifies the appropriate model listeners.

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

      @Indexable(type=DELETE) SamlSpIdpConnection deleteSamlSpIdpConnection(SamlSpIdpConnection samlSpIdpConnection)
      Deletes the saml sp idp connection from the database. Also notifies the appropriate model listeners.

      Important: Inspect SamlSpIdpConnectionLocalServiceImpl 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:
      samlSpIdpConnection - the saml sp idp connection
      Returns:
      the saml sp idp connection that was removed
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.SamlSpIdpConnectionModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.SamlSpIdpConnectionModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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
    • fetchSamlSpIdpConnection

      @Transactional(propagation=SUPPORTS, readOnly=true) SamlSpIdpConnection fetchSamlSpIdpConnection(long samlSpIdpConnectionId)
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSamlSpIdpConnection

      @Transactional(propagation=SUPPORTS, readOnly=true) SamlSpIdpConnection getSamlSpIdpConnection(long samlSpIdpConnectionId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the saml sp idp connection with the primary key.
      Parameters:
      samlSpIdpConnectionId - the primary key of the saml sp idp connection
      Returns:
      the saml sp idp connection
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a saml sp idp connection with the primary key could not be found
    • getSamlSpIdpConnection

      @Transactional(propagation=SUPPORTS, readOnly=true) SamlSpIdpConnection getSamlSpIdpConnection(long companyId, String samlIdpEntityId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSamlSpIdpConnections

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SamlSpIdpConnection> getSamlSpIdpConnections(int start, int end)
      Returns a range of all the saml sp idp connections.

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

      Parameters:
      start - the lower bound of the range of saml sp idp connections
      end - the upper bound of the range of saml sp idp connections (not inclusive)
      Returns:
      the range of saml sp idp connections
    • getSamlSpIdpConnections

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SamlSpIdpConnection> getSamlSpIdpConnections(long companyId)
    • getSamlSpIdpConnections

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SamlSpIdpConnection> getSamlSpIdpConnections(long companyId, int start, int end)
    • getSamlSpIdpConnections

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SamlSpIdpConnection> getSamlSpIdpConnections(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SamlSpIdpConnection> orderByComparator)
    • getSamlSpIdpConnectionsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getSamlSpIdpConnectionsCount()
      Returns the number of saml sp idp connections.
      Returns:
      the number of saml sp idp connections
    • getSamlSpIdpConnectionsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getSamlSpIdpConnectionsCount(long companyId)
    • updateMetadata

      void updateMetadata(long samlSpIdpConnectionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSamlSpIdpConnection

      SamlSpIdpConnection updateSamlSpIdpConnection(long samlSpIdpConnectionId, boolean assertionSignatureRequired, long clockSkew, boolean enabled, boolean forceAuthn, boolean ldapImportEnabled, String metadataUrl, InputStream metadataXmlInputStream, String name, String nameIdFormat, String samlIdpEntityId, boolean signAuthnRequest, boolean unknownUsersAreStrangers, String userAttributeMappings, String userIdentifierExpression, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSamlSpIdpConnection

      @Indexable(type=REINDEX) SamlSpIdpConnection updateSamlSpIdpConnection(SamlSpIdpConnection samlSpIdpConnection)
      Updates the saml sp idp connection in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect SamlSpIdpConnectionLocalServiceImpl 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:
      samlSpIdpConnection - the saml sp idp connection
      Returns:
      the saml sp idp connection that was updated