com.liferay.portal.kernel.service

Interface PasswordPolicyLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

PasswordPolicyLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface PasswordPolicyLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for PasswordPolicy. 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:

PasswordPolicyLocalServiceUtil, PasswordPolicyLocalServiceBaseImpl, PasswordPolicyLocalServiceImpl

{$generated.description}

Method Summary

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

Method Detail

addPasswordPolicy

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

@Indexable(type=REINDEX)
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

void checkDefaultPasswordPolicy(long companyId)
                         throws PortalException

Throws:

PortalException

createPasswordPolicy

@Transactional(enabled=false)
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

void deleteNondefaultPasswordPolicies(long companyId)
                               throws PortalException

Throws:

PortalException

deletePasswordPolicy

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
 @SystemEvent(action=1,
             type=1)
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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy fetchPasswordPolicy(long passwordPolicyId)

fetchPasswordPolicy

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy fetchPasswordPolicy(long companyId,
                                                                                                      String name)

fetchPasswordPolicyByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getDefaultPasswordPolicy

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy getDefaultPasswordPolicy(long companyId)
                                                                                                    throws PortalException

Throws:

PortalException

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPasswordPolicies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPasswordPoliciesCount()

Returns the number of password policies.

Returns:

the number of password policies

getPasswordPolicy

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy getPasswordPolicy(long companyId,
                                                                                                    long[] organizationIds)
                                                                                             throws PortalException

Throws:

PortalException

getPasswordPolicyByUser

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy getPasswordPolicyByUser(User user)
                                                                                                   throws PortalException

Throws:

PortalException

getPasswordPolicyByUserId

@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy getPasswordPolicyByUserId(long userId)
                                                                                                                           throws PortalException

Throws:

PortalException

getPasswordPolicyByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PasswordPolicy> search(long companyId,
                                                                                               String name,
                                                                                               int start,
                                                                                               int end,
                                                                                               OrderByComparator<PasswordPolicy> obc)

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   String name)

updatePasswordPolicy

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

@Indexable(type=REINDEX)
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