com.liferay.saml.persistence.service

Interface SamlSpIdpConnectionLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

SamlSpIdpConnectionLocalServiceWrapper

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

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

SamlSpIdpConnectionLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
SamlSpIdpConnection	addSamlSpIdpConnection(SamlSpIdpConnection samlSpIdpConnection) Adds the saml sp idp connection to the database.
SamlSpIdpConnection	addSamlSpIdpConnection(java.lang.String samlIdpEntityId, boolean assertionSignatureRequired, long clockSkew, boolean enabled, boolean forceAuthn, boolean ldapImportEnabled, java.lang.String metadataUrl, java.io.InputStream metadataXmlInputStream, java.lang.String name, java.lang.String nameIdFormat, boolean signAuthnRequest, java.lang.String userAttributeMappings, ServiceContext serviceContext)
SamlSpIdpConnection	createSamlSpIdpConnection(long samlSpIdpConnectionId) Creates a new saml sp idp connection with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
SamlSpIdpConnection	deleteSamlSpIdpConnection(long samlSpIdpConnectionId) Deletes the saml sp idp connection with the primary key from the database.
SamlSpIdpConnection	deleteSamlSpIdpConnection(SamlSpIdpConnection samlSpIdpConnection) Deletes the saml sp idp connection 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.
SamlSpIdpConnection	fetchSamlSpIdpConnection(long samlSpIdpConnectionId)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
SamlSpIdpConnection	getSamlSpIdpConnection(long samlSpIdpConnectionId) Returns the saml sp idp connection with the primary key.
SamlSpIdpConnection	getSamlSpIdpConnection(long companyId, java.lang.String samlIdpEntityId)
java.util.List<SamlSpIdpConnection>	getSamlSpIdpConnections(int start, int end) Returns a range of all the saml sp idp connections.
java.util.List<SamlSpIdpConnection>	getSamlSpIdpConnections(long companyId)
java.util.List<SamlSpIdpConnection>	getSamlSpIdpConnections(long companyId, int start, int end)
java.util.List<SamlSpIdpConnection>	getSamlSpIdpConnections(long companyId, int start, int end, OrderByComparator orderByComparator)
int	getSamlSpIdpConnectionsCount() Returns the number of saml sp idp connections.
int	getSamlSpIdpConnectionsCount(long companyId)
void	updateMetadata(long samlSpIdpConnectionId)
SamlSpIdpConnection	updateSamlSpIdpConnection(long samlSpIdpConnectionId, java.lang.String samlIdpEntityId, boolean assertionSignatureRequired, long clockSkew, boolean enabled, boolean forceAuthn, boolean ldapImportEnabled, java.lang.String metadataUrl, java.io.InputStream metadataXmlInputStream, java.lang.String name, java.lang.String nameIdFormat, boolean signAuthnRequest, java.lang.String userAttributeMappings, ServiceContext serviceContext)
SamlSpIdpConnection	updateSamlSpIdpConnection(SamlSpIdpConnection samlSpIdpConnection) Updates the saml sp idp connection in the database or adds it if it does not yet exist.

Method Detail

addSamlSpIdpConnection

@Indexable(type=REINDEX)
SamlSpIdpConnection addSamlSpIdpConnection(SamlSpIdpConnection samlSpIdpConnection)

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

Parameters:

samlSpIdpConnection - the saml sp idp connection

Returns:

the saml sp idp connection that was added

addSamlSpIdpConnection

SamlSpIdpConnection addSamlSpIdpConnection(java.lang.String samlIdpEntityId,
                                           boolean assertionSignatureRequired,
                                           long clockSkew,
                                           boolean enabled,
                                           boolean forceAuthn,
                                           boolean ldapImportEnabled,
                                           java.lang.String metadataUrl,
                                           java.io.InputStream metadataXmlInputStream,
                                           java.lang.String name,
                                           java.lang.String nameIdFormat,
                                           boolean signAuthnRequest,
                                           java.lang.String userAttributeMappings,
                                           ServiceContext serviceContext)
                                    throws PortalException

Throws:

PortalException

createSamlSpIdpConnection

@Transactional(enabled=false)
SamlSpIdpConnection createSamlSpIdpConnection(long samlSpIdpConnectionId)

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

Parameters:

samlSpIdpConnectionId - the primary key for the new saml sp idp connection

Returns:

the new saml sp idp connection

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteSamlSpIdpConnection

@Indexable(type=DELETE)
SamlSpIdpConnection deleteSamlSpIdpConnection(long samlSpIdpConnectionId)
                                                               throws PortalException

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

Parameters:

samlSpIdpConnectionId - the primary key of the saml sp idp connection

Returns:

the saml sp idp connection that was removed

Throws:

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

deleteSamlSpIdpConnection

@Indexable(type=DELETE)
SamlSpIdpConnection deleteSamlSpIdpConnection(SamlSpIdpConnection samlSpIdpConnection)

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

Parameters:

samlSpIdpConnection - the saml sp idp connection

Returns:

the saml sp idp connection 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.SamlSpIdpConnectionModelImpl.

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.SamlSpIdpConnectionModelImpl.

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

fetchSamlSpIdpConnection

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpIdpConnection fetchSamlSpIdpConnection(long samlSpIdpConnectionId)

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

getSamlSpIdpConnection

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpIdpConnection getSamlSpIdpConnection(long samlSpIdpConnectionId)
                                                                                                       throws PortalException

Returns the saml sp idp connection with the primary key.

Parameters:

samlSpIdpConnectionId - the primary key of the saml sp idp connection

Returns:

the saml sp idp connection

Throws:

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

getSamlSpIdpConnection

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SamlSpIdpConnection getSamlSpIdpConnection(long companyId,
                                                                                                              java.lang.String samlIdpEntityId)
                                                                                                       throws PortalException

Throws:

PortalException

getSamlSpIdpConnections

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

Returns a range of all the saml sp idp connections.

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.SamlSpIdpConnectionModelImpl.

Parameters:

start - the lower bound of the range of saml sp idp connections

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

Returns:

the range of saml sp idp connections

getSamlSpIdpConnections

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SamlSpIdpConnection> getSamlSpIdpConnections(long companyId)

getSamlSpIdpConnections

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SamlSpIdpConnection> getSamlSpIdpConnections(long companyId,
                                                                                                                               int start,
                                                                                                                               int end)

getSamlSpIdpConnections

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SamlSpIdpConnection> getSamlSpIdpConnections(long companyId,
                                                                                                                               int start,
                                                                                                                               int end,
                                                                                                                               OrderByComparator orderByComparator)

getSamlSpIdpConnectionsCount

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

Returns the number of saml sp idp connections.

Returns:

the number of saml sp idp connections

getSamlSpIdpConnectionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSamlSpIdpConnectionsCount(long companyId)

updateMetadata

void updateMetadata(long samlSpIdpConnectionId)
             throws PortalException

Throws:

PortalException

updateSamlSpIdpConnection

SamlSpIdpConnection updateSamlSpIdpConnection(long samlSpIdpConnectionId,
                                              java.lang.String samlIdpEntityId,
                                              boolean assertionSignatureRequired,
                                              long clockSkew,
                                              boolean enabled,
                                              boolean forceAuthn,
                                              boolean ldapImportEnabled,
                                              java.lang.String metadataUrl,
                                              java.io.InputStream metadataXmlInputStream,
                                              java.lang.String name,
                                              java.lang.String nameIdFormat,
                                              boolean signAuthnRequest,
                                              java.lang.String userAttributeMappings,
                                              ServiceContext serviceContext)
                                       throws PortalException

Throws:

PortalException

updateSamlSpIdpConnection

@Indexable(type=REINDEX)
SamlSpIdpConnection updateSamlSpIdpConnection(SamlSpIdpConnection samlSpIdpConnection)

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

Parameters:

samlSpIdpConnection - the saml sp idp connection

Returns:

the saml sp idp connection that was updated