org.brandao.brcache

Class BasicCache

java.lang.Object

org.brandao.brcache.StreamCache

org.brandao.brcache.BasicCache

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Cache

public class BasicCache
extends StreamCache

Provê as operações básicas de um cache.

Author:

Brandao.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BRCacheConfig	config

Constructor Summary

Constructors

Constructor and Description
BasicCache() Cria um novo cache.
BasicCache(BRCacheConfig config)
BasicCache(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) Cria um novo cache.

Method Summary

Methods

Modifier and Type	Method and Description
Object	get(String key) Obtém o valor associado à chave.
BRCacheConfig	getConfig() Obtém a configuração do cache.
InputStream	getStream(String key) Obtém o fluxo de bytes do valor associado à chave.
TXCache	getTXCache() Obtém o cache com suporte transacional.
TXCache	getTXCache(CacheTransactionManager txManager) Obtém o cache com suporte transacional com um gestor transacional específicos.
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 à 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	replace(String key, Object value, long timeToLive, long timeToIdle) Substitui o valor associado à chave somente se ele existir.
boolean	replaceStream(String key, InputStream inputData, long timeToLive, long timeToIdle) Substitui o fluxo de bytes associado à chave somente se ele existir.

Methods inherited from class org.brandao.brcache.StreamCache

clear, containsKey, destroy, finalize, getCountRead, getCountReadData, getCountRemoved, getCountRemovedData, getCountWrite, getCountWriteData, init, isDeleteOnExit, removeStream, setDeleteOnExit

Methods inherited from class java.lang.Object

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

Field Detail

config

protected BRCacheConfig config

Constructor Detail

BasicCache

public BasicCache()

Cria um novo cache.

BasicCache

public BasicCache(BRCacheConfig config)

BasicCache

public BasicCache(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)

Cria um novo cache.

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.

Method Detail

getTXCache

public TXCache getTXCache()

Obtém o cache com suporte transacional.

Returns:

cache.

getTXCache

public TXCache getTXCache(CacheTransactionManager txManager)

Obtém o cache com suporte transacional com um gestor transacional específicos.

Parameters:

txManager - gestor transacional.

Returns:

cache com suporte transacional.

replace

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

Substitui o valor associado à chave somente se ele existir.

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 valor for substituido. Caso contrário, false.

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 StreamCache

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.

putIfAbsent

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

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

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 StreamCache

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.

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 StreamCache

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.

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.

getStream

public InputStream getStream(String key)
                      throws RecoverException

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

Overrides:

getStream in class StreamCache

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.

remove

public boolean remove(String key)
               throws StorageException

Remove o valor associado à chave.

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.

getConfig

public BRCacheConfig getConfig()

Obtém a configuração do cache.

Returns:

configuração.