Interface MFATimeBasedOTPEntryLocalService

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

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

    • addMFATimeBasedOTPEntry

      @Indexable(type=REINDEX) MFATimeBasedOTPEntry addMFATimeBasedOTPEntry(MFATimeBasedOTPEntry mfaTimeBasedOTPEntry)
      Adds the mfa time based otp entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect MFATimeBasedOTPEntryLocalServiceImpl 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:
      mfaTimeBasedOTPEntry - the mfa time based otp entry
      Returns:
      the mfa time based otp entry that was added
    • addTimeBasedOTPEntry

      MFATimeBasedOTPEntry addTimeBasedOTPEntry(long userId, String sharedSecret) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createMFATimeBasedOTPEntry

      @Transactional(enabled=false) MFATimeBasedOTPEntry createMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId)
      Creates a new mfa time based otp entry with the primary key. Does not add the mfa time based otp entry to the database.
      Parameters:
      mfaTimeBasedOTPEntryId - the primary key for the new mfa time based otp entry
      Returns:
      the new mfa time based otp entry
    • 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
    • deleteMFATimeBasedOTPEntry

      @Indexable(type=DELETE) MFATimeBasedOTPEntry deleteMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the mfa time based otp entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect MFATimeBasedOTPEntryLocalServiceImpl 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:
      mfaTimeBasedOTPEntryId - the primary key of the mfa time based otp entry
      Returns:
      the mfa time based otp entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a mfa time based otp entry with the primary key could not be found
    • deleteMFATimeBasedOTPEntry

      @Indexable(type=DELETE) MFATimeBasedOTPEntry deleteMFATimeBasedOTPEntry(MFATimeBasedOTPEntry mfaTimeBasedOTPEntry)
      Deletes the mfa time based otp entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect MFATimeBasedOTPEntryLocalServiceImpl 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:
      mfaTimeBasedOTPEntry - the mfa time based otp entry
      Returns:
      the mfa time based otp entry that was removed
    • 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
    • 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.multi.factor.authentication.timebased.otp.model.impl.MFATimeBasedOTPEntryModelImpl.

      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.multi.factor.authentication.timebased.otp.model.impl.MFATimeBasedOTPEntryModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) MFATimeBasedOTPEntry fetchMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId)
    • fetchMFATimeBasedOTPEntryByUserId

      @Transactional(propagation=SUPPORTS, readOnly=true) MFATimeBasedOTPEntry fetchMFATimeBasedOTPEntryByUserId(long userId)
    • 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()
    • getMFATimeBasedOTPEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<MFATimeBasedOTPEntry> getMFATimeBasedOTPEntries(int start, int end)
      Returns a range of all the mfa time based otp entries.

      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.multi.factor.authentication.timebased.otp.model.impl.MFATimeBasedOTPEntryModelImpl.

      Parameters:
      start - the lower bound of the range of mfa time based otp entries
      end - the upper bound of the range of mfa time based otp entries (not inclusive)
      Returns:
      the range of mfa time based otp entries
    • getMFATimeBasedOTPEntriesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getMFATimeBasedOTPEntriesCount()
      Returns the number of mfa time based otp entries.
      Returns:
      the number of mfa time based otp entries
    • getMFATimeBasedOTPEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) MFATimeBasedOTPEntry getMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the mfa time based otp entry with the primary key.
      Parameters:
      mfaTimeBasedOTPEntryId - the primary key of the mfa time based otp entry
      Returns:
      the mfa time based otp entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a mfa time based otp entry with the primary key could not be found
    • 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
    • resetFailedAttempts

      MFATimeBasedOTPEntry resetFailedAttempts(long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateAttempts

      MFATimeBasedOTPEntry updateAttempts(long userId, String ipAddress, boolean success) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLastTOTP

      MFATimeBasedOTPEntry updateLastTOTP(long userId, String lastValidTOTP) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateMFATimeBasedOTPEntry

      @Indexable(type=REINDEX) MFATimeBasedOTPEntry updateMFATimeBasedOTPEntry(MFATimeBasedOTPEntry mfaTimeBasedOTPEntry)
      Updates the mfa time based otp entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect MFATimeBasedOTPEntryLocalServiceImpl 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:
      mfaTimeBasedOTPEntry - the mfa time based otp entry
      Returns:
      the mfa time based otp entry that was updated