cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/lsid/LSIDAuthorityService.java

   1 // $Id$
   2 /**
   3  * Copyright (C) 2009 EDIT
   4  * European Distributed Institute of Taxonomy
   5  * http://www.e-taxonomy.eu
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version 1.1
   8  * See LICENSE.TXT at the top of this package for the full license terms.
   9  */
  10 package eu.etaxonomy.cdm.api.service.lsid;
  11
  12 import com.ibm.lsid.ExpiringResponse;
  13
  14
  15 import com.ibm.lsid.server.LSIDServerException;
  16 import com.ibm.lsid.server.LSIDService;
  17
  18 import eu.etaxonomy.cdm.model.common.LSID;
  19 import eu.etaxonomy.cdm.model.common.LSIDAuthority;
  20 /**
  21  * LSIDAuthorityService interface which was altered from com.ibm.lsid.server.LSIDAuthorityService,
  22  * replacing the LSIDRequestContext with a simple LSID. My thinking behind this is that provided the
  23  * LSIDAuthorityService has no responsibility for security, then there is no need to pass that
  24  * information to it (in an LSIDRequestContext). This allows better separation of concerns in that methods
  25  * requiring authentication and authorization can be secured transparently within CATE without the need for
  26  * the LSIDAuthorityService to know anything about it. I could be wrong, of course.
  27  *
  28  * @author Ben Szekely (<a href="mailto:bhszekel@us.ibm.com">bhszekel@us.ibm.com</a>)
  29  * @author ben
  30  *
  31  * @see com.ibm.lsid.server.LSIDAuthorityService
  32  * @see com.ibm.lsid.server.LSIDRequestContext
  33  */
  34 public interface LSIDAuthorityService extends LSIDService {
  35         /**
  36          * Get a WSDL document which describes the this authority
  37          * @return ExpiringResponse contains a Source object containing the WSDL document
  38          * @throws LSIDServerException
  39          *
  40          * @see javax.xml.transform.Source
  41          */
  42         public ExpiringResponse getAuthorityWSDL() throws LSIDServerException;
  43
  44         /**
  45          * Get the WSDL document that describes the methods that can be called on the given LSID
  46          * @param LSID the LSID to query
  47          * @return ExpiringResponse contains a Source object containing the WSDL document
  48          *
  49          * @see javax.xml.transform.Source
  50          */
  51         public ExpiringResponse getAvailableServices(LSID lsid) throws LSIDServerException;
  52
  53         /**
  54          * Add a known foreign authority to the metadata of an lsid
  55          * @param lsid
  56          * @param authorityName
  57          * @throws LSIDServerException
  58          */
  59         public void notifyForeignAuthority(LSID lsid, LSIDAuthority authorityName) throws LSIDServerException;
  60
  61
  62         /**
  63          * Remove a foreign authority registration from a specific lsid
  64          * @param lsid
  65          * @param authorityName
  66          * @throws LSIDServerException
  67          */
  68         public void revokeNotificationForeignAuthority(LSID lsid, LSIDAuthority authorityName) throws LSIDServerException;
  69 }