Interface SecurableBaseReadOnlyService<C extends Securable>

All Superinterfaces:

BaseReadOnlyService<C>

All Known Subinterfaces:

ArrayDesignService, BioAssayService, BioMaterialService, DifferentialExpressionAnalysisService, ExperimentalDesignService, ExperimentalFactorService, ExpressionExperimentService, ExpressionExperimentSetService, FactorValueService, GeneDiffExMetaAnalysisService, GeneSetService, ProtocolService, SecurableBaseImmutableService<C>, SecurableBaseService<C>, SecurableBaseVoEnabledService<C,VO>, SecurableFilteringVoEnabledService<C,VO>

All Known Implementing Classes:

ArrayDesignServiceImpl, BioAssayServiceImpl, BioMaterialServiceImpl, DifferentialExpressionAnalysisServiceImpl, ExperimentalDesignServiceImpl, ExperimentalFactorServiceImpl, ExpressionExperimentServiceImpl, ExpressionExperimentSetServiceImpl, FactorValueServiceImpl, GeneDiffExMetaAnalysisServiceImpl, GeneSetServiceImpl, ProtocolServiceImpl

public interface SecurableBaseReadOnlyService<C extends Securable>
extends BaseReadOnlyService<C>

Method Summary

Modifier and Type	Method	Description
C	find(C entity)
C	findOrFail(C entity)	Does a search for the entity in the persistent storage, raising a NullPointerException if not found.
C	load(Long id)
Collection<C>	load(Collection<Long> ids)
Collection<C>	loadAll()
C	loadOrFail(Long id)	Load an entity of fail with a NullPointerException if it does not exist in the persistent storage.
<T extends Exception> C	loadOrFail(Long id, Function<String,T> exceptionSupplier)	Load an entity or fail with the supplied exception if it does not exist in the persistent storage.
<T extends Exception> C	loadOrFail(Long id, Function<String,T> exceptionSupplier, String message)	Load an entity or fail with the supplied exception and message.
<T extends Exception> C	loadOrFail(Long id, Supplier<T> exceptionSupplier)	Load an entity or fail with the supplied exception if it does not exist in the persistent storage.
Stream<C>	streamAll()
Stream<C>	streamAll(boolean createNewSession)

Methods inherited from interface BaseReadOnlyService

countAll, getElementClass, loadOrFail, loadOrFail

Method Details

find

@Secured({"IS_AUTHENTICATED_ANONYMOUSLY","AFTER_ACL_READ_QUIET"})
C find(C entity)

Specified by:

find in interface BaseReadOnlyService<C extends Securable>

See Also:

• BaseDao.find(Identifiable)

findOrFail

@NonNull
@Secured("IS_AUTHENTICATED_ANONYMOUSLY")
@PostAuthorize("returnObject == null or hasPermission(returnObject, 'READ') or hasPermission(returnObject, 'ADMINISTRATION')")
C findOrFail(C entity)
      throws NullPointerException

Description copied from interface: BaseReadOnlyService

Does a search for the entity in the persistent storage, raising a NullPointerException if not found.

Specified by:

findOrFail in interface BaseReadOnlyService<C extends Securable>

Parameters:

entity - the entity to be searched for

Returns:

the version of entity retrieved from persistent storage

Throws:

NullPointerException - if the entity is not found

load

@Secured("IS_AUTHENTICATED_ANONYMOUSLY")
@PostFilter("hasPermission(filterObject, 'READ') or hasPermission(filterObject, 'ADMINISTRATION')")
Collection<C> load(Collection<Long> ids)

Specified by:

load in interface BaseReadOnlyService<C extends Securable>

See Also:

• BaseDao.load(Collection)

load

@Secured({"IS_AUTHENTICATED_ANONYMOUSLY","AFTER_ACL_READ_QUIET"})
C load(Long id)

Specified by:

load in interface BaseReadOnlyService<C extends Securable>

See Also:

• BaseDao.load(Long)

loadOrFail

@NonNull
@Secured("IS_AUTHENTICATED_ANONYMOUSLY")
@PostAuthorize("returnObject == null or hasPermission(returnObject, 'READ') or hasPermission(returnObject, 'ADMINISTRATION')")
C loadOrFail(Long id)
      throws NullPointerException

Description copied from interface: BaseReadOnlyService

Load an entity of fail with a NullPointerException if it does not exist in the persistent storage.

Specified by:

loadOrFail in interface BaseReadOnlyService<C extends Securable>

Parameters:

id - the ID used to retrieve the entity

Returns:

the entity as per BaseReadOnlyService.load(Long), never null

Throws:

NullPointerException - if the entity does not exist in the persistent storage

See Also:

• BaseReadOnlyService.load(Long)

loadOrFail

@NonNull
@Secured("IS_AUTHENTICATED_ANONYMOUSLY")
@PostAuthorize("returnObject == null or hasPermission(returnObject, 'READ') or hasPermission(returnObject, 'ADMINISTRATION')")
<T extends Exception> C loadOrFail(Long id,
 Supplier<T> exceptionSupplier)
                            throws T

Description copied from interface: BaseReadOnlyService

Load an entity or fail with the supplied exception if it does not exist in the persistent storage.

Specified by:

loadOrFail in interface BaseReadOnlyService<C extends Securable>

Throws:

T - if the entity does not exist in the persistent storage

See Also:

• BaseReadOnlyService.load(Long)

loadOrFail

@NonNull
@Secured("IS_AUTHENTICATED_ANONYMOUSLY")
@PostAuthorize("returnObject == null or hasPermission(returnObject, 'READ') or hasPermission(returnObject, 'ADMINISTRATION')")
<T extends Exception> C loadOrFail(Long id,
 Function<String,T> exceptionSupplier)
                            throws T

Description copied from interface: BaseReadOnlyService

Load an entity or fail with the supplied exception if it does not exist in the persistent storage.

The message is generated automatically.

Specified by:

loadOrFail in interface BaseReadOnlyService<C extends Securable>

Throws:

T - if the entity does not exist in the persistent storage

See Also:

• BaseReadOnlyService.load(Long)

loadOrFail

@NonNull
@Secured("IS_AUTHENTICATED_ANONYMOUSLY")
@PostAuthorize("returnObject == null or hasPermission(returnObject, 'READ') or hasPermission(returnObject, 'ADMINISTRATION')")
<T extends Exception> C loadOrFail(Long id,
 Function<String,T> exceptionSupplier,
 String message)
                            throws T

Description copied from interface: BaseReadOnlyService

Load an entity or fail with the supplied exception and message.

Specified by:

loadOrFail in interface BaseReadOnlyService<C extends Securable>

Throws:

T - if the entity does not exist in the persistent storage

See Also:

• BaseReadOnlyService.load(Long)

loadAll

@Secured("IS_AUTHENTICATED_ANONYMOUSLY")
@PostFilter("hasPermission(filterObject, 'READ') or hasPermission(filterObject, 'ADMINISTRATION')")
Collection<C> loadAll()

Specified by:

loadAll in interface BaseReadOnlyService<C extends Securable>

See Also:

• BaseDao.loadAll()

streamAll

@Secured({"IS_AUTHENTICATED_ANONYMOUSLY","AFTER_ACL_STREAM_READ"})
Stream<C> streamAll()

Specified by:

streamAll in interface BaseReadOnlyService<C extends Securable>

See Also:

• BaseDao.streamAll()

streamAll

@Secured({"IS_AUTHENTICATED_ANONYMOUSLY","AFTER_ACL_STREAM_READ"})
Stream<C> streamAll(boolean createNewSession)

Specified by:

streamAll in interface BaseReadOnlyService<C extends Securable>

See Also:

• BaseDao.streamAll(boolean)