Package io.goobi.viewer.managedbeans

Class AdminLicenseBean

java.lang.Object
io.goobi.viewer.managedbeans.AdminLicenseBean
All Implemented Interfaces:
Serializable
@Named @SessionScoped public class AdminLicenseBean extends Object implements Serializable
Administration backend functions.
See Also:

  • Constructor Details

    • AdminLicenseBean

      public AdminLicenseBean()
      Creates a new AdminBean instance.

  • Method Details

    • init

      @PostConstruct public void init()
      init.

    • getAllLicenseTypes

      public List<LicenseType> getAllLicenseTypes() throws DAOException
      Returns all existing license types. Required for admin tabs.
      Returns:
      all license types in the database
      Throws:
      DAOException - if any.

    • getGroupedLicenseTypeSelectItems

      public List<SelectItem> getGroupedLicenseTypeSelectItems() throws DAOException
      Returns:
      Two SelectItemGroups for core and regular license types
      Throws:
      DAOException

    • getAllCoreLicenseTypes

      public List<LicenseType> getAllCoreLicenseTypes() throws DAOException
      getAllCoreLicenseTypes.
      Returns:
      all license types in the database where core=true
      Throws:
      DAOException - if any.

    • getAllRecordLicenseTypes

      public List<LicenseType> getAllRecordLicenseTypes() throws DAOException
      getAllRecordLicenseTypes.
      Returns:
      all license types in the database where core=false
      Throws:
      DAOException - if any.

    • getOtherLicenseTypes

      public List<LicenseType> getOtherLicenseTypes() throws DAOException
      Returns all existing non-core license types minus currentLicenseType. Used for overriding license type selection.
      Returns:
      a list of all non-core license types excluding the currently selected one
      Throws:
      DAOException - if any.

    • saveCurrentLicenseTypeAction

      public String saveCurrentLicenseTypeAction() throws DAOException
      saveLicenseTypeAction.
      Returns:
      the navigation outcome after saving the current license type to the database
      Throws:
      DAOException - if any.

    • deleteLicenseTypeAction

      public String deleteLicenseTypeAction(LicenseType licenseType) throws DAOException
      deleteLicenseTypeAction.
      Parameters:
      licenseType - a LicenseType object.
      Returns:
      Navigation outcome
      Throws:
      DAOException - if any.

    • newCurrentLicenseTypeAction

      public void newCurrentLicenseTypeAction(String name)
      newCurrentLicenseTypeAction.
      Parameters:
      name - name to assign to the new license type

    • resetCurrentRoleLicenseAction

      public void resetCurrentRoleLicenseAction()
      resetCurrentRoleLicenseAction.

    • getAllLicenses

      public List<License> getAllLicenses() throws DAOException
      Throws:
      DAOException

    • isLicenseTypeInUse

      public boolean isLicenseTypeInUse(LicenseType licenseType) throws DAOException
      Parameters:
      licenseType - the license type to check for usage
      Returns:
      true if at least one license uses the given license type; false otherwise
      Throws:
      DAOException

    • getConcurrentViewsLimitRecordCountForLicenseType

      public long getConcurrentViewsLimitRecordCountForLicenseType(String licenseTypeName) throws IndexUnreachableException, PresentationException
      Parameters:
      licenseTypeName - name of the license type to query records for
      Returns:
      Number of records with the given licenseTypeName that have the ACCESSCONDITION_CONCURRENTUSE field
      Throws:
      IndexUnreachableException
      PresentationException

    • getPdfQuotaRecordCountForLicenseType

      public long getPdfQuotaRecordCountForLicenseType(String licenseTypeName) throws IndexUnreachableException, PresentationException
      Parameters:
      licenseTypeName - name of the license type to query records for
      Returns:
      Number of records with the given licenseTypeName that have the ACCESSCONDITION_PDF_PERCENTAGE_QUOTA field
      Throws:
      IndexUnreachableException
      PresentationException

    • getLicenses

      public List<License> getLicenses(LicenseType licenseType) throws DAOException
      Parameters:
      licenseType - the license type to retrieve licenses for
      Returns:
      Number of licenses with of given LicenseType
      Throws:
      DAOException

    • newCurrentLicenseAction

      public void newCurrentLicenseAction()
      Creates currentLicense to a new instance.

    • saveCurrentLicenseAction

      public String saveCurrentLicenseAction() throws DAOException, PresentationException
      Adds the current License to the licensee (User, UserGroup or IpRange). It is imperative that the licensee object is refreshed after updating so that a new license object is an ID attached. Otherwise the list of licenses will throw an NPE!
      Returns:
      Navigation outcome
      Throws:
      DAOException - if any.
      DAOException
      PresentationException

    • deleteLicenseAction

      public String deleteLicenseAction(License license) throws DAOException
      deleteLicenseAction.
      Parameters:
      license - a License object.
      Returns:
      the navigation outcome after deleting the given license from the database
      Throws:
      DAOException - if any.

    • getLazyModelTickets

      public TableDataProvider<AccessTicket> getLazyModelTickets()
      Getter for the field lazyModelTickets.
      Returns:
      the TableDataProvider used for paginated access ticket listing in the admin interface

    • getPageTickets

      public List<AccessTicket> getPageTickets()
      getPageTickets.
      Returns:
      a list of access tickets for the current page in the paginated ticket list

    • getTicketRequests

      public List<AccessTicket> getTicketRequests() throws DAOException
      Returns:
      List of existing tickets that are in request status
      Throws:
      DAOException

    • activateTicketAction

      public String activateTicketAction(AccessTicket ticket) throws DAOException
      Parameters:
      ticket - the access ticket to activate
      Returns:
      Navigation outcome
      Throws:
      DAOException

    • extendTicketAction

      public String extendTicketAction(AccessTicket ticket) throws DAOException
      Parameters:
      ticket - the access ticket to extend
      Returns:
      Navigation outcome
      Throws:
      DAOException

    • renewTicketAction

      public String renewTicketAction(AccessTicket ticket) throws DAOException
      Parameters:
      ticket - the access ticket to renew with a new password
      Returns:
      Navigation outcome
      Throws:
      DAOException

    • rejectTicketAction

      public String rejectTicketAction(AccessTicket ticket) throws DAOException
      Parameters:
      ticket - the access ticket request to reject and delete
      Returns:
      Navigation outcome
      Throws:
      DAOException

    • deleteTicketAction

      public String deleteTicketAction(AccessTicket ticket) throws DAOException
      Parameters:
      ticket - the access ticket to delete
      Returns:
      Navigation outcome
      Throws:
      DAOException

    • getCurrentRole

      public Role getCurrentRole()
      Getter for the field currentRole.
      Returns:
      the Role currently being edited in the license admin interface, or null if none selected

    • setCurrentRole

      public void setCurrentRole(Role currentRole)
      Setter for the field currentRole.
      Parameters:
      currentRole - the role currently being edited in the license admin interface

    • getCurrentLicenseType

      public LicenseType getCurrentLicenseType()
      Getter for the field currentLicenseType.
      Returns:
      the LicenseType currently being edited in the admin interface, or null if none selected

    • setCurrentLicenseType

      public void setCurrentLicenseType(LicenseType currentLicenseType)
      Setter for the field currentLicenseType.
      Parameters:
      currentLicenseType - the license type currently being edited in the admin interface

    • getCurrentLicenseTypeId

      public Long getCurrentLicenseTypeId()
      Returns the user ID of currentLicenseType.
      Returns:
      currentLicenseType.id if loaded and has ID; null if not

    • setCurrentLicenseTypeId

      public void setCurrentLicenseTypeId(Long id) throws DAOException
      Sets currentUserGroup by loading it from the DB via the given ID.
      Parameters:
      id - database ID of the license type to load
      Throws:
      DAOException

    • getCurrentLicense

      public License getCurrentLicense()
      Getter for the field currentLicense.
      Returns:
      the License currently being edited in the admin interface, or null if none selected

    • setCurrentLicense

      public void setCurrentLicense(License currentLicense)
      Setter for the field currentLicense.
      Parameters:
      currentLicense - the license currently being edited in the admin interface

    • getCurrentLicenseId

      public Long getCurrentLicenseId()
      Returns the user ID of currentLicense.
      Returns:
      currentLicense.id if loaded and has ID; null if not

    • setCurrentLicenseId

      public void setCurrentLicenseId(Long id) throws DAOException
      Sets currentLicense by loading it from the DB via the given ID.
      Parameters:
      id - database ID of the license to load
      Throws:
      DAOException

    • getSelectedLanguage

      public Locale getSelectedLanguage()

    • setSelectedLanguage

      public void setSelectedLanguage(Locale selectedLanguage)

    • getPossibleAccessConditions

      public List<String> getPossibleAccessConditions() throws DAOException, IndexUnreachableException, PresentationException
      Queries Solr for a list of all values of the set ACCESSCONDITION.
      Returns:
      Combined List of access condition values from the index and CMS pages
      Throws:
      DAOException
      IndexUnreachableException - if any.
      PresentationException - if any.

    • getNotConfiguredAccessConditions

      public List<String> getNotConfiguredAccessConditions() throws PresentationException, DAOException
      Returns:
      List of access condition values that have no corresponding license type in the database
      Throws:
      IndexUnreachableException
      PresentationException
      DAOException

    • getNumRecordsWithAccessCondition

      public long getNumRecordsWithAccessCondition(String accessCondition) throws DAOException, IndexUnreachableException, PresentationException
      Record count for non-configured access conditions.
      Parameters:
      accessCondition - access condition value to count records for
      Returns:
      Number of records containing the given access condition value
      Throws:
      DAOException
      PresentationException
      IndexUnreachableException

    • getRecordCountForLicenseType

      public long getRecordCountForLicenseType(LicenseType licenseType) throws DAOException, IndexUnreachableException, PresentationException
      Record count for configured access conditions.
      Parameters:
      licenseType - the license type whose record count to retrieve
      Returns:
      Number of records containing the given access condition value
      Throws:
      DAOException
      IndexUnreachableException
      PresentationException

    • getUrlQueryForAccessCondition

      public String getUrlQueryForAccessCondition(String accessCondition)
      Parameters:
      accessCondition - access condition value to generate a query for
      Returns:
      Generated query for given accessCondition

    • getCMSPagesUsingLicenseType

      public List<CMSPage> getCMSPagesUsingLicenseType(LicenseType licenseType) throws DAOException
      Parameters:
      licenseType - the license type whose access condition to search for in CMS pages
      Returns:
      List of CMSPages that have the access condition of the given LicenseType assigned
      Throws:
      DAOException

    • getMessageKeyForPrivilege

      public String getMessageKeyForPrivilege(String privilege)
      Parameters:
      privilege - privilege name to build a message key for
      Returns:
      Composite message key for the given privilege name

    • getAccessTypeValues

      public License.AccessType[] getAccessTypeValues()