RegistrationManager.java

package org.gbif.ipt.service.admin;

import org.gbif.doi.service.DoiService;
import org.gbif.ipt.model.Ipt;
import org.gbif.ipt.model.Organisation;
import org.gbif.ipt.service.AlreadyExistingException;
import org.gbif.ipt.service.DeletionNotAllowedException;
import org.gbif.ipt.service.InvalidConfigException;
import org.gbif.ipt.service.admin.impl.RegistrationManagerImpl;

import java.io.IOException;
import java.util.List;
import java.util.UUID;

import com.google.inject.ImplementedBy;

/**
 * This interface details ALL methods associated with the Organisations associated with the IPT.
 */
@ImplementedBy(RegistrationManagerImpl.class)
public interface RegistrationManager {

  /**
   * Associate a new organisation to this IPT installation, but doesnt persist the change.
   */
  Organisation addAssociatedOrganisation(Organisation organisation) throws AlreadyExistingException,
    InvalidConfigException;

  /**
   * Register the IPT against an existing organisation.
   */
  Organisation addHostingOrganisation(Organisation organisation);

  /**
   * Add all the IPT specific data.
   */
  void addIptInstance(Ipt ipt);

  /**
   * Delete an organisation. Will remove the specified organisation from the in memory list of organisations.
   * See save() to persist this change to files. In order to delete the organisation, the IPT cannot be registered
   * against it (it cannot be the hosting organisation), nor can there be any resource registered against it.
   *
   * @param key key of organisation to be deleted
   *
   * @return Organisation if it was not null and was deleted successfully, or null if it couldn't be found
   *
   * @throws DeletionNotAllowedException if the deletion was not allowed for some reason
   */
  Organisation delete(String key) throws DeletionNotAllowedException;

  /**
   * Returns a single organisation associated to the key, from list of organisations loaded into memory.
   *
   * @param key of organisation to be returned
   */
  Organisation get(String key);

  /**
   * Returns a single organisation associated to this UUID, from list of organisations loaded into memory.
   *
   * @param key of organisation to be returned
   */
  Organisation get(UUID key);

  /**
   * Returns a single organisation associated to the key, from disk.
   *
   * @param key of organisation to be returned
   */
  Organisation getFromDisk(String key);

  /**
   * Returns the hosting organisation of this IPT.
   */
  Organisation getHostingOrganisation();

  /**
   * Returns the IPT instance.
   *
   * @return ipt instance
   */
  Ipt getIpt();

  /**
   * Returns list of all organisations able to host resources.
   */
  List<Organisation> list();

  /**
   * Returns list of all associated organisations.
   */
  List<Organisation> listAll();

  /**
   * @return organisation associated to the IPT that has a DOI agency account that has been activated, null if none
   * found
   */
  Organisation findPrimaryDoiAgencyAccount();

  /**
   * Construct and return the appropriate DOI service depending on the type of DOI agency account that has been
   * activated in the IPT (DataCite or EZID only).
   *
   * @return the DataCite or EZID service capable of reserving, minting, deleting DOIs
   *
   * @throws InvalidConfigException if the DOI agency account has been badly configured
   */
  DoiService getDoiService() throws InvalidConfigException;

  /**
   * Loads all user associated organisations from file into the manager.
   */
  void load() throws InvalidConfigException;

  /**
   * Saves all organisations (associated to this IPT) from the manager to file. Needs to be manually called if
   * organisation properties have been modified or if organisations have been added or removed.
   */
  void save() throws IOException;

  /**
   * Migrate former registration (registration.xml) into new registration (registration2.xml) with passwords encrypted.
   */
  void encryptRegistration();
}