Main Page | Class Hierarchy | Class List | File List | Class Members | Related Pages

glite::rgma::PrimaryProducer Class Reference

#include <PrimaryProducer.h>

Inheritance diagram for glite::rgma::PrimaryProducer:

glite::rgma::ResourceImpl glite::rgma::Resource glite::rgma::PrimaryProducerImpl List of all members.

Public Member Functions

virtual TimeInterval getHistoryRetentionPeriod (std::string tableName)=0
virtual TimeInterval getLatestRetentionPeriod (std::string tableName)=0 throw (RemoteException, UnknownResourceException, RGMAException)
virtual void declareTable (std::string tableName, std::string predicate, TimeInterval historyRetentionPeriod, TimeInterval latestRetentionPeriod)=0 throw (RemoteException, UnknownResourceException, RGMAException)
virtual void insert (std::string insertStatement)=0 throw (RemoteException, UnknownResourceException, RGMAException)
virtual void insert (std::string insertStatement, TimeInterval latestRetentionPeriod)=0 throw (RemoteException, UnknownResourceException, RGMAException)
virtual void insertList (StringList insertStatements)=0 throw (RemoteException, UnknownResourceException, RGMAException)
virtual void insertList (StringList insertStatements, TimeInterval latestRetentionPeriod)=0 throw (RemoteException, UnknownResourceException, RGMAException)

Static Public Member Functions

std::string getVersion () throw (RemoteException)
std::string getProperty (std::string name, std::string parameter) throw (RemoteException, RGMAException)
std::string getProperty (std::string name) throw (RemoteException, RGMAException)
void setProperty (std::string name, std::string value) throw (RemoteException, RGMAException)
void setProperty (std::string name, std::string value, std::string parameter) throw (RemoteException, RGMAException)
TupleStoreList listTupleStores () throw ( RemoteException, RGMAException)
void dropTupleStore (std::string logicalName) throw (RGMAException, RemoteException)

Detailed Description

A client uses a PrimaryProducer to publish information into R-GMA.


Member Function Documentation

virtual void glite::rgma::PrimaryProducer::declareTable std::string  tableName,
std::string  predicate,
TimeInterval  historyRetentionPeriod,
TimeInterval  latestRetentionPeriod
throw (RemoteException, UnknownResourceException, RGMAException) [pure virtual]
 

Declares a table, specifying the retention period for history and latest tuples. The latestRetentionPeriod specifies the time for which a latest tuple is valid. After this time, the tuple is removed. Tuples will be removed from storage when the history retention period expires.

Parameters:
tableName The name of the table to declare.
predicate An SQL WHERE clause defining the subset of a table that this Producer will publish. To publish to the whole table, an empty predicate can be used.
historyRetentionPeriod The retention period for history tuples
latestRetentionPeriod The retention period for latest tuples
Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the producer resource could not be found
RGMAException If the tableName is unknown. If the predicate is invalid. If either xxxRetentionPeriod is invalid.

Implemented in glite::rgma::PrimaryProducerImpl.

void glite::rgma::PrimaryProducer::dropTupleStore std::string  logicalName  )  throw (RGMAException, RemoteException) [static]
 

Permanently deletes a named tuple store.

Parameters:
logicalName Name of tuple store.
Exceptions:
RGMAException If the store does not exist or if it is in use by a producer. If no endpointReference is defined in properties.
RemoteException If the service could not be contacted.

virtual TimeInterval glite::rgma::PrimaryProducer::getHistoryRetentionPeriod std::string  tableName  )  [pure virtual]
 

Gets the retention period that is applied to history tuples for the specified table.

Parameters:
tableName Name of the table
Returns:
The retention period for history tuples.
Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the resource could not be found.
RGMAException If the table has not been declared.

Implemented in glite::rgma::PrimaryProducerImpl.

virtual TimeInterval glite::rgma::PrimaryProducer::getLatestRetentionPeriod std::string  tableName  )  throw (RemoteException, UnknownResourceException, RGMAException) [pure virtual]
 

Gets the retention period that is applied to latest tuples for the specified table.

Parameters:
tableName Name of the table
Returns:
The retention period for latest tuples.
Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the resource could not be found.
RGMAException If the table has not been declared.

Implemented in glite::rgma::PrimaryProducerImpl.

std::string glite::rgma::PrimaryProducer::getProperty std::string  name  )  throw (RemoteException, RGMAException) [static]
 

Gets the value of the specified service property.

Parameters:
name Name of property.
Returns:
Current value of property (can be NULL).
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the name/parameter combination is invalid.

std::string glite::rgma::PrimaryProducer::getProperty std::string  name,
std::string  parameter
throw (RemoteException, RGMAException) [static]
 

Gets the value of the specified service property.

Parameters:
name Name of property.
parameter Parameter to property
Returns:
Current value of property (can be NULL).
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the name/parameter combination is invalid.

std::string glite::rgma::PrimaryProducer::getVersion  )  throw (RemoteException) [static]
 

Gets the version of this implementation.

Returns:
The version number.
Exceptions:
RemoteException If the service could not be contacted.

virtual void glite::rgma::PrimaryProducer::insert std::string  insertStatement,
TimeInterval  latestRetentionPeriod
throw (RemoteException, UnknownResourceException, RGMAException) [pure virtual]
 

Publishes data by inserting a tuple into a table, both specified by the SQL INSERT statement.

Parameters:
insertStatement An SQL INSERT statement providing the data to publish and the table into which to put it.
latestRetentionPeriod Latest retention period for this tuple (overrides LRP defined for table).
Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the producer resource could not be found
RGMAException If the table in the insert has not been declared. If the inserted tuple does not match its table's declared predicate
See also:
insertList

insert

Implemented in glite::rgma::PrimaryProducerImpl.

virtual void glite::rgma::PrimaryProducer::insert std::string  insertStatement  )  throw (RemoteException, UnknownResourceException, RGMAException) [pure virtual]
 

Publishes data by inserting a tuple into a table, both specified by the SQL INSERT statement.

Parameters:
insertStatement An SQL INSERT statement providing the data to publish and the table into which to put it.
Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the producer resource could not be found
RGMAException If the table in the insert has not been declared. If the inserted tuple does not match its table's declared predicate
See also:
insertList

Implemented in glite::rgma::PrimaryProducerImpl.

virtual void glite::rgma::PrimaryProducer::insertList StringList  insertStatements,
TimeInterval  latestRetentionPeriod
throw (RemoteException, UnknownResourceException, RGMAException) [pure virtual]
 

Publishes using a list of SQL INSERT statements.

Parameters:
insertStatements A list of SQL INSERT statements.
latestRetentionPeriod the retention period for latest queries
Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the producer resource could not be found
RGMAException If the table in any insert has not been declared. If any inserted tuple does not match its table's declared predicate
See also:
insert

virtual void glite::rgma::PrimaryProducer::insertList StringList  insertStatements  )  throw (RemoteException, UnknownResourceException, RGMAException) [pure virtual]
 

Publishes using a list of SQL INSERT statements.

Parameters:
insertStatements A list of SQL INSERT statements.
Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the producer resource could not be found
RGMAException If the table in any insert has not been declared. If any inserted tuple does not match its table's declared predicate
See also:
insert

Implemented in glite::rgma::PrimaryProducerImpl.

TupleStoreList glite::rgma::PrimaryProducer::listTupleStores  )  throw ( RemoteException, RGMAException) [static]
 

Returns a list of existing tuple stores that can be used by Primary and Secondary Producers.

Returns:
A TupleStoreList object.
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If no endpointReference is defined in properties.

void glite::rgma::PrimaryProducer::setProperty std::string  name,
std::string  value,
std::string  parameter
throw (RemoteException, RGMAException) [static]
 

Changes the value of the specified service property.

Parameters:
name Name of property.
value New value of property.
parameter Parameter to property
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the name/parameter combination is invalid.

void glite::rgma::PrimaryProducer::setProperty std::string  name,
std::string  value
throw (RemoteException, RGMAException) [static]
 

Changes the value of the specified service property.

Parameters:
name Name of property.
value New value of property.
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the name/parameter combination is invalid.


The documentation for this class was generated from the following files:
Generated on Wed Apr 25 19:11:33 2007 for glite-rgma-api-cpp by doxygen 1.3.5