Interface IAuthorizationGuardPredicate<T,D>

All Superinterfaces:
IDataSetPredicate<D>
All Known Implementing Classes:
AbstractDataSetAccessPredicate, DataSetCodeStringPredicate, DataSetFileDTOPredicate, NewDataSetPredicate

public interface IAuthorizationGuardPredicate<T,D> extends IDataSetPredicate<D>
Interface for objects that can function as guardClasses in an AuthorizationGuard.

Predicates should return Status.OK if the user is authorized for the action; they should return a status with an appropriate error message if the user is not authorized.

This is an internal class. Do not use it as a user of the API.

  • Method Summary

    Modifier and Type
    Method
    Description
    ch.systemsx.cisd.common.exceptions.Status
    evaluate(T receiver, String sessionToken, D argument)
    Evaluate the predicate for the receiver object, sessionToken, and predicate argument.

    Methods inherited from interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v1.IDataSetPredicate

    getDataSetCodes
  • Method Details

    • evaluate

      ch.systemsx.cisd.common.exceptions.Status evaluate(T receiver, String sessionToken, D argument) throws ch.systemsx.cisd.common.exceptions.UserFailureException
      Evaluate the predicate for the receiver object, sessionToken, and predicate argument.
      Parameters:
      receiver - The object on which the guarded method was called
      sessionToken - A token identifying the user
      argument - The argument to the predicate
      Returns:
      Status.OK if the action is allowed, Status.createError() otherwise.
      Throws:
      ch.systemsx.cisd.common.exceptions.UserFailureException