com.liferay.portal.kernel.service.PasswordPolicyLocalService Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.kernel.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.portal.kernel.cache.thread.local.ThreadLocalCachable;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.PasswordPolicy;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.model.SystemEventConstants;
import com.liferay.portal.kernel.model.User;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.systemevent.SystemEvent;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import java.io.Serializable;
import java.util.List;
/**
* 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 PasswordPolicyLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface PasswordPolicyLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link PasswordPolicyLocalServiceUtil} to access the password policy local service. Add custom service methods to com.liferay.portal.service.impl.PasswordPolicyLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
public 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;
/**
* Adds the password policy to the database. Also notifies the appropriate model listeners.
*
* @param passwordPolicy the password policy
* @return the password policy that was added
*/
@Indexable(type = IndexableType.REINDEX)
public PasswordPolicy addPasswordPolicy(PasswordPolicy passwordPolicy);
public void checkDefaultPasswordPolicy(long companyId)
throws PortalException;
/**
* Creates a new password policy with the primary key. Does not add the password policy to the database.
*
* @param passwordPolicyId the primary key for the new password policy
* @return the new password policy
*/
@Transactional(enabled = false)
public PasswordPolicy createPasswordPolicy(long passwordPolicyId);
public void deleteNondefaultPasswordPolicies(long companyId)
throws PortalException;
/**
* Deletes the password policy with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param passwordPolicyId the primary key of the password policy
* @return the password policy that was removed
* @throws PortalException if a password policy with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public PasswordPolicy deletePasswordPolicy(long passwordPolicyId)
throws PortalException;
/**
* Deletes the password policy from the database. Also notifies the appropriate model listeners.
*
* @param passwordPolicy the password policy
* @return the password policy that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@SystemEvent(
action = SystemEventConstants.ACTION_SKIP,
type = SystemEventConstants.TYPE_DELETE
)
public PasswordPolicy deletePasswordPolicy(PasswordPolicy passwordPolicy)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(DynamicQuery 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 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end);
/**
* 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 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery dynamicQuery);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PasswordPolicy fetchPasswordPolicy(long passwordPolicyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PasswordPolicy fetchPasswordPolicy(long companyId, String name);
/**
* Returns the password policy with the matching UUID and company.
*
* @param uuid the password policy's UUID
* @param companyId the primary key of the company
* @return the matching password policy, or null if a matching password policy could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PasswordPolicy fetchPasswordPolicyByUuidAndCompanyId(
String uuid, long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PasswordPolicy getDefaultPasswordPolicy(long companyId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
/**
* 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 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.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.
*
*
* @param start the lower bound of the range of password policies
* @param end the upper bound of the range of password policies (not inclusive)
* @return the range of password policies
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getPasswordPolicies(int start, int end);
/**
* Returns the number of password policies.
*
* @return the number of password policies
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getPasswordPoliciesCount();
/**
* Returns the password policy with the primary key.
*
* @param passwordPolicyId the primary key of the password policy
* @return the password policy
* @throws PortalException if a password policy with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PasswordPolicy getPasswordPolicy(long passwordPolicyId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PasswordPolicy getPasswordPolicy(
long companyId, boolean defaultPolicy)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PasswordPolicy getPasswordPolicy(
long companyId, long[] organizationIds)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PasswordPolicy getPasswordPolicyByUser(User user)
throws PortalException;
@ThreadLocalCachable
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PasswordPolicy getPasswordPolicyByUserId(long userId)
throws PortalException;
/**
* Returns the password policy with the matching UUID and company.
*
* @param uuid the password policy's UUID
* @param companyId the primary key of the company
* @return the matching password policy
* @throws PortalException if a matching password policy could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PasswordPolicy getPasswordPolicyByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException;
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List search(
long companyId, String name, int start, int end,
OrderByComparator obc);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchCount(long companyId, String name);
public 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;
/**
* Updates the password policy in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param passwordPolicy the password policy
* @return the password policy that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public PasswordPolicy updatePasswordPolicy(PasswordPolicy passwordPolicy);
}