com.liferay.multi.factor.authentication.email.otp.service

Class MFAEmailOTPEntryLocalServiceUtil

java.lang.Object

com.liferay.multi.factor.authentication.email.otp.service.MFAEmailOTPEntryLocalServiceUtil

public class MFAEmailOTPEntryLocalServiceUtil
extends java.lang.Object

Provides the local service utility for MFAEmailOTPEntry. This utility wraps com.liferay.multi.factor.authentication.email.otp.service.impl.MFAEmailOTPEntryLocalServiceImpl 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:

MFAEmailOTPEntryLocalService

Constructor Summary

Constructors

Constructor and Description
MFAEmailOTPEntryLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static MFAEmailOTPEntry	addMFAEmailOTPEntry(long userId)
static MFAEmailOTPEntry	addMFAEmailOTPEntry(MFAEmailOTPEntry mfaEmailOTPEntry) Adds the mfa email otp entry to the database.
static MFAEmailOTPEntry	createMFAEmailOTPEntry(long mfaEmailOTPEntryId) Creates a new mfa email otp entry with the primary key.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static MFAEmailOTPEntry	deleteMFAEmailOTPEntry(long mfaEmailOTPEntryId) Deletes the mfa email otp entry with the primary key from the database.
static MFAEmailOTPEntry	deleteMFAEmailOTPEntry(MFAEmailOTPEntry mfaEmailOTPEntry) Deletes the mfa email otp entry from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static <T> T	dslQuery(DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static MFAEmailOTPEntry	fetchMFAEmailOTPEntry(long mfaEmailOTPEntryId)
static MFAEmailOTPEntry	fetchMFAEmailOTPEntryByUserId(long userId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.util.List<MFAEmailOTPEntry>	getMFAEmailOTPEntries(int start, int end) Returns a range of all the mfa email otp entries.
static int	getMFAEmailOTPEntriesCount() Returns the number of mfa email otp entries.
static MFAEmailOTPEntry	getMFAEmailOTPEntry(long mfaEmailOTPEntryId) Returns the mfa email otp entry with the primary key.
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static MFAEmailOTPEntryLocalService	getService()
static MFAEmailOTPEntry	resetFailedAttempts(long userId)
static MFAEmailOTPEntry	updateAttempts(long userId, java.lang.String ip, boolean success)
static MFAEmailOTPEntry	updateMFAEmailOTPEntry(MFAEmailOTPEntry mfaEmailOTPEntry) Updates the mfa email otp entry in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MFAEmailOTPEntryLocalServiceUtil

public MFAEmailOTPEntryLocalServiceUtil()

Method Detail

addMFAEmailOTPEntry

public static MFAEmailOTPEntry addMFAEmailOTPEntry(long userId)
                                            throws PortalException

Throws:

PortalException

addMFAEmailOTPEntry

public static MFAEmailOTPEntry addMFAEmailOTPEntry(MFAEmailOTPEntry mfaEmailOTPEntry)

Adds the mfa email otp entry to the database. Also notifies the appropriate model listeners.

Parameters:

mfaEmailOTPEntry - the mfa email otp entry

Returns:

the mfa email otp entry that was added

createMFAEmailOTPEntry

public static MFAEmailOTPEntry createMFAEmailOTPEntry(long mfaEmailOTPEntryId)

Creates a new mfa email otp entry with the primary key. Does not add the mfa email otp entry to the database.

Parameters:

mfaEmailOTPEntryId - the primary key for the new mfa email otp entry

Returns:

the new mfa email otp entry

createPersistedModel

public static PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

deleteMFAEmailOTPEntry

public static MFAEmailOTPEntry deleteMFAEmailOTPEntry(long mfaEmailOTPEntryId)
                                               throws PortalException

Deletes the mfa email otp entry with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

mfaEmailOTPEntryId - the primary key of the mfa email otp entry

Returns:

the mfa email otp entry that was removed

Throws:

PortalException - if a mfa email otp entry with the primary key could not be found

deleteMFAEmailOTPEntry

public static MFAEmailOTPEntry deleteMFAEmailOTPEntry(MFAEmailOTPEntry mfaEmailOTPEntry)

Deletes the mfa email otp entry from the database. Also notifies the appropriate model listeners.

Parameters:

mfaEmailOTPEntry - the mfa email otp entry

Returns:

the mfa email otp entry that was removed

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(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> java.util.List<T> dynamicQuery(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.email.otp.model.impl.MFAEmailOTPEntryModelImpl.

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> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 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.email.otp.model.impl.MFAEmailOTPEntryModelImpl.

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(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(DynamicQuery dynamicQuery,
                                     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

fetchMFAEmailOTPEntry

public static MFAEmailOTPEntry fetchMFAEmailOTPEntry(long mfaEmailOTPEntryId)

fetchMFAEmailOTPEntryByUserId

public static MFAEmailOTPEntry fetchMFAEmailOTPEntryByUserId(long userId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMFAEmailOTPEntries

public static java.util.List<MFAEmailOTPEntry> getMFAEmailOTPEntries(int start,
                                                                     int end)

Returns a range of all the mfa email 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.email.otp.model.impl.MFAEmailOTPEntryModelImpl.

Parameters:

start - the lower bound of the range of mfa email otp entries

end - the upper bound of the range of mfa email otp entries (not inclusive)

Returns:

the range of mfa email otp entries

getMFAEmailOTPEntriesCount

public static int getMFAEmailOTPEntriesCount()

Returns the number of mfa email otp entries.

Returns:

the number of mfa email otp entries

getMFAEmailOTPEntry

public static MFAEmailOTPEntry getMFAEmailOTPEntry(long mfaEmailOTPEntryId)
                                            throws PortalException

Returns the mfa email otp entry with the primary key.

Parameters:

mfaEmailOTPEntryId - the primary key of the mfa email otp entry

Returns:

the mfa email otp entry

Throws:

PortalException - if a mfa email otp entry with the primary key could not be found

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

resetFailedAttempts

public static MFAEmailOTPEntry resetFailedAttempts(long userId)
                                            throws PortalException

Throws:

PortalException

updateAttempts

public static MFAEmailOTPEntry updateAttempts(long userId,
                                              java.lang.String ip,
                                              boolean success)
                                       throws PortalException

Throws:

PortalException

updateMFAEmailOTPEntry

public static MFAEmailOTPEntry updateMFAEmailOTPEntry(MFAEmailOTPEntry mfaEmailOTPEntry)

Updates the mfa email otp entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

mfaEmailOTPEntry - the mfa email otp entry

Returns:

the mfa email otp entry that was updated

getService

public static MFAEmailOTPEntryLocalService getService()