com.liferay.saml.persistence.service.SamlSpMessageLocalService Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of the Liferay Enterprise
* Subscription License ("License"). You may not use this file except in
* compliance with the License. You can obtain a copy of the License by
* contacting Liferay, Inc. See the License for the specific language governing
* permissions and limitations under the License, including but not limited to
* distribution rights of the Software.
*
*
*
*/
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.SamlSpMessage;
import java.io.Serializable;
import java.util.Date;
import java.util.List;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for SamlSpMessage. 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 SamlSpMessageLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface SamlSpMessageLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.saml.persistence.service.impl.SamlSpMessageLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the saml sp message local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link SamlSpMessageLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the saml sp message to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlSpMessageLocalServiceImpl 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 samlSpMessage the saml sp message
* @return the saml sp message that was added
*/
@Indexable(type = IndexableType.REINDEX)
public SamlSpMessage addSamlSpMessage(SamlSpMessage samlSpMessage);
public SamlSpMessage addSamlSpMessage(
String samlIdpEntityId, String samlIdpResponseKey, Date expirationDate,
ServiceContext serviceContext);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Creates a new saml sp message with the primary key. Does not add the saml sp message to the database.
*
* @param samlSpMessageId the primary key for the new saml sp message
* @return the new saml sp message
*/
@Transactional(enabled = false)
public SamlSpMessage createSamlSpMessage(long samlSpMessageId);
public void deleteExpiredSamlSpMessages();
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
/**
* Deletes the saml sp message with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlSpMessageLocalServiceImpl 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 samlSpMessageId the primary key of the saml sp message
* @return the saml sp message that was removed
* @throws PortalException if a saml sp message with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public SamlSpMessage deleteSamlSpMessage(long samlSpMessageId)
throws PortalException;
/**
* Deletes the saml sp message from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlSpMessageLocalServiceImpl 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 samlSpMessage the saml sp message
* @return the saml sp message that was removed
*/
@Indexable(type = IndexableType.DELETE)
public SamlSpMessage deleteSamlSpMessage(SamlSpMessage samlSpMessage);
@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.SamlSpMessageModelImpl.
*
*
* @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.SamlSpMessageModelImpl.
*
*
* @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 SamlSpMessage fetchSamlSpMessage(long samlSpMessageId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SamlSpMessage fetchSamlSpMessage(
String samlIdpEntityId, String samlIdpResponseKey);
@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 message with the primary key.
*
* @param samlSpMessageId the primary key of the saml sp message
* @return the saml sp message
* @throws PortalException if a saml sp message with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SamlSpMessage getSamlSpMessage(long samlSpMessageId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SamlSpMessage getSamlSpMessage(
String samlIdpEntityId, String samlIdpResponseKey)
throws PortalException;
/**
* Returns a range of all the saml sp messages.
*
*
* 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.SamlSpMessageModelImpl.
*
*
* @param start the lower bound of the range of saml sp messages
* @param end the upper bound of the range of saml sp messages (not inclusive)
* @return the range of saml sp messages
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSamlSpMessages(int start, int end);
/**
* Returns the number of saml sp messages.
*
* @return the number of saml sp messages
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getSamlSpMessagesCount();
/**
* Updates the saml sp message in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlSpMessageLocalServiceImpl 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 samlSpMessage the saml sp message
* @return the saml sp message that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public SamlSpMessage updateSamlSpMessage(SamlSpMessage samlSpMessage);
}