Package io.goobi.viewer.model.security

Class AccessPermission

java.lang.Object
io.goobi.viewer.model.security.AccessPermission
All Implemented Interfaces:
Serializable
public class AccessPermission extends Object implements Serializable
Access permission check outcome. Apart from access granted true/false status, additional attributes can be defined here.
See Also:

  • Constructor Details

    • AccessPermission

      public AccessPermission()

  • Method Details

    • denied

      public static AccessPermission denied()
      Returns:
      AccessPermission with denied status

    • granted

      public static AccessPermission granted()
      Returns:
      AccessPermission with granted status

    • checkSecondaryAccessRequirement

      public void checkSecondaryAccessRequirement(Set<String> useAccessConditions, String privilegeName, User sessionUser, IpRange sessionIpRange, ClientApplication client) throws PresentationException, IndexUnreachableException, DAOException
      Throws:
      PresentationException
      IndexUnreachableException
      DAOException

    • isGranted

      public boolean isGranted()

    • setGranted

      public AccessPermission setGranted(boolean granted)
      Parameters:
      granted - true if access is granted; false otherwise
      Returns:
      this

    • isAccessTicketRequired

      public boolean isAccessTicketRequired()

    • setAccessTicketRequired

      public AccessPermission setAccessTicketRequired(boolean accessTicketRequired)
      Parameters:
      accessTicketRequired - true if an access ticket must be presented to gain access; false otherwise
      Returns:
      this;

    • isDownloadTicketRequired

      public boolean isDownloadTicketRequired()

    • setDownloadTicketRequired

      public AccessPermission setDownloadTicketRequired(boolean downloadTicketRequired)
      Parameters:
      downloadTicketRequired - true if a download ticket must be presented to download content; false otherwise
      Returns:
      this

    • isRedirect

      public boolean isRedirect()

    • setRedirect

      public AccessPermission setRedirect(boolean redirect)
      Parameters:
      redirect - true if the user should be redirected instead of seeing a denial page; false otherwise
      Returns:
      this

    • getRedirectUrl

      public String getRedirectUrl()

    • setRedirectUrl

      public AccessPermission setRedirectUrl(String redirectUrl)
      Parameters:
      redirectUrl - the URL to redirect the user to when access is denied with redirect enabled
      Returns:
      this

    • getAccessDeniedPlaceholderInfo

      public Map<String,AccessDeniedInfoConfig> getAccessDeniedPlaceholderInfo()

    • setAccessDeniedPlaceholderInfo

      public AccessPermission setAccessDeniedPlaceholderInfo(Map<String,AccessDeniedInfoConfig> accessDeniedPlaceholderInfo)
      Parameters:
      accessDeniedPlaceholderInfo - map of language code to placeholder configuration shown when access is denied
      Returns:
      this

    • getAddionalCheckRequired

      public ILicensee getAddionalCheckRequired()

    • setAddionalCheckRequired

      public AccessPermission setAddionalCheckRequired(ILicensee addionalCheckRequired)
      Parameters:
      addionalCheckRequired - the licensee for which an additional access check must be performed
      Returns:
      this

    • toString

      public String toString()
      Overrides:
      toString in class Object