com.liferay.saml.persistence.service

Interface SamlSpMessageLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

SamlSpMessageLocalServiceWrapper

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

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.

See Also:

SamlSpMessageLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
SamlSpMessage	addSamlSpMessage(SamlSpMessage samlSpMessage) Adds the saml sp message to the database.
SamlSpMessage	addSamlSpMessage(java.lang.String samlIdpEntityId, java.lang.String samlIdpResponseKey, java.util.Date expirationDate, ServiceContext serviceContext)
SamlSpMessage	createSamlSpMessage(long samlSpMessageId) Creates a new saml sp message with the primary key.
void	deleteExpiredSamlSpMessages()
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
SamlSpMessage	deleteSamlSpMessage(long samlSpMessageId) Deletes the saml sp message with the primary key from the database.
SamlSpMessage	deleteSamlSpMessage(SamlSpMessage samlSpMessage) Deletes the saml sp message from the database.
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.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> java.util.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.
SamlSpMessage	fetchSamlSpMessage(long samlSpMessageId)
SamlSpMessage	fetchSamlSpMessage(java.lang.String samlIdpEntityId, java.lang.String samlIdpResponseKey)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
SamlSpMessage	getSamlSpMessage(long samlSpMessageId) Returns the saml sp message with the primary key.
SamlSpMessage	getSamlSpMessage(java.lang.String samlIdpEntityId, java.lang.String samlIdpResponseKey)
java.util.List<SamlSpMessage>	getSamlSpMessages(int start, int end) Returns a range of all the saml sp messages.
int	getSamlSpMessagesCount() Returns the number of saml sp messages.
SamlSpMessage	updateSamlSpMessage(SamlSpMessage samlSpMessage) Updates the saml sp message in the database or adds it if it does not yet exist.

Method Detail

addSamlSpMessage

@Indexable(type=REINDEX)
SamlSpMessage addSamlSpMessage(SamlSpMessage samlSpMessage)

Adds the saml sp message to the database. Also notifies the appropriate model listeners.

Parameters:

samlSpMessage - the saml sp message

Returns:

the saml sp message that was added

addSamlSpMessage

SamlSpMessage addSamlSpMessage(java.lang.String samlIdpEntityId,
                               java.lang.String samlIdpResponseKey,
                               java.util.Date expirationDate,
                               ServiceContext serviceContext)

createSamlSpMessage

@Transactional(enabled=false)
SamlSpMessage createSamlSpMessage(long samlSpMessageId)

Creates a new saml sp message with the primary key. Does not add the saml sp message to the database.

Parameters:

samlSpMessageId - the primary key for the new saml sp message

Returns:

the new saml sp message

deleteExpiredSamlSpMessages

void deleteExpiredSamlSpMessages()

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteSamlSpMessage

@Indexable(type=DELETE)
SamlSpMessage deleteSamlSpMessage(long samlSpMessageId)
                                                   throws PortalException

Deletes the saml sp message with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

samlSpMessageId - the primary key of the saml sp message

Returns:

the saml sp message that was removed

Throws:

PortalException - if a saml sp message with the primary key could not be found

deleteSamlSpMessage

@Indexable(type=DELETE)
SamlSpMessage deleteSamlSpMessage(SamlSpMessage samlSpMessage)

Deletes the saml sp message from the database. Also notifies the appropriate model listeners.

Parameters:

samlSpMessage - the saml sp message

Returns:

the saml sp message that was removed

dynamicQuery

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

dynamicQuery

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

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> java.util.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 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.

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

fetchSamlSpMessage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpMessage fetchSamlSpMessage(long samlSpMessageId)

fetchSamlSpMessage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpMessage fetchSamlSpMessage(java.lang.String samlIdpEntityId,
                                                                                                    java.lang.String samlIdpResponseKey)

getActionableDynamicQuery

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

getIndexableActionableDynamicQuery

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

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getSamlSpMessage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpMessage getSamlSpMessage(long samlSpMessageId)
                                                                                           throws PortalException

Returns the saml sp message with the primary key.

Parameters:

samlSpMessageId - the primary key of the saml sp message

Returns:

the saml sp message

Throws:

PortalException - if a saml sp message with the primary key could not be found

getSamlSpMessage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpMessage getSamlSpMessage(java.lang.String samlIdpEntityId,
                                                                                                  java.lang.String samlIdpResponseKey)
                                                                                           throws PortalException

Throws:

PortalException

getSamlSpMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SamlSpMessage> getSamlSpMessages(int start,
                                                                                                                   int end)

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.

Parameters:

start - the lower bound of the range of saml sp messages

end - the upper bound of the range of saml sp messages (not inclusive)

Returns:

the range of saml sp messages

getSamlSpMessagesCount

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

Returns the number of saml sp messages.

Returns:

the number of saml sp messages

updateSamlSpMessage

@Indexable(type=REINDEX)
SamlSpMessage updateSamlSpMessage(SamlSpMessage samlSpMessage)

Updates the saml sp message in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

samlSpMessage - the saml sp message

Returns:

the saml sp message that was updated