com.liferay.saml.persistence.service.SamlSpAuthRequestLocalService Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.saml.persistence.service;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
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.PersistedModel;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.service.ServiceContext;
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 com.liferay.saml.persistence.model.SamlSpAuthRequest;
import java.io.Serializable;
import java.util.List;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for SamlSpAuthRequest. 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 Mika Koivisto
* @see SamlSpAuthRequestLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface SamlSpAuthRequestLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.saml.persistence.service.impl.SamlSpAuthRequestLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the saml sp auth request local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link SamlSpAuthRequestLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the saml sp auth request to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlSpAuthRequestLocalServiceImpl 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.
*
*
* @param samlSpAuthRequest the saml sp auth request
* @return the saml sp auth request that was added
*/
@Indexable(type = IndexableType.REINDEX)
public SamlSpAuthRequest addSamlSpAuthRequest(
SamlSpAuthRequest samlSpAuthRequest);
public SamlSpAuthRequest addSamlSpAuthRequest(
String samlIdpEntityId, String samlRelayState,
String samlSpAuthRequestKey, ServiceContext serviceContext);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Creates a new saml sp auth request with the primary key. Does not add the saml sp auth request to the database.
*
* @param samlSpAuthnRequestId the primary key for the new saml sp auth request
* @return the new saml sp auth request
*/
@Transactional(enabled = false)
public SamlSpAuthRequest createSamlSpAuthRequest(long samlSpAuthnRequestId);
public void deleteExpiredSamlSpAuthRequests();
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
/**
* Deletes the saml sp auth request with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlSpAuthRequestLocalServiceImpl 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.
*
*
* @param samlSpAuthnRequestId the primary key of the saml sp auth request
* @return the saml sp auth request that was removed
* @throws PortalException if a saml sp auth request with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public SamlSpAuthRequest deleteSamlSpAuthRequest(long samlSpAuthnRequestId)
throws PortalException;
/**
* Deletes the saml sp auth request from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlSpAuthRequestLocalServiceImpl 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.
*
*
* @param samlSpAuthRequest the saml sp auth request
* @return the saml sp auth request that was removed
*/
@Indexable(type = IndexableType.DELETE)
public SamlSpAuthRequest deleteSamlSpAuthRequest(
SamlSpAuthRequest samlSpAuthRequest);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public T dslQuery(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int dslQueryCount(DSLQuery dslQuery);
@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, then the query will include the default ORDER BY logic from com.liferay.saml.persistence.model.impl.SamlSpAuthRequestModelImpl.
*
*
* @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, then the query will include the default ORDER BY logic from com.liferay.saml.persistence.model.impl.SamlSpAuthRequestModelImpl.
*
*
* @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 SamlSpAuthRequest fetchSamlSpAuthRequest(long samlSpAuthnRequestId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SamlSpAuthRequest fetchSamlSpAuthRequest(
String samlIdpEntityId, String samlSpAuthRequestKey);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
/**
* @throws PortalException
*/
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Returns the saml sp auth request with the primary key.
*
* @param samlSpAuthnRequestId the primary key of the saml sp auth request
* @return the saml sp auth request
* @throws PortalException if a saml sp auth request with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SamlSpAuthRequest getSamlSpAuthRequest(long samlSpAuthnRequestId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SamlSpAuthRequest getSamlSpAuthRequest(
String samlIdpEntityId, String samlSpAuthRequestKey)
throws PortalException;
/**
* Returns a range of all the saml sp auth requests.
*
*
* 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, then the query will include the default ORDER BY logic from com.liferay.saml.persistence.model.impl.SamlSpAuthRequestModelImpl.
*
*
* @param start the lower bound of the range of saml sp auth requests
* @param end the upper bound of the range of saml sp auth requests (not inclusive)
* @return the range of saml sp auth requests
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSamlSpAuthRequests(int start, int end);
/**
* Returns the number of saml sp auth requests.
*
* @return the number of saml sp auth requests
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getSamlSpAuthRequestsCount();
/**
* Updates the saml sp auth request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlSpAuthRequestLocalServiceImpl 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.
*
*
* @param samlSpAuthRequest the saml sp auth request
* @return the saml sp auth request that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public SamlSpAuthRequest updateSamlSpAuthRequest(
SamlSpAuthRequest samlSpAuthRequest);
}