com.metamatrix.platform.config.persistence.api
Interface PersistentConnection

All Known Implementing Classes:

ExtensionModuleConnection, FilePersistentConnection

public interface PersistentConnection

Method Summary

void	close() call close when the connection is no longer needed.
void	commit()
void	delete(ConfigurationID configID, java.lang.String principal) Writes the collection of models to its persistent store based on the implementation of the persistent connection.
boolean	isClosed() call to determine is the connection is still available.
ConfigurationModelContainer	read(ConfigurationID configID) Returns an ConfigurationModelContainer based on how the implementation read configuation information
void	rollback()
void	write(ConfigurationModelContainer model, java.lang.String principal) Writes the model to its persistent store based on the implementation of the persistent connection.

Method Detail

close

void close()

call close when the connection is no longer needed. This resource will be cleaned up.

Throws:

ConfigurationException

isClosed

boolean isClosed()

call to determine is the connection is still available.

Returns:

boolean true if the connection is available

read

ConfigurationModelContainer read(ConfigurationID configID)
                                 throws ConfigurationException

Returns an ConfigurationModelContainer based on how the implementation read configuation information

Parameters:

configID - indicates which configuration to read

Returns:

ConfigurationModel

Throws:

ConfigurationException - if an error occurs

write

void write(ConfigurationModelContainer model,
           java.lang.String principal)
           throws ConfigurationException

Writes the model to its persistent store based on the implementation of the persistent connection.

Parameters:

model - to be writen to output

principal - is the user executing the write

Throws:

ConfigurationException - if an error occurs

delete

void delete(ConfigurationID configID,
            java.lang.String principal)
            throws ConfigurationException

Writes the collection of models to its persistent store based on the implementation of the persistent connection.

Parameters:

models - to be writen to output

principal - is the user executing the write

Throws:

ConfigurationException - if an error occurs

rollback

void rollback()
              throws ConfigurationException

Throws:

ConfigurationException

commit

void commit()
            throws ConfigurationException

Throws:

ConfigurationException