public class MFATimeBasedOTPEntryLocalServiceUtil
extends java.lang.Object
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.MFATimeBasedOTPEntryLocalService
Constructor and Description |
---|
MFATimeBasedOTPEntryLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static MFATimeBasedOTPEntry |
addMFATimeBasedOTPEntry(MFATimeBasedOTPEntry mfaTimeBasedOTPEntry)
Adds the mfa time based otp entry to the database.
|
static MFATimeBasedOTPEntry |
addTimeBasedOTPEntry(long userId,
java.lang.String sharedSecret) |
static MFATimeBasedOTPEntry |
createMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId)
Creates a new mfa time based otp entry with the primary key.
|
static com.liferay.portal.kernel.model.PersistedModel |
createPersistedModel(java.io.Serializable primaryKeyObj) |
static MFATimeBasedOTPEntry |
deleteMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId)
Deletes the mfa time based otp entry with the primary key from the database.
|
static MFATimeBasedOTPEntry |
deleteMFATimeBasedOTPEntry(MFATimeBasedOTPEntry mfaTimeBasedOTPEntry)
Deletes the mfa time based otp entry from the database.
|
static com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static <T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> java.util.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.
|
static <T> java.util.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.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
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.
|
static MFATimeBasedOTPEntry |
fetchMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId) |
static MFATimeBasedOTPEntry |
fetchMFATimeBasedOTPEntryByUserId(long userId) |
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static java.util.List<MFATimeBasedOTPEntry> |
getMFATimeBasedOTPEntries(int start,
int end)
Returns a range of all the mfa time based otp entries.
|
static int |
getMFATimeBasedOTPEntriesCount()
Returns the number of mfa time based otp entries.
|
static MFATimeBasedOTPEntry |
getMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId)
Returns the mfa time based otp entry with the primary key.
|
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static MFATimeBasedOTPEntryLocalService |
getService() |
static MFATimeBasedOTPEntry |
resetFailedAttempts(long userId) |
static MFATimeBasedOTPEntry |
updateAttempts(long userId,
java.lang.String ipAddress,
boolean success) |
static MFATimeBasedOTPEntry |
updateMFATimeBasedOTPEntry(MFATimeBasedOTPEntry mfaTimeBasedOTPEntry)
Updates the mfa time based otp entry in the database or adds it if it does not yet exist.
|
public MFATimeBasedOTPEntryLocalServiceUtil()
public static MFATimeBasedOTPEntry addMFATimeBasedOTPEntry(MFATimeBasedOTPEntry mfaTimeBasedOTPEntry)
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.
mfaTimeBasedOTPEntry
- the mfa time based otp entrypublic static MFATimeBasedOTPEntry addTimeBasedOTPEntry(long userId, java.lang.String sharedSecret) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static MFATimeBasedOTPEntry createMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId)
mfaTimeBasedOTPEntryId
- the primary key for the new mfa time based otp entrypublic static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static MFATimeBasedOTPEntry deleteMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId) throws com.liferay.portal.kernel.exception.PortalException
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.
mfaTimeBasedOTPEntryId
- the primary key of the mfa time based otp entrycom.liferay.portal.kernel.exception.PortalException
- if a mfa time based otp entry with the primary key could not be foundpublic static MFATimeBasedOTPEntry deleteMFATimeBasedOTPEntry(MFATimeBasedOTPEntry mfaTimeBasedOTPEntry)
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.
mfaTimeBasedOTPEntry
- the mfa time based otp entrypublic static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static MFATimeBasedOTPEntry fetchMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId)
public static MFATimeBasedOTPEntry fetchMFATimeBasedOTPEntryByUserId(long userId)
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static java.util.List<MFATimeBasedOTPEntry> getMFATimeBasedOTPEntries(int start, int end)
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
.
start
- the lower bound of the range of mfa time based otp entriesend
- the upper bound of the range of mfa time based otp entries (not inclusive)public static int getMFATimeBasedOTPEntriesCount()
public static MFATimeBasedOTPEntry getMFATimeBasedOTPEntry(long mfaTimeBasedOTPEntryId) throws com.liferay.portal.kernel.exception.PortalException
mfaTimeBasedOTPEntryId
- the primary key of the mfa time based otp entrycom.liferay.portal.kernel.exception.PortalException
- if a mfa time based otp entry with the primary key could not be foundpublic static java.lang.String getOSGiServiceIdentifier()
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static MFATimeBasedOTPEntry resetFailedAttempts(long userId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static MFATimeBasedOTPEntry updateAttempts(long userId, java.lang.String ipAddress, boolean success) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static MFATimeBasedOTPEntry updateMFATimeBasedOTPEntry(MFATimeBasedOTPEntry mfaTimeBasedOTPEntry)
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.
mfaTimeBasedOTPEntry
- the mfa time based otp entrypublic static MFATimeBasedOTPEntryLocalService getService()