Class RememberMeTokenLocalServiceUtil
com.liferay.portal.service.impl.RememberMeTokenLocalServiceImpl
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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic RememberMeToken
addRememberMeToken
(long companyId, long userId, Date expirationDate, Consumer<String> valueConsumer) static RememberMeToken
addRememberMeToken
(RememberMeToken rememberMeToken) Adds the remember me token to the database.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static RememberMeToken
createRememberMeToken
(long rememberMeTokenId) Creates a new remember me token with the primary key.static void
deleteExpiredRememberMeTokens
(long userId) static void
deleteExpiredRememberMeTokens
(Date expirationDate) static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static RememberMeToken
deleteRememberMeToken
(long rememberMeTokenId) Deletes the remember me token with the primary key from the database.static RememberMeToken
deleteRememberMeToken
(RememberMeToken rememberMeToken) Deletes the remember me token from the database.static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> 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> 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 RememberMeToken
fetchRememberMeToken
(long rememberMeTokenId) static RememberMeToken
fetchRememberMeToken
(long rememberMeTokenId, String value) static ActionableDynamicQuery
static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static RememberMeToken
getRememberMeToken
(long rememberMeTokenId) Returns the remember me token with the primary key.static List<RememberMeToken>
getRememberMeTokens
(int start, int end) Returns a range of all the remember me tokens.static int
Returns the number of remember me tokens.static RememberMeTokenLocalService
static void
setService
(RememberMeTokenLocalService service) static RememberMeToken
updateRememberMeToken
(RememberMeToken rememberMeToken) Updates the remember me token in the database or adds it if it does not yet exist.
-
Constructor Details
-
RememberMeTokenLocalServiceUtil
public RememberMeTokenLocalServiceUtil()
-
-
Method Details
-
addRememberMeToken
public static RememberMeToken addRememberMeToken(long companyId, long userId, Date expirationDate, Consumer<String> valueConsumer) throws PwdEncryptorException - Throws:
PwdEncryptorException
-
addRememberMeToken
Adds the remember me token to the database. Also notifies the appropriate model listeners.Important: Inspect RememberMeTokenLocalServiceImpl 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:
rememberMeToken
- the remember me token- Returns:
- the remember me token that was added
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
createRememberMeToken
Creates a new remember me token with the primary key. Does not add the remember me token to the database.- Parameters:
rememberMeTokenId
- the primary key for the new remember me token- Returns:
- the new remember me token
-
deleteExpiredRememberMeTokens
-
deleteExpiredRememberMeTokens
public static void deleteExpiredRememberMeTokens(long userId) -
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deleteRememberMeToken
Deletes the remember me token with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect RememberMeTokenLocalServiceImpl 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:
rememberMeTokenId
- the primary key of the remember me token- Returns:
- the remember me token that was removed
- Throws:
PortalException
- if a remember me token with the primary key could not be found
-
deleteRememberMeToken
Deletes the remember me token from the database. Also notifies the appropriate model listeners.Important: Inspect RememberMeTokenLocalServiceImpl 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:
rememberMeToken
- the remember me token- Returns:
- the remember me token that was removed
-
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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.RememberMeTokenModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.RememberMeTokenModelImpl
.- Parameters:
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 (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchRememberMeToken
-
fetchRememberMeToken
public static RememberMeToken fetchRememberMeToken(long rememberMeTokenId, String value) throws PwdEncryptorException - Throws:
PwdEncryptorException
-
getActionableDynamicQuery
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getRememberMeToken
Returns the remember me token with the primary key.- Parameters:
rememberMeTokenId
- the primary key of the remember me token- Returns:
- the remember me token
- Throws:
PortalException
- if a remember me token with the primary key could not be found
-
getRememberMeTokens
Returns a range of all the remember me tokens.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.RememberMeTokenModelImpl
.- Parameters:
start
- the lower bound of the range of remember me tokensend
- the upper bound of the range of remember me tokens (not inclusive)- Returns:
- the range of remember me tokens
-
getRememberMeTokensCount
public static int getRememberMeTokensCount()Returns the number of remember me tokens.- Returns:
- the number of remember me tokens
-
updateRememberMeToken
Updates the remember me token in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect RememberMeTokenLocalServiceImpl 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:
rememberMeToken
- the remember me token- Returns:
- the remember me token that was updated
-
getService
-
setService
-