com.liferay.portal.kernel.service

Class PasswordPolicyLocalServiceUtil

Object

com.liferay.portal.kernel.service.PasswordPolicyLocalServiceUtil

@ProviderType
public class PasswordPolicyLocalServiceUtil
extends Object

Provides the local service utility for PasswordPolicy. This utility wraps PasswordPolicyLocalServiceImpl and is the primary 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:

PasswordPolicyLocalService, PasswordPolicyLocalServiceBaseImpl, PasswordPolicyLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
PasswordPolicyLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
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)
static PasswordPolicy	addPasswordPolicy(PasswordPolicy passwordPolicy) Adds the password policy to the database.
static void	checkDefaultPasswordPolicy(long companyId)
static PasswordPolicy	createPasswordPolicy(long passwordPolicyId) Creates a new password policy with the primary key.
static void	deleteNondefaultPasswordPolicies(long companyId)
static PasswordPolicy	deletePasswordPolicy(long passwordPolicyId) Deletes the password policy with the primary key from the database.
static PasswordPolicy	deletePasswordPolicy(PasswordPolicy passwordPolicy) Deletes the password policy from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static DynamicQuery	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 PasswordPolicy	fetchPasswordPolicy(long passwordPolicyId)
static PasswordPolicy	fetchPasswordPolicy(long companyId, String name)
static PasswordPolicy	fetchPasswordPolicyByUuidAndCompanyId(String uuid, long companyId) Returns the password policy with the matching UUID and company.
static ActionableDynamicQuery	getActionableDynamicQuery()
static PasswordPolicy	getDefaultPasswordPolicy(long companyId)
static ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static List<PasswordPolicy>	getPasswordPolicies(int start, int end) Returns a range of all the password policies.
static int	getPasswordPoliciesCount() Returns the number of password policies.
static PasswordPolicy	getPasswordPolicy(long passwordPolicyId) Returns the password policy with the primary key.
static PasswordPolicy	getPasswordPolicy(long companyId, long[] organizationIds)
static PasswordPolicy	getPasswordPolicyByUser(User user)
static PasswordPolicy	getPasswordPolicyByUserId(long userId)
static PasswordPolicy	getPasswordPolicyByUuidAndCompanyId(String uuid, long companyId) Returns the password policy with the matching UUID and company.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static PasswordPolicyLocalService	getService()
static List<PasswordPolicy>	search(long companyId, String name, int start, int end, OrderByComparator<PasswordPolicy> obc)
static int	searchCount(long companyId, String name)
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)
static PasswordPolicy	updatePasswordPolicy(PasswordPolicy passwordPolicy) Updates the password policy in the database or adds it if it does not yet exist.

Methods inherited from class Object

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

Constructor Detail

PasswordPolicyLocalServiceUtil

public PasswordPolicyLocalServiceUtil()

Method Detail

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

public static PasswordPolicy addPasswordPolicy(PasswordPolicy passwordPolicy)

Adds the password policy to the database. Also notifies the appropriate model listeners.

Parameters:

passwordPolicy - the password policy

Returns:

the password policy that was added

checkDefaultPasswordPolicy

public static void checkDefaultPasswordPolicy(long companyId)
                                       throws PortalException

Throws:

PortalException

createPasswordPolicy

public static PasswordPolicy createPasswordPolicy(long passwordPolicyId)

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

deleteNondefaultPasswordPolicies

public static void deleteNondefaultPasswordPolicies(long companyId)
                                             throws PortalException

Throws:

PortalException

deletePasswordPolicy

public static PasswordPolicy deletePasswordPolicy(long passwordPolicyId)
                                           throws PortalException

Deletes the password policy with the primary key from the database. Also notifies the appropriate model listeners.

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.

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

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> 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> 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PasswordPolicyModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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(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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PasswordPolicyModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

fetchPasswordPolicy

public static PasswordPolicy fetchPasswordPolicy(long passwordPolicyId)

fetchPasswordPolicy

public static PasswordPolicy fetchPasswordPolicy(long companyId,
                                                 String name)

fetchPasswordPolicyByUuidAndCompanyId

public static PasswordPolicy fetchPasswordPolicyByUuidAndCompanyId(String uuid,
                                                                   long companyId)

Returns the password policy with the matching UUID and company.

Parameters:

uuid - the password policy's UUID

companyId - the primary key of the company

Returns:

the matching password policy, or null if a matching password policy could not be found

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDefaultPasswordPolicy

public static PasswordPolicy getDefaultPasswordPolicy(long companyId)
                                               throws PortalException

Throws:

PortalException

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPasswordPolicies

public static List<PasswordPolicy> getPasswordPolicies(int start,
                                                       int end)

Returns a range of all the password policies.

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PasswordPolicyModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of password policies

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

public static PasswordPolicy getPasswordPolicy(long passwordPolicyId)
                                        throws PortalException

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,
                                               long[] organizationIds)
                                        throws PortalException

Throws:

PortalException

getPasswordPolicyByUser

public static PasswordPolicy getPasswordPolicyByUser(User user)
                                              throws PortalException

Throws:

PortalException

getPasswordPolicyByUserId

public static PasswordPolicy getPasswordPolicyByUserId(long userId)
                                                throws PortalException

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 UUID

companyId - the primary key of the company

Returns:

the matching password policy

Throws:

PortalException - if a matching password policy could not be found

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

search

public static List<PasswordPolicy> search(long companyId,
                                          String name,
                                          int start,
                                          int end,
                                          OrderByComparator<PasswordPolicy> obc)

searchCount

public static int searchCount(long companyId,
                              String name)

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

public static PasswordPolicy updatePasswordPolicy(PasswordPolicy passwordPolicy)

Updates the password policy in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

passwordPolicy - the password policy

Returns:

the password policy that was updated

getService

public static PasswordPolicyLocalService getService()