cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/lsid/LSIDMetadataService.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
  11 package eu.etaxonomy.cdm.api.service.lsid;
  12
  13 import com.ibm.lsid.server.LSIDServerException;
  14 import com.ibm.lsid.server.LSIDService;
  15
  16 import eu.etaxonomy.cdm.model.common.IIdentifiableEntity;
  17 import eu.etaxonomy.cdm.model.common.LSID;
  18 /**
 * LSIDMetadataService interface which was altered from com.ibm.lsid.server.LSIDMetadataService,
 * replacing the LSIDRequestContext with a simple LSID. My thinking behind this is that provided the 
 * LSIDMetadataService has no responsibility for security, then there is no need to pass that
 * information to it (in an LSIDRequestContext). This allows better separation of concerns in that methods
 * requiring authentication and authorization can be secured transparently within CATE without the need for 
 * the LSIDMetadataService to know anything about it. I could be wrong, of course.
 * 
 * @author Ben Szekely (<a href="mailto:bhszekel@us.ibm.com">bhszekel@us.ibm.com</a>)
 * @author ben
 *
 * @see com.ibm.lsid.server.LSIDMetadataService
 * @see com.ibm.lsid.server.LSIDRequestContext 
 */
  19 public interface LSIDMetadataService extends LSIDService {
  20         /**
  21          * Get the meta data associated with the LSID
  22          * @param LSIDContext lsid
  23          * @return an IdentifiableEntity, null if there is no metadata
  24          */
  25         public IIdentifiableEntity getMetadata(LSID lsid) throws LSIDServerException;
  26 }