pt.ist.fenixframework.backend
Interface BackEnd

All Known Implementing Classes:

InfinispanBackEnd, JVSTMMemBackEnd, MemBackEnd, OgmBackEnd

public interface BackEnd

Each concrete back end should implement this interface. The framework's core already provides a pt.ist.fenixframework.backend.mem.DefaultConfig with a minimal back end that implements a no-op TransactionManager.

Method Summary

<T extends DomainObject> T	fromOid(Object oid) Backend-specific method to get a DomainObject given its OID.
<T extends DomainObject> T	getDomainObject(String externalId)
DomainRoot	getDomainRoot()
String	getName() Get the unique name of this BackEnd.
TransactionManager	getTransactionManager()
void	shutdown() Perform any required operations for a successful shutdown of the BackEnd.

Method Detail

getName

String getName()

Get the unique name of this BackEnd. The String returned by this method should contain only valid characters in a filename (because it can be used for configuration by convention

See Also:

FenixFramework

getDomainRoot

DomainRoot getDomainRoot()

See Also:

FenixFramework.getDomainRoot()

getDomainObject

<T extends DomainObject> T getDomainObject(String externalId)

See Also:

FenixFramework.getDomainObject(String)

getTransactionManager

TransactionManager getTransactionManager()

See Also:

FenixFramework.getTransactionManager()

fromOid

<T extends DomainObject> T fromOid(Object oid)

Backend-specific method to get a DomainObject given its OID. Callers of this method are responsible for providing a valid OID.

Parameters:

oid - The backend-specific identifier of the object to get

shutdown

void shutdown()

Perform any required operations for a successful shutdown of the BackEnd. After invoking this method there is no guarantee that the Fenix Framework is able to provide any more services.