Class PasswordPolicyLocalServiceUtil
com.liferay.portal.service.impl.PasswordPolicyLocalServiceImpl 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 PasswordPolicyaddPasswordPolicy(long userId, boolean defaultPolicy, String name, String description, boolean changeable, boolean changeRequired, long minAge, boolean checkSyntax, boolean allowDictionaryWords, int minAlphanumeric, int minLength, int minLowerCase, int minNumbers, int minSymbols, int minUpperCase, String regex, boolean history, int historyCount, boolean expireable, long maxAge, long warningTime, int graceLimit, boolean lockout, int maxFailure, long lockoutDuration, long resetFailureCount, long resetTicketMaxAge, ServiceContext serviceContext) static PasswordPolicyaddPasswordPolicy(PasswordPolicy passwordPolicy) Adds the password policy to the database.static voidcheckDefaultPasswordPolicy(long companyId) static PasswordPolicycreatePasswordPolicy(long passwordPolicyId) Creates a new password policy with the primary key.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static voiddeleteNondefaultPasswordPolicies(long companyId) static PasswordPolicydeletePasswordPolicy(long passwordPolicyId) Deletes the password policy with the primary key from the database.static PasswordPolicydeletePasswordPolicy(PasswordPolicy passwordPolicy) Deletes the password policy from the database.static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuerystatic <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 longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static PasswordPolicyfetchPasswordPolicy(long passwordPolicyId) static PasswordPolicyfetchPasswordPolicy(long companyId, String name) static PasswordPolicyfetchPasswordPolicyByUuidAndCompanyId(String uuid, long companyId) Returns the password policy with the matching UUID and company.static ActionableDynamicQuerystatic PasswordPolicygetDefaultPasswordPolicy(long companyId) static ExportActionableDynamicQuerygetExportActionableDynamicQuery(PortletDataContext portletDataContext) static StringReturns the OSGi service identifier.static List<PasswordPolicy>getPasswordPolicies(int start, int end) Returns a range of all the password policies.static intReturns the number of password policies.static PasswordPolicygetPasswordPolicy(long passwordPolicyId) Returns the password policy with the primary key.static PasswordPolicygetPasswordPolicy(long companyId, boolean defaultPolicy) static PasswordPolicygetPasswordPolicy(long companyId, long[] organizationIds) static PasswordPolicygetPasswordPolicyByUser(User user) static PasswordPolicygetPasswordPolicyByUserId(long userId) static PasswordPolicygetPasswordPolicyByUuidAndCompanyId(String uuid, long companyId) Returns the password policy with the matching UUID and company.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static PasswordPolicyLocalServicestatic List<PasswordPolicy>search(long companyId, String name, int start, int end, OrderByComparator<PasswordPolicy> orderByComparator) static intsearchCount(long companyId, String name) static voidsetService(PasswordPolicyLocalService service) static PasswordPolicyupdatePasswordPolicy(long passwordPolicyId, String name, String description, boolean changeable, boolean changeRequired, long minAge, boolean checkSyntax, boolean allowDictionaryWords, int minAlphanumeric, int minLength, int minLowerCase, int minNumbers, int minSymbols, int minUpperCase, String regex, boolean history, int historyCount, boolean expireable, long maxAge, long warningTime, int graceLimit, boolean lockout, int maxFailure, long lockoutDuration, long resetFailureCount, long resetTicketMaxAge, ServiceContext serviceContext) static PasswordPolicyupdatePasswordPolicy(PasswordPolicy passwordPolicy) Updates the password policy in the database or adds it if it does not yet exist.
-
Constructor Details
-
PasswordPolicyLocalServiceUtil
public PasswordPolicyLocalServiceUtil()
-
-
Method Details
-
addPasswordPolicy
public static PasswordPolicy addPasswordPolicy(long userId, boolean defaultPolicy, String name, String description, boolean changeable, boolean changeRequired, long minAge, boolean checkSyntax, boolean allowDictionaryWords, int minAlphanumeric, int minLength, int minLowerCase, int minNumbers, int minSymbols, int minUpperCase, String regex, boolean history, int historyCount, boolean expireable, long maxAge, long warningTime, int graceLimit, boolean lockout, int maxFailure, long lockoutDuration, long resetFailureCount, long resetTicketMaxAge, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addPasswordPolicy
Adds the password policy to the database. Also notifies the appropriate model listeners.Important: Inspect PasswordPolicyLocalServiceImpl 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:
passwordPolicy- the password policy- Returns:
- the password policy that was added
-
checkDefaultPasswordPolicy
- Throws:
PortalException
-
createPasswordPolicy
Creates a new password policy with the primary key. Does not add the password policy to the database.- Parameters:
passwordPolicyId- the primary key for the new password policy- Returns:
- the new password policy
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteNondefaultPasswordPolicies
- Throws:
PortalException
-
deletePasswordPolicy
Deletes the password policy with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect PasswordPolicyLocalServiceImpl 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:
passwordPolicyId- the primary key of the password policy- Returns:
- the password policy that was removed
- Throws:
PortalException- if a password policy with the primary key could not be found
-
deletePasswordPolicy
public static PasswordPolicy deletePasswordPolicy(PasswordPolicy passwordPolicy) throws PortalException Deletes the password policy from the database. Also notifies the appropriate model listeners.Important: Inspect PasswordPolicyLocalServiceImpl 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:
passwordPolicy- the password policy- Returns:
- the password policy that was removed
- Throws:
PortalException
-
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
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
-
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PasswordPolicyModelImpl.- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PasswordPolicyModelImpl.- 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
-
fetchPasswordPolicy
-
fetchPasswordPolicy
-
fetchPasswordPolicyByUuidAndCompanyId
Returns the password policy with the matching UUID and company.- Parameters:
uuid- the password policy's UUIDcompanyId- the primary key of the company- Returns:
- the matching password policy, or
nullif a matching password policy could not be found
-
getActionableDynamicQuery
-
getDefaultPasswordPolicy
- Throws:
PortalException
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPasswordPolicies
Returns a range of all the password policies.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PasswordPolicyModelImpl.- Parameters:
start- the lower bound of the range of password policiesend- the upper bound of the range of password policies (not inclusive)- Returns:
- the range of password policies
-
getPasswordPoliciesCount
public static int getPasswordPoliciesCount()Returns the number of password policies.- Returns:
- the number of password policies
-
getPasswordPolicy
Returns the password policy with the primary key.- Parameters:
passwordPolicyId- the primary key of the password policy- Returns:
- the password policy
- Throws:
PortalException- if a password policy with the primary key could not be found
-
getPasswordPolicy
public static PasswordPolicy getPasswordPolicy(long companyId, boolean defaultPolicy) throws PortalException - Throws:
PortalException
-
getPasswordPolicy
public static PasswordPolicy getPasswordPolicy(long companyId, long[] organizationIds) throws PortalException - Throws:
PortalException
-
getPasswordPolicyByUser
- Throws:
PortalException
-
getPasswordPolicyByUserId
- Throws:
PortalException
-
getPasswordPolicyByUuidAndCompanyId
public static PasswordPolicy getPasswordPolicyByUuidAndCompanyId(String uuid, long companyId) throws PortalException Returns the password policy with the matching UUID and company.- Parameters:
uuid- the password policy's UUIDcompanyId- the primary key of the company- Returns:
- the matching password policy
- Throws:
PortalException- if a matching password policy could not be found
-
getPersistedModel
- Throws:
PortalException
-
search
public static List<PasswordPolicy> search(long companyId, String name, int start, int end, OrderByComparator<PasswordPolicy> orderByComparator) -
searchCount
-
updatePasswordPolicy
public static PasswordPolicy updatePasswordPolicy(long passwordPolicyId, String name, String description, boolean changeable, boolean changeRequired, long minAge, boolean checkSyntax, boolean allowDictionaryWords, int minAlphanumeric, int minLength, int minLowerCase, int minNumbers, int minSymbols, int minUpperCase, String regex, boolean history, int historyCount, boolean expireable, long maxAge, long warningTime, int graceLimit, boolean lockout, int maxFailure, long lockoutDuration, long resetFailureCount, long resetTicketMaxAge, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updatePasswordPolicy
Updates the password policy in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect PasswordPolicyLocalServiceImpl 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:
passwordPolicy- the password policy- Returns:
- the password policy that was updated
-
getService
-
setService
-