Class MFATimeBasedOTPEntryLocalServiceUtil

java.lang.Object
com.liferay.multi.factor.authentication.timebased.otp.service.MFATimeBasedOTPEntryLocalServiceUtil

public class MFATimeBasedOTPEntryLocalServiceUtil extends Object
Provides the local service utility for MFATimeBasedOTPEntry. This utility wraps com.liferay.multi.factor.authentication.timebased.otp.service.impl.MFATimeBasedOTPEntryLocalServiceImpl 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

    • MFATimeBasedOTPEntryLocalServiceUtil

      public MFATimeBasedOTPEntryLocalServiceUtil()
  • Method Details

    • addMFATimeBasedOTPEntry

      public static 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

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

      public static 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

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

      public static 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

      public static 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

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

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

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

      public static MFATimeBasedOTPEntry fetchMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId)
    • fetchMFATimeBasedOTPEntryByUserId

      public static MFATimeBasedOTPEntry fetchMFATimeBasedOTPEntryByUserId(long userId)
    • getActionableDynamicQuery

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

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

      public static 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

      public static int getMFATimeBasedOTPEntriesCount()
      Returns the number of mfa time based otp entries.
      Returns:
      the number of mfa time based otp entries
    • getMFATimeBasedOTPEntry

      public static 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

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

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

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

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

      public static 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
    • getService

      public static MFATimeBasedOTPEntryLocalService getService()