CacheClient (BlazingCache :: Core 1.4.0 API)

java.lang.Object
- blazingcache.client.CacheClient

All Implemented Interfaces:: ChannelEventListener, ConnectionRequestInfo, AutoCloseable

public class CacheClient
extends Object
implements ChannelEventListener, ConnectionRequestInfo, AutoCloseable

Client

Author:: enrico.olivelli

Constructor Summary

Constructors
Constructor and Description

CacheClient(String clientId, String sharedSecret, ServerLocator brokerLocator)

Constructors
Constructor and Description
`CacheClient(String clientId, String sharedSecret, ServerLocator brokerLocator)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`channelClosed()`
`void`	`close()` Closes the client.
`void`	`disconnect()` Disconnects the client.
`CacheEntry`	`fetch(String key)` Returns an entry from the local cache, if not found asks to the CacheServer to find the entry on other clients
`CacheEntry`	`fetch(String key, KeyLock lock)` Returns an entry from the local cache, if not found asks to the CacheServer to find the entry on other clients.
`CacheEntry`	`get(String key)` Returns an entry from the local cache.
`long`	`getActualMemory()`
`ServerLocator`	`getBrokerLocator()`
`int`	`getCacheSize()` Actual number of entries in the local cache
`String`	`getClientId()`
`long`	`getConnectionTimestamp()`
`Set<String>`	`getLocalKeySetByPrefix(String prefix)` Return the local key set
`long`	`getMaxMemory()` Maximum amount of memory used for storing entry values. 0 or negative to disable
`String`	`getSharedSecret()`
`String`	`getStatus()`
`void`	`invalidate(String key)` Invalidates an entry from the local cache and blocks until any other client which holds the same entry has invalidated the entry locally
`void`	`invalidate(String key, KeyLock lock)`
`void`	`invalidateByPrefix(String prefix)` Same as `invalidate(java.lang.String)` but it applies to every entry whose key 'startsWith' the given prefix
`boolean`	`isConnected()`
`KeyLock`	`lock(String key)`
`void`	`messageReceived(Message message)` Called for each message which is not a direct reply to another message.
`boolean`	`put(String key, byte[] data, long expireTime)` Put an entry on the local cache.
`boolean`	`put(String key, byte[] data, long expireTime, KeyLock lock)`
`void`	`setMaxMemory(long maxMemory)` Maximum amount of memory used for storing entry values. 0 or negative to disable
`void`	`start()` Start the client.
`void`	`stop()`
`void`	`touchEntry(String key, long expiretime)` Modifies the expireTime for a given entry.
`void`	`touchEntry(String key, long expiretime, KeyLock lock)` Modifies the expireTime for a given entry.
`void`	`unlock(KeyLock keyLock)`
`boolean`	`waitForConnection(int timeout)` Waits for the client to establish the first connection to the server
`boolean`	`waitForDisconnection(int timeout)` Waits for the client to be disconnected

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CacheClient
```
public CacheClient(String clientId,
                   String sharedSecret,
                   ServerLocator brokerLocator)
```
- Method Detail
  - getMaxMemory
```
public long getMaxMemory()
```
    Maximum amount of memory used for storing entry values. 0 or negative to disable
  - setMaxMemory
```
public void setMaxMemory(long maxMemory)
```
    Maximum amount of memory used for storing entry values. 0 or negative to disable
  - getActualMemory
```
public long getActualMemory()
```
  - getStatus
```
public String getStatus()
```
  - getBrokerLocator
```
public ServerLocator getBrokerLocator()
```
  - start
```
public void start()
```
    Start the client. You MUST start the client before using it, otherwise the client will always operated in disconnected mode
    
    See Also:
    
    isConnected(), waitForConnection(int)
  - waitForConnection
```
public boolean waitForConnection(int timeout)
                          throws InterruptedException
```
    Waits for the client to establish the first connection to the server
    
    Parameters:
    
    timeout -
    
    Returns:
    
    Throws:
    
    InterruptedException
  - waitForDisconnection
```
public boolean waitForDisconnection(int timeout)
                             throws InterruptedException
```
    Waits for the client to be disconnected
    
    Parameters:
    
    timeout -
    
    Returns:
    
    Throws:
    
    InterruptedException
  - getClientId
```
public String getClientId()
```
    Specified by:
    
    getClientId in interface ConnectionRequestInfo
  - isConnected
```
public boolean isConnected()
```
  - getConnectionTimestamp
```
public long getConnectionTimestamp()
```
  - getCacheSize
```
public int getCacheSize()
```
    Actual number of entries in the local cache
    
    Returns:
  - disconnect
```
public void disconnect()
```
    Disconnects the client. This operation autmatically evicts all the entries from the local cache
  - messageReceived
```
public void messageReceived(Message message)
```
    Description copied from interface: ChannelEventListener
    
    Called for each message which is not a direct reply to another message. Any unchecked Exception thrown by this method will cause the channel to be closed
    
    Specified by:
    
    messageReceived in interface ChannelEventListener
  - channelClosed
```
public void channelClosed()
```
    Specified by:
    
    channelClosed in interface ChannelEventListener
  - getSharedSecret
```
public String getSharedSecret()
```
    Specified by:
    
    getSharedSecret in interface ConnectionRequestInfo
  - close
```
public void close()
           throws Exception
```
    Closes the client. It will never try to reconnect again to the server
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception
  - stop
```
public void stop()
```
  - fetch
```
public CacheEntry fetch(String key)
                 throws InterruptedException
```
    Returns an entry from the local cache, if not found asks to the CacheServer to find the entry on other clients
    
    Parameters:
    
    key -
    
    Returns:
    
    Throws:
    
    InterruptedException
    
    See Also:
    
    get(java.lang.String)
  - fetch
```
public CacheEntry fetch(String key,
                        KeyLock lock)
                 throws InterruptedException
```
    Returns an entry from the local cache, if not found asks to the CacheServer to find the entry on other clients.
    
    Parameters:
    
    key -
    
    lock - previouly acquired lock
    
    Returns:
    
    Throws:
    
    InterruptedException
    
    See Also:
    
    get(java.lang.String), lock(java.lang.String)
  - touchEntry
```
public void touchEntry(String key,
                       long expiretime)
```
    Modifies the expireTime for a given entry. Expiration works at CacheServer side.
    
    Parameters:
    
    key -
    
    expiretime -
  - touchEntry
```
public void touchEntry(String key,
                       long expiretime,
                       KeyLock lock)
```
    Modifies the expireTime for a given entry. Expiration works at CacheServer side.
    
    Parameters:
    
    key -
    
    expiretime -
    
    See Also:
    
    lock(java.lang.String)
  - get
```
public CacheEntry get(String key)
```
    Returns an entry from the local cache. No network operations will be executed
    
    Parameters:
    
    key -
    
    Returns:
    
    See Also:
    
    fetch(java.lang.String)
  - invalidate
```
public void invalidate(String key)
                throws InterruptedException
```
    Invalidates an entry from the local cache and blocks until any other client which holds the same entry has invalidated the entry locally
    
    Parameters:
    
    key -
    
    Throws:
    
    InterruptedException
  - invalidate
```
public void invalidate(String key,
                       KeyLock lock)
                throws InterruptedException
```
    Throws:
    
    InterruptedException
  - invalidateByPrefix
```
public void invalidateByPrefix(String prefix)
                        throws InterruptedException
```
    Same as invalidate(java.lang.String) but it applies to every entry whose key 'startsWith' the given prefix
    
    Parameters:
    
    prefix -
    
    Throws:
    
    InterruptedException
  - put
```
public boolean put(String key,
                   byte[] data,
                   long expireTime)
            throws InterruptedException,
                   CacheException
```
    Put an entry on the local cache. This method will also notify of the change to all other clients which hold the same entry locally.
    
    Parameters:
    
    key -
    
    data -
    
    expireTime - This is the UNIX timestamp at which the entry should be invalidated automatically. Use 0 in order to create an immortal entry
    
    Returns:
    
    Throws:
    
    InterruptedException
    
    CacheException
    
    See Also:
    
    touchEntry(java.lang.String, long)
  - put
```
public boolean put(String key,
                   byte[] data,
                   long expireTime,
                   KeyLock lock)
            throws InterruptedException,
                   CacheException
```
    Throws:
    
    InterruptedException
    
    CacheException
  - lock
```
public KeyLock lock(String key)
             throws InterruptedException,
                    CacheException
```
    Throws:
    
    InterruptedException
    
    CacheException
  - unlock
```
public void unlock(KeyLock keyLock)
            throws InterruptedException,
                   CacheException
```
    Throws:
    
    InterruptedException
    
    CacheException
  - getLocalKeySetByPrefix
```
public Set<String> getLocalKeySetByPrefix(String prefix)
```
    Return the local key set
    
    Parameters:
    
    prefix -
    
    Returns:

Class CacheClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CacheClient

Method Detail

getMaxMemory

setMaxMemory

getActualMemory

getStatus

getBrokerLocator

start

waitForConnection

waitForDisconnection

getClientId

isConnected

getConnectionTimestamp

getCacheSize

disconnect

messageReceived

channelClosed

getSharedSecret

close

stop

fetch

fetch

touchEntry

touchEntry

get

invalidate

invalidate

invalidateByPrefix

put

put

lock

unlock

getLocalKeySetByPrefix