org.apache.oodt.cas.catalog.system
Interface CatalogService

All Known Implementing Classes:
CatalogServiceClient, CatalogServiceLocal

public interface CatalogService

Version:
$Revision$

An interface for a Metadata Catalog Manager Service

Author:
bfoster

Field Summary
static String CATALOG_ID_MET_KEY
           
static String CATALOG_IDS_MET_KEY
           
static String CATALOG_SERVICE_TRANSACTION_ID_MET_KEY
           
static String CATALOG_TRANSACTION_ID_MET_KEY
           
static String ENABLE_UPDATE_MET_KEY
           
 
Method Summary
 void addCatalog(Catalog catalog)
           
 void addCatalog(String catalogId, Index index)
           
 void addCatalog(String catalogId, Index index, List<Dictionary> dictionaries)
           
 void addCatalog(String catalogId, Index index, List<Dictionary> dictionaries, boolean restrictQueryPermission, boolean restrictIngestPermission)
           
 void addDictionary(String catalogId, Dictionary dictionary)
           
 void addPluginUrls(List<PluginURL> pluginURLs)
           
 void delete(Metadata metadata)
           
 List<TransactionalMetadata> getAllPages(QueryPager queryPager)
           
 Properties getCalalogProperties()
           
 Properties getCalalogProperties(String catalogUrn)
           
 TransactionId<?> getCatalogServiceTransactionId(CatalogReceipt catalogReceipt, boolean generateNew)
           
 TransactionId<?> getCatalogServiceTransactionId(TransactionId<?> catalogTransactionId, String catalogUrn)
           
 List<TransactionId<?>> getCatalogServiceTransactionIds(List<TransactionId<?>> catalogTransactionIds, String catalogUrn)
           
 Set<String> getCurrentCatalogIds()
           
 List<TransactionalMetadata> getMetadata(Page page)
           
 List<TransactionalMetadata> getMetadataFromTransactionIds(List<TransactionId<?>> catalogServiceTransactionIds)
           
 List<TransactionalMetadata> getMetadataFromTransactionIdStrings(List<String> catalogServiceTransactionIdStrings)
           
 Page getNextPage(Page page)
           
 List<TransactionalMetadata> getNextPage(QueryPager queryPager)
           
 Page getPage(PageInfo pageInfo, QueryExpression queryExpression)
           
 Page getPage(PageInfo pageInfo, QueryExpression queryExpression, Set<String> catalogIds)
           
 URL getPluginStorageDir()
           
 List<PluginURL> getPluginUrls()
           
 List<String> getProperty(String key)
           
 TransactionReceipt ingest(Metadata metadata)
           
 boolean isRestrictIngestPermissions()
           
 boolean isRestrictQueryPermissions()
           
 void modifyIngestPermission(String catalogId, boolean restrictIngestPermission)
           
 void modifyQueryPermission(String catalogId, boolean restrictQueryPermission)
           
 QueryPager query(QueryExpression queryExpression)
           
 QueryPager query(QueryExpression queryExpression, Set<String> catalogIds)
           
 void removeCatalog(String catalogId)
           
 void replaceCatalog(Catalog catalog)
           
 void replaceDictionaries(String catalogId, List<Dictionary> dictionaries)
           
 void replaceIndex(String catalogId, Index index)
           
 void shutdown()
           
 

Field Detail

CATALOG_SERVICE_TRANSACTION_ID_MET_KEY

static final String CATALOG_SERVICE_TRANSACTION_ID_MET_KEY
See Also:
Constant Field Values

CATALOG_IDS_MET_KEY

static final String CATALOG_IDS_MET_KEY
See Also:
Constant Field Values

ENABLE_UPDATE_MET_KEY

static final String ENABLE_UPDATE_MET_KEY
See Also:
Constant Field Values

CATALOG_TRANSACTION_ID_MET_KEY

static final String CATALOG_TRANSACTION_ID_MET_KEY
See Also:
Constant Field Values

CATALOG_ID_MET_KEY

static final String CATALOG_ID_MET_KEY
See Also:
Constant Field Values
Method Detail

shutdown

void shutdown()
              throws CatalogServiceException
Throws:
CatalogServiceException

isRestrictQueryPermissions

boolean isRestrictQueryPermissions()
                                   throws CatalogServiceException
Throws:
CatalogServiceException

isRestrictIngestPermissions

boolean isRestrictIngestPermissions()
                                    throws CatalogServiceException
Throws:
CatalogServiceException

addCatalog

void addCatalog(Catalog catalog)
                throws CatalogServiceException
Throws:
CatalogServiceException

replaceCatalog

void replaceCatalog(Catalog catalog)
                    throws CatalogServiceException
Throws:
CatalogServiceException

addCatalog

void addCatalog(String catalogId,
                Index index)
                throws CatalogServiceException
Throws:
CatalogServiceException

addCatalog

void addCatalog(String catalogId,
                Index index,
                List<Dictionary> dictionaries)
                throws CatalogServiceException
Throws:
CatalogServiceException

addCatalog

void addCatalog(String catalogId,
                Index index,
                List<Dictionary> dictionaries,
                boolean restrictQueryPermission,
                boolean restrictIngestPermission)
                throws CatalogServiceException
Throws:
CatalogServiceException

addDictionary

void addDictionary(String catalogId,
                   Dictionary dictionary)
                   throws CatalogServiceException
Throws:
CatalogServiceException

replaceDictionaries

void replaceDictionaries(String catalogId,
                         List<Dictionary> dictionaries)
                         throws CatalogServiceException
Throws:
CatalogServiceException

replaceIndex

void replaceIndex(String catalogId,
                  Index index)
                  throws CatalogServiceException
Throws:
CatalogServiceException

modifyIngestPermission

void modifyIngestPermission(String catalogId,
                            boolean restrictIngestPermission)
                            throws CatalogServiceException
Throws:
CatalogServiceException

modifyQueryPermission

void modifyQueryPermission(String catalogId,
                           boolean restrictQueryPermission)
                           throws CatalogServiceException
Throws:
CatalogServiceException

removeCatalog

void removeCatalog(String catalogId)
                   throws CatalogServiceException
Throws:
CatalogServiceException

getPluginStorageDir

URL getPluginStorageDir()
                        throws CatalogServiceException
Throws:
CatalogServiceException

getPluginUrls

List<PluginURL> getPluginUrls()
                              throws CatalogServiceException
Throws:
CatalogServiceException

addPluginUrls

void addPluginUrls(List<PluginURL> pluginURLs)
                   throws CatalogServiceException
Throws:
CatalogServiceException

getCurrentCatalogIds

Set<String> getCurrentCatalogIds()
                                 throws CatalogServiceException
Throws:
CatalogServiceException

ingest

TransactionReceipt ingest(Metadata metadata)
                          throws CatalogServiceException
Throws:
CatalogServiceException

delete

void delete(Metadata metadata)
            throws CatalogServiceException
Throws:
CatalogServiceException

getProperty

List<String> getProperty(String key)
                         throws CatalogServiceException
Throws:
CatalogServiceException

getCalalogProperties

Properties getCalalogProperties()
                                throws CatalogServiceException
Throws:
CatalogServiceException

getCalalogProperties

Properties getCalalogProperties(String catalogUrn)
                                throws CatalogServiceException
Throws:
CatalogServiceException

getNextPage

Page getNextPage(Page page)
                 throws CatalogServiceException
Throws:
CatalogServiceException

getPage

Page getPage(PageInfo pageInfo,
             QueryExpression queryExpression)
             throws CatalogServiceException
Throws:
CatalogServiceException

getPage

Page getPage(PageInfo pageInfo,
             QueryExpression queryExpression,
             Set<String> catalogIds)
             throws CatalogServiceException
Throws:
CatalogServiceException

getMetadata

List<TransactionalMetadata> getMetadata(Page page)
                                        throws CatalogServiceException
Throws:
CatalogServiceException

query

QueryPager query(QueryExpression queryExpression)
                 throws CatalogServiceException
Throws:
CatalogServiceException

query

QueryPager query(QueryExpression queryExpression,
                 Set<String> catalogIds)
                 throws CatalogServiceException
Throws:
CatalogServiceException

getNextPage

List<TransactionalMetadata> getNextPage(QueryPager queryPager)
                                        throws CatalogServiceException
Throws:
CatalogServiceException

getAllPages

List<TransactionalMetadata> getAllPages(QueryPager queryPager)
                                        throws CatalogServiceException
Throws:
CatalogServiceException

getMetadataFromTransactionIdStrings

List<TransactionalMetadata> getMetadataFromTransactionIdStrings(List<String> catalogServiceTransactionIdStrings)
                                                                throws CatalogServiceException
Throws:
CatalogServiceException

getMetadataFromTransactionIds

List<TransactionalMetadata> getMetadataFromTransactionIds(List<TransactionId<?>> catalogServiceTransactionIds)
                                                          throws CatalogServiceException
Throws:
CatalogServiceException

getCatalogServiceTransactionIds

List<TransactionId<?>> getCatalogServiceTransactionIds(List<TransactionId<?>> catalogTransactionIds,
                                                       String catalogUrn)
                                                       throws CatalogServiceException
Throws:
CatalogServiceException

getCatalogServiceTransactionId

TransactionId<?> getCatalogServiceTransactionId(TransactionId<?> catalogTransactionId,
                                                String catalogUrn)
                                                throws CatalogServiceException
Throws:
CatalogServiceException

getCatalogServiceTransactionId

TransactionId<?> getCatalogServiceTransactionId(CatalogReceipt catalogReceipt,
                                                boolean generateNew)
                                                throws CatalogServiceException
Throws:
CatalogServiceException


Copyright © 1999-2013
Apache OODT. All Rights Reserved.