org.apache.oodt.cas.catalog.server.channel.xmlrpc
Class XmlRpcCommunicationChannelClient

java.lang.Object
  extended by org.apache.oodt.cas.catalog.server.channel.AbstractCommunicationChannelClient
      extended by org.apache.oodt.cas.catalog.server.channel.xmlrpc.XmlRpcCommunicationChannelClient
All Implemented Interfaces:
CommunicationChannelClient

public class XmlRpcCommunicationChannelClient
extends AbstractCommunicationChannelClient

Version:
$Revision$

A Communication Channel Client over XML-RPC

Author:
bfoster

Field Summary
protected  int chunkSize
           
protected  org.apache.xmlrpc.XmlRpcClient client
           
 
Fields inherited from class org.apache.oodt.cas.catalog.server.channel.AbstractCommunicationChannelClient
serializer
 
Constructor Summary
XmlRpcCommunicationChannelClient(URL serverUrl, int connectionTimeout, int requestTimeout, int chunkSize)
           
 
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()
           
 Page getFirstPage(QueryExpression queryExpression)
           
 Page getFirstPage(QueryExpression queryExpression, Set<String> catalogIds)
           
 Page getLastPage(QueryExpression queryExpression)
           
 Page getLastPage(QueryExpression queryExpression, Set<String> catalogIds)
           
 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)
           
 Class<? extends TransactionId<?>> getTransactionIdClass()
           
 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 catalogUrn)
           
 void replaceCatalog(Catalog catalog)
           
 void replaceDictionaries(String catalogId, List<Dictionary> dictionaries)
           
 void replaceIndex(String catalogId, Index index)
           
 void shutdown()
           
protected  void transferFile(String filePath, byte[] fileData, int offset, int numBytes)
           
 void transferUrl(URL fromUrl, URL toURL)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

client

protected org.apache.xmlrpc.XmlRpcClient client

chunkSize

protected int chunkSize
Constructor Detail

XmlRpcCommunicationChannelClient

public XmlRpcCommunicationChannelClient(URL serverUrl,
                                        int connectionTimeout,
                                        int requestTimeout,
                                        int chunkSize)
Method Detail

shutdown

public void shutdown()
              throws Exception
Throws:
Exception

addCatalog

public void addCatalog(Catalog catalog)
                throws Exception
Throws:
Exception

replaceCatalog

public void replaceCatalog(Catalog catalog)
                    throws Exception
Throws:
Exception

addCatalog

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

addCatalog

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

addCatalog

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

addDictionary

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

replaceDictionaries

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

replaceIndex

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

modifyIngestPermission

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

modifyQueryPermission

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

getPluginUrls

public List<PluginURL> getPluginUrls()
                              throws Exception
Throws:
Exception

addPluginUrls

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

getPluginStorageDir

public URL getPluginStorageDir()
                        throws Exception
Throws:
Exception

transferUrl

public void transferUrl(URL fromUrl,
                        URL toURL)
                 throws Exception
Throws:
Exception

transferFile

protected void transferFile(String filePath,
                            byte[] fileData,
                            int offset,
                            int numBytes)
                     throws Exception
Throws:
Exception

delete

public void delete(Metadata metadata)
            throws Exception
Throws:
Exception

getAllPages

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

getCalalogProperties

public Properties getCalalogProperties()
                                throws Exception
Throws:
Exception

getCalalogProperties

public Properties getCalalogProperties(String catalogUrn)
                                throws Exception
Throws:
Exception

getCatalogServiceTransactionId

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

getCatalogServiceTransactionId

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

getCatalogServiceTransactionIds

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

getCurrentCatalogIds

public Set<String> getCurrentCatalogIds()
                                 throws Exception
Throws:
Exception

getMetadataFromTransactionIdStrings

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

getMetadataFromTransactionIds

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

getNextPage

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

getProperty

public List<String> getProperty(String key)
                         throws Exception
Throws:
Exception

getTransactionIdClass

public Class<? extends TransactionId<?>> getTransactionIdClass()
                                                        throws Exception
Throws:
Exception

getTransactionIdsForAllPages

public List<TransactionId<?>> getTransactionIdsForAllPages(QueryPager queryPager)
                                                    throws Exception
Throws:
Exception

ingest

public TransactionReceipt ingest(Metadata metadata)
                          throws Exception
Throws:
Exception

isRestrictIngestPermissions

public boolean isRestrictIngestPermissions()
                                    throws Exception
Throws:
Exception

isRestrictQueryPermissions

public boolean isRestrictQueryPermissions()
                                   throws Exception
Throws:
Exception

getFirstPage

public Page getFirstPage(QueryExpression queryExpression)
                  throws Exception
Throws:
Exception

getFirstPage

public Page getFirstPage(QueryExpression queryExpression,
                         Set<String> catalogIds)
                  throws Exception
Throws:
Exception

getNextPage

public Page getNextPage(Page page)
                 throws Exception
Throws:
Exception

getPage

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

getPage

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

getLastPage

public Page getLastPage(QueryExpression queryExpression)
                 throws Exception
Throws:
Exception

getLastPage

public Page getLastPage(QueryExpression queryExpression,
                        Set<String> catalogIds)
                 throws Exception
Throws:
Exception

getMetadata

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

query

public QueryPager query(QueryExpression queryExpression)
                 throws Exception
Throws:
Exception

query

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

removeCatalog

public void removeCatalog(String catalogUrn)
                   throws Exception
Throws:
Exception


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