org.brandao.brcache.tx

Class TXCache

java.lang.Object

org.brandao.brcache.StreamCache

org.brandao.brcache.BasicCache

org.brandao.brcache.Cache

org.brandao.brcache.tx.TXCache

All Implemented Interfaces:

Serializable

public class TXCache
extends Cache
implements Serializable

Provê suporte transacional a um cache.

 ex:
 
    Cache cache = ...;
    TXCache txCache = cache.getTXCache();
    CacheTransaction tx = txCache.beginTransaction();
    
    try{
        cache.put("chave1", objeto1, 0, 0);
        cache.remove("chave2");
        cache.putIfAbsent("chave3", objeto3, 0, 0);
        tx.commit();
    }
    catch(Throwable e){
        tx.rollback();
    }
 

Author:

Brandao

See Also:

Serialized Form

Field Summary

Fields inherited from class org.brandao.brcache.Cache

locks

Fields inherited from class org.brandao.brcache.BasicCache

config

Constructor Summary

Constructors

Constructor and Description
TXCache(BasicCache cache) Cria um cache transacional a partir de um cache.
TXCache(BasicCache cache, CacheTransactionManager transactionManager) Cria um cache transacional especificando o gestor transacional.

Method Summary

Methods

Modifier and Type	Method and Description
CacheTransaction	beginTransaction() Inicia uma transação.
Object	get(String key) Obtém o valor associado à chave.
Object	get(String key, boolean forUpdate) Obtém o valor associado à chave bloqueando ou não seu acesso as demais transações.
long	getCountRead() Obtém a quantidade de itens recuperados.
long	getCountReadData() Obtém a quantidade de bytes recuperados.
long	getCountRemoved() Obtém a quantidade de itens removidos.
long	getCountRemovedData() Obtém a quantidade de bytes removidos.
long	getCountWrite() Obtém a quantidade de itens armazenados.
long	getCountWriteData() Obtém a quantidade de bytes armazenados.
InputStream	getStream(String key) Obtém o fluxo de bytes do valor associado à chave.
InputStream	getStream(String key, boolean forUpdate) Obtém o fluxo de bytes do valor associado à chave bloqueando ou não seu acesso as demais transações.
CacheTransactionManager	getTransactionManager() Obtém o gestor transacional.
long	getTransactionTimeout() Obtém o tempo limite de uma operação.
protected void	init(long nodeBufferSize, long nodePageSize, double nodeSwapFactor, long indexBufferSize, long indexPageSize, double indexSwapFactor, long dataBufferSize, long dataPageSize, long blockSize, double dataSwapFactor, long maxSizeEntry, int maxSizeKey, Swapper swapper, int quantitySwaperThread, Memory memory) Inicia o cache.
boolean	put(String key, Object value, long timeToLive, long timeToIdle) Associa o valor à chave.
Object	putIfAbsent(String key, Object value, long timeToLive, long timeToIdle) Associa o valor a chave somente se a chave não estiver associada a um valor.
InputStream	putIfAbsentStream(String key, InputStream inputData, long timeToLive, long timeToIdle) Associa o fluxo de bytes do valor à chave somente se a chave não estiver associada a um valor.
boolean	putStream(String key, InputStream inputData, long timeToLive, long timeToIdle) Associa o fluxo de bytes do valor à chave.
boolean	remove(String key) Remove o valor associado à chave.
boolean	remove(String key, Object value) Remove o valor assoiado à chave somente se ele for igual a um determinado valor.
boolean	replace(String key, Object value, long timeToLive, long timeToIdle) Substitui o valor associado à chave somente se ele existir.
boolean	replace(String key, Object oldValue, Object newValue, long timeToLive, long timeToIdle) Substitui o valor associado à chave somente se ele for igual a um determinado valor.
boolean	replaceStream(String key, InputStream inputData, long timeToLive, long timeToIdle) Substitui o fluxo de bytes associado à chave somente se ele existir.
void	setDeleteOnExit(boolean deleteOnExit) Define que os arquivos contidos na pasta de dados sejam destruidos junto com essa instância.
void	setTransactionTimeout(long transactionTimeout) Define o tempo limite de uma operação.

Methods inherited from class org.brandao.brcache.Cache

containsKey, isEmpty, size

Methods inherited from class org.brandao.brcache.BasicCache

getConfig, getTXCache, getTXCache

Methods inherited from class org.brandao.brcache.StreamCache

clear, destroy, finalize, isDeleteOnExit, removeStream

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TXCache

public TXCache(BasicCache cache)

Cria um cache transacional a partir de um cache.

Parameters:

cache - cache não transacional.

TXCache

public TXCache(BasicCache cache,
       CacheTransactionManager transactionManager)

Cria um cache transacional especificando o gestor transacional.

Parameters:

cache - cache não transacional.

transactionManager - gestor transacional.

Method Detail

init

protected void init(long nodeBufferSize,
        long nodePageSize,
        double nodeSwapFactor,
        long indexBufferSize,
        long indexPageSize,
        double indexSwapFactor,
        long dataBufferSize,
        long dataPageSize,
        long blockSize,
        double dataSwapFactor,
        long maxSizeEntry,
        int maxSizeKey,
        Swapper swapper,
        int quantitySwaperThread,
        Memory memory)

Description copied from class: StreamCache

Inicia o cache.

Overrides:

init in class StreamCache

Parameters:

nodeBufferSize - Tamanho do buffer, em bytes, onde os nós ficarão armazenados.

nodePageSize - Tamanho da página, em bytes, do buffer de nós.

nodeSwapFactor - Fator de permuta dos nós.

indexBufferSize - Tamanho do buffer, em bytes, onde os índices ficarão armazenados.

indexPageSize - Tamanho da página, em bytes, do buffer de índices.

indexSwapFactor - Fator de permuta dos índices.

dataBufferSize - Tamanho do buffer, em bytes, onde os dados ficarão armazenados.

dataPageSize - Tamanho da página, em bytes, do buffer de dados.

blockSize - Tamanho do bloco, em bytes.

dataSwapFactor - Fator de permuta dos dados.

maxSizeEntry - Tamanho máximo de uma entrada no cache.

maxSizeKey - Tamanho máximo de uma chave.

swapper - Estratégia de troca dos dados entre a memória e outro dispositivo.

quantitySwaperThread - Quantidade de processos usados para fazer a permuta.

memory - Acesso à memória.

setDeleteOnExit

public void setDeleteOnExit(boolean deleteOnExit)

Description copied from class: StreamCache

Define que os arquivos contidos na pasta de dados sejam destruidos junto com essa instância.

Overrides:

setDeleteOnExit in class StreamCache

Parameters:

deleteOnExit - true para destruir todos os arquivos. Caso contrário, false.

getTransactionManager

public CacheTransactionManager getTransactionManager()

Obtém o gestor transacional.

Returns:

gestor transacional.

getTransactionTimeout

public long getTransactionTimeout()

Obtém o tempo limite de uma operação.

Returns:

tempo em milisegundos.

setTransactionTimeout

public void setTransactionTimeout(long transactionTimeout)

Define o tempo limite de uma operação.

Parameters:

transactionTimeout - tempo em milisegundos.

beginTransaction

public CacheTransaction beginTransaction()

Inicia uma transação.

Returns:

transação.

replace

public boolean replace(String key,
              Object value,
              long timeToLive,
              long timeToIdle)
                throws StorageException

Substitui o valor associado à chave somente se ele existir.

Overrides:

replace in class Cache

Parameters:

key - chave associada ao valor.

value - valor para ser associado à chave.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

Returns:

o valor anterior associado à chave.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

replaceStream

public boolean replaceStream(String key,
                    InputStream inputData,
                    long timeToLive,
                    long timeToIdle)
                      throws StorageException

Substitui o fluxo de bytes associado à chave somente se ele existir.

Overrides:

replaceStream in class Cache

Parameters:

key - chave associada ao valor.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

inputData - fluxo de bytes do valor.

Returns:

true se o valor for substituido. Caso contrário, false.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

replace

public boolean replace(String key,
              Object oldValue,
              Object newValue,
              long timeToLive,
              long timeToIdle)
                throws StorageException

Substitui o valor associado à chave somente se ele for igual a um determinado valor.

Overrides:

replace in class Cache

Parameters:

key - chave associada ao valor.

oldValue - valor esperado associado à chave.

newValue - valor para ser associado à chave.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

Returns:

true se o valor for substituido. Caso contrário, false.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

putIfAbsent

public Object putIfAbsent(String key,
                 Object value,
                 long timeToLive,
                 long timeToIdle)
                   throws StorageException

Associa o valor a chave somente se a chave não estiver associada a um valor.

Overrides:

putIfAbsent in class Cache

Parameters:

key - chave associada ao valor.

value - valor para ser associado à chave.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

Returns:

valor anterior associado à chave.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item ou se o item atual expirar no momento da execução do método.

putIfAbsentStream

public InputStream putIfAbsentStream(String key,
                            InputStream inputData,
                            long timeToLive,
                            long timeToIdle)
                              throws StorageException

Associa o fluxo de bytes do valor à chave somente se a chave não estiver associada a um valor.

Overrides:

putIfAbsentStream in class Cache

Parameters:

key - chave associada ao valor.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

inputData - fluxo de bytes do valor.

Returns:

fluxo associado à chave ou null.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

put

public boolean put(String key,
          Object value,
          long timeToLive,
          long timeToIdle)
            throws StorageException

Associa o valor à chave.

Overrides:

put in class Cache

Parameters:

key - chave associada ao valor.

value - valor para ser associado à chave.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

Returns:

true se o item for substituido. Caso contrário, false

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

putStream

public boolean putStream(String key,
                InputStream inputData,
                long timeToLive,
                long timeToIdle)
                  throws StorageException

Associa o fluxo de bytes do valor à chave.

Overrides:

putStream in class Cache

Parameters:

key - chave associada ao fluxo.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

inputData - fluxo de bytes do valor.

Returns:

true se o item for substituido. Caso contrário, false

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

get

public Object get(String key)
           throws RecoverException

Obtém o valor associado à chave.

Overrides:

get in class Cache

Parameters:

key - chave associada ao valor.

Returns:

valor associado à chave ou null.

Throws:

RecoverException - Lançada se ocorrer alguma falha ao tentar obter o item.

get

public Object get(String key,
         boolean forUpdate)
           throws RecoverException

Obtém o valor associado à chave bloqueando ou não seu acesso as demais transações.

Parameters:

key - chave associada ao valor.

forUpdate - true para bloquear o item. Caso contrário false.

Returns:

valor associado à chave ou null.

Throws:

RecoverException - Lançada se ocorrer alguma falha ao tentar obter o item.

getStream

public InputStream getStream(String key)
                      throws RecoverException

Obtém o fluxo de bytes do valor associado à chave.

Overrides:

getStream in class Cache

Parameters:

key - chave associada ao fluxo.

Returns:

fluxo de bytes do valor ou null.

Throws:

RecoverException - Lançada se ocorrer alguma falha ao tentar obter o item.

getStream

public InputStream getStream(String key,
                    boolean forUpdate)
                      throws RecoverException

Obtém o fluxo de bytes do valor associado à chave bloqueando ou não seu acesso as demais transações.

Parameters:

key - chave associada ao fluxo.

forUpdate - true para bloquear o item. Caso contrário false.

Returns:

fluxo de bytes do valor ou null.

Throws:

RecoverException - Lançada se ocorrer alguma falha ao tentar obter o item.

remove

public boolean remove(String key,
             Object value)
               throws StorageException

Remove o valor assoiado à chave somente se ele for igual a um determinado valor.

Overrides:

remove in class Cache

Parameters:

key - chave associada ao valor.

value - valor esperado associado à chave.

Returns:

valor para ser associado à chave.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar remover o item.

remove

public boolean remove(String key)
               throws StorageException

Remove o valor associado à chave.

Overrides:

remove in class Cache

Parameters:

key - chave associada ao valor.

Returns:

true se o valor for removido. Caso contrário, false.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar remover o item.

getCountRead

public long getCountRead()

Obtém a quantidade de itens recuperados.

Overrides:

getCountRead in class StreamCache

Returns:

Quantidade de itens recuperados.

getCountWrite

public long getCountWrite()

Obtém a quantidade de itens armazenados.

Overrides:

getCountWrite in class StreamCache

Returns:

Quantidade de itens armazenados.

getCountRemoved

public long getCountRemoved()

Obtém a quantidade de itens removidos.

Overrides:

getCountRemoved in class StreamCache

Returns:

Quantidade de itens removidos.

getCountReadData

public long getCountReadData()

Obtém a quantidade de bytes recuperados.

Overrides:

getCountReadData in class StreamCache

Returns:

Quantidade de bytes recuperados.

getCountWriteData

public long getCountWriteData()

Obtém a quantidade de bytes armazenados.

Overrides:

getCountWriteData in class StreamCache

Returns:

Quantidade de bytes armazenados.

getCountRemovedData

public long getCountRemovedData()

Obtém a quantidade de bytes removidos.

Overrides:

getCountRemovedData in class StreamCache

Returns:

Quantidade de bytes removidos.