org.apache.cxf.ws.security.trust

Interface STSTokenCacher

All Known Implementing Classes:

DefaultSTSTokenCacher

public interface STSTokenCacher

This interface allows you to plug in some custom logic when storing/retrieving STS tokens in/from the cache

Method Summary

Modifier and Type	Method and Description
void	removeToken(Message message, SecurityToken securityToken) Remove a cached STS token
SecurityToken	retrieveToken(Message message, boolean retrieveTokenFromEndpoint) Retrieve a cached STS token.
SecurityToken	retrieveToken(Message message, Element delegationToken, String cacheKey) Retrieve a cached STS token for a given delegation token Element
void	storeToken(Message message, Element delegationToken, String secTokenId, String cacheKey) Store a given delegation token in the cache (or update it if it's already there), with a reference to the security token obtained from the STS.
void	storeToken(Message message, SecurityToken securityToken, boolean storeTokenInEndpoint) Store a token in the cache.

Method Detail

retrieveToken

SecurityToken retrieveToken(Message message,
                            boolean retrieveTokenFromEndpoint)

Retrieve a cached STS token. The retrieveTokenFromEndpoint boolean lets us known whether we want to retrieve the token from the endpoint or not.

retrieveToken

SecurityToken retrieveToken(Message message,
                            Element delegationToken,
                            String cacheKey)

Retrieve a cached STS token for a given delegation token Element

storeToken

void storeToken(Message message,
                SecurityToken securityToken,
                boolean storeTokenInEndpoint)

Store a token in the cache. The storeTokenInEndpoint boolean lets us know whether we want to store the token in the endpoint or not.

storeToken

void storeToken(Message message,
                Element delegationToken,
                String secTokenId,
                String cacheKey)

Store a given delegation token in the cache (or update it if it's already there), with a reference to the security token obtained from the STS.

removeToken

void removeToken(Message message,
                 SecurityToken securityToken)

Remove a cached STS token