HazelCastTokenStore (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.sts.cache.HazelCastTokenStore

All Implemented Interfaces:: TokenStore

public class HazelCastTokenStore
extends Object
implements TokenStore

Field Summary

Fields
Modifier and Type Field and Description

static long DEFAULT_TTL

static long MAX_TTL

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_TTL`
`static long`	`MAX_TTL`

Constructor Summary

Constructors
Constructor and Description

HazelCastTokenStore(String mapName)

Constructors
Constructor and Description
`HazelCastTokenStore(String mapName)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(SecurityToken token)` Add the given token to the cache.
`void`	`add(String identifier, SecurityToken token)` Add the given token to the cache under the given identifier
`void`	`destroy()`
`com.hazelcast.core.HazelcastInstance`	`getHazelcastInstance()` Get the Hazelcast instance If null, return Default instance
`SecurityToken`	`getToken(String identifier)` Returns the `Token` of the given identifier
`Collection<String>`	`getTokenIdentifiers()` Return the list of all valid token identifiers.
`long`	`getTTL()` Get the (default) TTL value in seconds
`void`	`remove(String identifier)` Remove an existing token by its identifier
`void`	`setHazelcastInstance(com.hazelcast.core.HazelcastInstance hazelcastInstance)` Set the Hazelcast instance, otherwise default instance used If you configure Hazelcast instance in spring, you must inject the instance here.
`void`	`setTTL(long newTtl)` Set a new (default) TTL value in seconds

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

- Field Detail
  - DEFAULT_TTL
```
public static final long DEFAULT_TTL
```
    See Also:
    Constant Field Values
  - MAX_TTL
```
public static final long MAX_TTL
```
    See Also:
    Constant Field Values
- Constructor Detail
  - HazelCastTokenStore
```
public HazelCastTokenStore(String mapName)
```
- Method Detail
  - getHazelcastInstance
```
public com.hazelcast.core.HazelcastInstance getHazelcastInstance()
```
    Get the Hazelcast instance If null, return Default instance
    
    Parameters:
    hzInstance - Hazelcast instance
  - setHazelcastInstance
```
public void setHazelcastInstance(com.hazelcast.core.HazelcastInstance hazelcastInstance)
```
    Set the Hazelcast instance, otherwise default instance used If you configure Hazelcast instance in spring, you must inject the instance here.
    
    Parameters:
    hzInstance - Hazelcast instance
  - setTTL
```
public void setTTL(long newTtl)
```
    Set a new (default) TTL value in seconds
    
    Parameters:
    newTtl - a new (default) TTL value in seconds
  - getTTL
```
public long getTTL()
```
    Get the (default) TTL value in seconds
    
    Returns:
    the (default) TTL value in seconds
  - add
```
public void add(SecurityToken token)
```
    Description copied from interface: TokenStore
    
    Add the given token to the cache. The SecurityTokens getId() identifier will be used to key it in the cache.
    
    Specified by:
    
    add in interface TokenStore
    
    Parameters:
    token - The token to be added
  - add
```
public void add(String identifier,
       SecurityToken token)
```
    Description copied from interface: TokenStore
    
    Add the given token to the cache under the given identifier
    
    Specified by:
    
    add in interface TokenStore
    
    Parameters:
    identifier - The identifier to use to key the SecurityToken in the cache
    token - The token to be added
  - remove
```
public void remove(String identifier)
```
    Description copied from interface: TokenStore
    
    Remove an existing token by its identifier
    
    Specified by:
    
    remove in interface TokenStore
  - getTokenIdentifiers
```
public Collection<String> getTokenIdentifiers()
```
    Description copied from interface: TokenStore
    
    Return the list of all valid token identifiers.
    
    Specified by:
    
    getTokenIdentifiers in interface TokenStore
    
    Returns:
    As array of (valid) token identifiers
  - getToken
```
public SecurityToken getToken(String identifier)
```
    Description copied from interface: TokenStore
    
    Returns the Token of the given identifier
    
    Specified by:
    
    getToken in interface TokenStore
    
    Returns:
    The requested Token identified by the given identifier
  - destroy
```
public void destroy()
```

Class HazelCastTokenStore

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TTL

MAX_TTL

Constructor Detail

HazelCastTokenStore

Method Detail

getHazelcastInstance

setHazelcastInstance

setTTL

getTTL

add

add

remove

getTokenIdentifiers

getToken

destroy