org.apache.oodt.cas.catalog.system.impl

Class CatalogServiceClient

java.lang.Object

org.apache.oodt.cas.catalog.system.impl.CatalogServiceClient

All Implemented Interfaces:

CatalogService

public class CatalogServiceClient
extends Object
implements CatalogService

Version:

$Revision$

A Client that appears to be a CatalogService, but communicates with a CatalogService Server

Author:

bfoster

Field Summary

Fields

Modifier and Type	Field and Description
protected int	autoPagerSize
protected CommunicationChannelClient	communicationChannelClient

Fields inherited from interface org.apache.oodt.cas.catalog.system.CatalogService

CATALOG_ID_MET_KEY, CATALOG_IDS_MET_KEY, CATALOG_SERVICE_TRANSACTION_ID_MET_KEY, CATALOG_TRANSACTION_ID_MET_KEY, ENABLE_UPDATE_MET_KEY

Constructor Summary

Constructors

Constructor and Description
CatalogServiceClient(CommunicationChannelClient communicationChannelClient, int autoPagerSize)

Method Summary

Methods

Modifier and Type	Method and Description
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> urls)
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)
List<TransactionId<?>>	getTransactionIdsForAllPages(QueryPager queryPager)
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()
protected List<PluginURL>	transferToServerSide(List<PluginURL> clientSideUrls)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

communicationChannelClient

protected CommunicationChannelClient communicationChannelClient

autoPagerSize

protected int autoPagerSize

Constructor Detail

CatalogServiceClient

public CatalogServiceClient(CommunicationChannelClient communicationChannelClient,
                    int autoPagerSize)

Method Detail

shutdown

public void shutdown()
              throws CatalogServiceException

Specified by:

shutdown in interface CatalogService

Throws:

CatalogServiceException

transferToServerSide

protected List<PluginURL> transferToServerSide(List<PluginURL> clientSideUrls)
                                        throws CatalogServiceException

Throws:

CatalogServiceException

addCatalog

public void addCatalog(Catalog catalog)
                throws CatalogServiceException

Specified by:

addCatalog in interface CatalogService

Throws:

CatalogServiceException

replaceCatalog

public void replaceCatalog(Catalog catalog)
                    throws CatalogServiceException

Specified by:

replaceCatalog in interface CatalogService

Throws:

CatalogServiceException

addCatalog

public void addCatalog(String catalogId,
              Index index)
                throws CatalogServiceException

Specified by:

addCatalog in interface CatalogService

Throws:

CatalogServiceException

addCatalog

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

Specified by:

addCatalog in interface CatalogService

Throws:

CatalogServiceException

addCatalog

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

Specified by:

addCatalog in interface CatalogService

Throws:

CatalogServiceException

addDictionary

public void addDictionary(String catalogId,
                 Dictionary dictionary)
                   throws CatalogServiceException

Specified by:

addDictionary in interface CatalogService

Throws:

CatalogServiceException

replaceDictionaries

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

Specified by:

replaceDictionaries in interface CatalogService

Throws:

CatalogServiceException

modifyIngestPermission

public void modifyIngestPermission(String catalogId,
                          boolean restrictIngestPermission)
                            throws CatalogServiceException

Specified by:

modifyIngestPermission in interface CatalogService

Throws:

CatalogServiceException

modifyQueryPermission

public void modifyQueryPermission(String catalogId,
                         boolean restrictQueryPermission)
                           throws CatalogServiceException

Specified by:

modifyQueryPermission in interface CatalogService

Throws:

CatalogServiceException

replaceIndex

public void replaceIndex(String catalogId,
                Index index)
                  throws CatalogServiceException

Specified by:

replaceIndex in interface CatalogService

Throws:

CatalogServiceException

removeCatalog

public void removeCatalog(String catalogId)
                   throws CatalogServiceException

Specified by:

removeCatalog in interface CatalogService

Throws:

CatalogServiceException

getPluginStorageDir

public URL getPluginStorageDir()
                        throws CatalogServiceException

Specified by:

getPluginStorageDir in interface CatalogService

Throws:

CatalogServiceException

getPluginUrls

public List<PluginURL> getPluginUrls()
                              throws CatalogServiceException

Specified by:

getPluginUrls in interface CatalogService

Throws:

CatalogServiceException

addPluginUrls

public void addPluginUrls(List<PluginURL> urls)
                   throws CatalogServiceException

Specified by:

addPluginUrls in interface CatalogService

Throws:

CatalogServiceException

delete

public void delete(Metadata metadata)
            throws CatalogServiceException

Specified by:

delete in interface CatalogService

Throws:

CatalogServiceException

getAllPages

public List<TransactionalMetadata> getAllPages(QueryPager queryPager)
                                        throws CatalogServiceException

Specified by:

getAllPages in interface CatalogService

Throws:

CatalogServiceException

getCalalogProperties

public Properties getCalalogProperties()
                                throws CatalogServiceException

Specified by:

getCalalogProperties in interface CatalogService

Throws:

CatalogServiceException

getCalalogProperties

public Properties getCalalogProperties(String catalogUrn)
                                throws CatalogServiceException

Specified by:

getCalalogProperties in interface CatalogService

Throws:

CatalogServiceException

getCatalogServiceTransactionId

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

Specified by:

getCatalogServiceTransactionId in interface CatalogService

Throws:

CatalogServiceException

getCatalogServiceTransactionId

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

Specified by:

getCatalogServiceTransactionId in interface CatalogService

Throws:

CatalogServiceException

getCatalogServiceTransactionIds

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

Specified by:

getCatalogServiceTransactionIds in interface CatalogService

Throws:

CatalogServiceException

getCurrentCatalogIds

public Set<String> getCurrentCatalogIds()
                                 throws CatalogServiceException

Specified by:

getCurrentCatalogIds in interface CatalogService

Throws:

CatalogServiceException

getMetadataFromTransactionIdStrings

public List<TransactionalMetadata> getMetadataFromTransactionIdStrings(List<String> catalogServiceTransactionIdStrings)
                                                                throws CatalogServiceException

Specified by:

getMetadataFromTransactionIdStrings in interface CatalogService

Throws:

CatalogServiceException

getMetadataFromTransactionIds

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

Specified by:

getMetadataFromTransactionIds in interface CatalogService

Throws:

CatalogServiceException

getNextPage

public List<TransactionalMetadata> getNextPage(QueryPager queryPager)
                                        throws CatalogServiceException

Specified by:

getNextPage in interface CatalogService

Throws:

CatalogServiceException

getProperty

public List<String> getProperty(String key)
                         throws CatalogServiceException

Specified by:

getProperty in interface CatalogService

Throws:

CatalogServiceException

getTransactionIdsForAllPages

public List<TransactionId<?>> getTransactionIdsForAllPages(QueryPager queryPager)
                                                    throws CatalogServiceException

Throws:

CatalogServiceException

ingest

public TransactionReceipt ingest(Metadata metadata)
                          throws CatalogServiceException

Specified by:

ingest in interface CatalogService

Throws:

CatalogServiceException

isRestrictIngestPermissions

public boolean isRestrictIngestPermissions()
                                    throws CatalogServiceException

Specified by:

isRestrictIngestPermissions in interface CatalogService

Throws:

CatalogServiceException

isRestrictQueryPermissions

public boolean isRestrictQueryPermissions()
                                   throws CatalogServiceException

Specified by:

isRestrictQueryPermissions in interface CatalogService

Throws:

CatalogServiceException

getNextPage

public Page getNextPage(Page page)
                 throws CatalogServiceException

Specified by:

getNextPage in interface CatalogService

Throws:

CatalogServiceException

getPage

public Page getPage(PageInfo pageInfo,
           QueryExpression queryExpression)
             throws CatalogServiceException

Specified by:

getPage in interface CatalogService

Throws:

CatalogServiceException

getPage

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

Specified by:

getPage in interface CatalogService

Throws:

CatalogServiceException

getMetadata

public List<TransactionalMetadata> getMetadata(Page page)
                                        throws CatalogServiceException

Specified by:

getMetadata in interface CatalogService

Throws:

CatalogServiceException

query

public QueryPager query(QueryExpression queryExpression)
                 throws CatalogServiceException

Specified by:

query in interface CatalogService

Throws:

CatalogServiceException

query

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

Specified by:

query in interface CatalogService

Throws:

CatalogServiceException