RmiCommunicationChannelClient (Apache OODT 0.7 API)

java.lang.Object
- java.rmi.server.RemoteObject
- - java.rmi.server.RemoteServer
  - - java.rmi.server.UnicastRemoteObject
    - - org.apache.oodt.cas.catalog.server.channel.rmi.RmiCommunicationChannelClient

All Implemented Interfaces:

Serializable, Remote, CommunicationChannelClient
```
public class RmiCommunicationChannelClient
extends UnicastRemoteObject
implements CommunicationChannelClient
```
Version:

$Revision$

Author:

bfoster

See Also:
Serialized Form

Field Summary
- Fields inherited from class java.rmi.server.RemoteObject
  ref

Constructor Summary

Constructors
Modifier Constructor and Description
protected RmiCommunicationChannelClient()

Constructors
Modifier	Constructor and Description
`protected`	`RmiCommunicationChannelClient()`

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> 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)`
`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()`
`void`	`transferUrl(URL fromUrl, URL toUrl)`

Methods inherited from class java.rmi.server.UnicastRemoteObject
clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject
equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RmiCommunicationChannelClient

protected RmiCommunicationChannelClient()
                                 throws RemoteException

Throws:: RemoteException

Method Detail

addCatalog
```
public void addCatalog(Catalog catalog)
                throws Exception
```
Specified by:

addCatalog in interface CommunicationChannelClient

Throws:

Exception

addCatalog

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

Specified by:: addCatalog in interface CommunicationChannelClient
Throws:: Exception

addCatalog

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

Specified by:: addCatalog in interface CommunicationChannelClient
Throws:: Exception

addCatalog

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

Specified by:: addCatalog in interface CommunicationChannelClient
Throws:: Exception

addDictionary

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

Specified by:: addDictionary in interface CommunicationChannelClient
Throws:: Exception

addPluginUrls

public void addPluginUrls(List<PluginURL> pluginUrls)
                   throws Exception

Specified by:: addPluginUrls in interface CommunicationChannelClient
Throws:: Exception

delete
```
public void delete(Metadata metadata)
            throws Exception
```
Specified by:

delete in interface CommunicationChannelClient

Throws:

Exception

getAllPages

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

Specified by:: getAllPages in interface CommunicationChannelClient
Throws:: Exception

getCalalogProperties
```
public Properties getCalalogProperties()
                                throws Exception
```
Specified by:

getCalalogProperties in interface CommunicationChannelClient

Throws:

Exception

getCalalogProperties

public Properties getCalalogProperties(String catalogUrn)
                                throws Exception

Specified by:: getCalalogProperties in interface CommunicationChannelClient
Throws:: Exception

getCatalogServiceTransactionId

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

Specified by:: getCatalogServiceTransactionId in interface CommunicationChannelClient
Throws:: Exception

getCatalogServiceTransactionId

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

Specified by:: getCatalogServiceTransactionId in interface CommunicationChannelClient
Throws:: Exception

getCatalogServiceTransactionIds

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

Specified by:: getCatalogServiceTransactionIds in interface CommunicationChannelClient
Throws:: Exception

getCurrentCatalogIds
```
public Set<String> getCurrentCatalogIds()
                                 throws Exception
```
Specified by:

getCurrentCatalogIds in interface CommunicationChannelClient

Throws:

Exception

getMetadata

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

Specified by:: getMetadata in interface CommunicationChannelClient
Throws:: Exception

getMetadataFromTransactionIdStrings

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

Specified by:: getMetadataFromTransactionIdStrings in interface CommunicationChannelClient
Throws:: Exception

getMetadataFromTransactionIds

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

Specified by:: getMetadataFromTransactionIds in interface CommunicationChannelClient
Throws:: Exception

getNextPage
```
public Page getNextPage(Page page)
                 throws Exception
```
Specified by:

getNextPage in interface CommunicationChannelClient

Throws:

Exception

getNextPage

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

Specified by:: getNextPage in interface CommunicationChannelClient
Throws:: Exception

getPage

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

Specified by:: getPage in interface CommunicationChannelClient
Throws:: Exception

getPage

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

Specified by:: getPage in interface CommunicationChannelClient
Throws:: Exception

getPluginStorageDir
```
public URL getPluginStorageDir()
                        throws Exception
```
Specified by:

getPluginStorageDir in interface CommunicationChannelClient

Throws:

Exception

getPluginUrls
```
public List<PluginURL> getPluginUrls()
                              throws Exception
```
Specified by:

getPluginUrls in interface CommunicationChannelClient

Throws:

Exception

getProperty

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

Specified by:: getProperty in interface CommunicationChannelClient
Throws:: Exception

getTransactionIdsForAllPages

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

Specified by:: getTransactionIdsForAllPages in interface CommunicationChannelClient
Throws:: Exception

ingest

public TransactionReceipt ingest(Metadata metadata)
                          throws Exception

Specified by:: ingest in interface CommunicationChannelClient
Throws:: Exception

isRestrictIngestPermissions
```
public boolean isRestrictIngestPermissions()
                                    throws Exception
```
Specified by:

isRestrictIngestPermissions in interface CommunicationChannelClient

Throws:

Exception

isRestrictQueryPermissions
```
public boolean isRestrictQueryPermissions()
                                   throws Exception
```
Specified by:

isRestrictQueryPermissions in interface CommunicationChannelClient

Throws:

Exception

modifyIngestPermission

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

Specified by:: modifyIngestPermission in interface CommunicationChannelClient
Throws:: Exception

modifyQueryPermission

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

Specified by:: modifyQueryPermission in interface CommunicationChannelClient
Throws:: Exception

query

public QueryPager query(QueryExpression queryExpression)
                 throws Exception

Specified by:: query in interface CommunicationChannelClient
Throws:: Exception

query

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

Specified by:: query in interface CommunicationChannelClient
Throws:: Exception

removeCatalog
```
public void removeCatalog(String catalogUrn)
                   throws Exception
```
Specified by:

removeCatalog in interface CommunicationChannelClient

Throws:

Exception

replaceCatalog
```
public void replaceCatalog(Catalog catalog)
                    throws Exception
```
Specified by:

replaceCatalog in interface CommunicationChannelClient

Throws:

Exception

replaceDictionaries

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

Specified by:: replaceDictionaries in interface CommunicationChannelClient
Throws:: Exception

replaceIndex

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

Specified by:: replaceIndex in interface CommunicationChannelClient
Throws:: Exception

shutdown
```
public void shutdown()
              throws Exception
```
Specified by:

shutdown in interface CommunicationChannelClient

Throws:

Exception

transferUrl

public void transferUrl(URL fromUrl,
               URL toUrl)
                 throws Exception

Specified by:: transferUrl in interface CommunicationChannelClient
Throws:: Exception

Class RmiCommunicationChannelClient

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

Constructor Summary

Method Summary

Methods inherited from class java.rmi.server.UnicastRemoteObject

Methods inherited from class java.rmi.server.RemoteServer

Methods inherited from class java.rmi.server.RemoteObject

Methods inherited from class java.lang.Object

Constructor Detail

RmiCommunicationChannelClient

Method Detail

addCatalog

addCatalog

addCatalog

addCatalog

addDictionary

addPluginUrls

delete

getAllPages

getCalalogProperties

getCalalogProperties

getCatalogServiceTransactionId

getCatalogServiceTransactionId

getCatalogServiceTransactionIds

getCurrentCatalogIds

getMetadata

getMetadataFromTransactionIdStrings

getMetadataFromTransactionIds

getNextPage

getNextPage

getPage

getPage

getPluginStorageDir

getPluginUrls

getProperty

getTransactionIdsForAllPages

ingest

isRestrictIngestPermissions

isRestrictQueryPermissions

modifyIngestPermission

modifyQueryPermission

query

query

removeCatalog

replaceCatalog

replaceDictionaries

replaceIndex

shutdown

transferUrl