com.netflix.msl.util

Class NullMslStore

java.lang.Object

com.netflix.msl.util.NullMslStore

All Implemented Interfaces:

MslStore

public class NullMslStore
extends java.lang.Object
implements MslStore

A MSL store where all operations are no-ops.

Constructor Summary

Constructors

Constructor and Description
NullMslStore()

Method Summary

Modifier and Type	Method and Description
void	addServiceTokens(java.util.Set<ServiceToken> tokens) Add a set of service tokens to the store.
void	addUserIdToken(java.lang.String userId, UserIdToken userIdToken) Add a user ID token to the store, replacing any existing user ID token of the same user.
void	clearCryptoContexts() Removes all master tokens and crypto contexts and bound user ID tokens and their bound service tokens.
void	clearServiceTokens() Removes all service tokens.
void	clearUserIdTokens() Removes all user ID tokens and user ID token bound service tokens.
ICryptoContext	getCryptoContext(MasterToken masterToken) Return the crypto context associated with the provided master token.
MasterToken	getMasterToken() Return the newest saved master token in this store.
long	getNonReplayableId(MasterToken masterToken) Return the next non-replayable ID of the provided master token.
java.util.Set<ServiceToken>	getServiceTokens(MasterToken masterToken, UserIdToken userIdToken) Return the set of service tokens that are applicable to the provided pair of master token and user ID token.
UserIdToken	getUserIdToken(java.lang.String userId) Returns the user ID token, if any, for the specified local user ID.
void	removeCryptoContext(MasterToken masterToken) Remove a master token and its associated crypto context.
void	removeServiceTokens(java.lang.String name, MasterToken masterToken, UserIdToken userIdToken) Remove all service tokens matching all the specified parameters.
void	removeUserIdToken(UserIdToken userIdToken) Remove a user ID token.
void	setCryptoContext(MasterToken masterToken, ICryptoContext cryptoContext) Save a master token and its associated crypto context.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullMslStore

public NullMslStore()

Method Detail

setCryptoContext

public void setCryptoContext(MasterToken masterToken,
                             ICryptoContext cryptoContext)

Description copied from interface: MslStore

Save a master token and its associated crypto context. This replaces any existing association. Passing in a null crypto context is the same as calling MslStore.removeCryptoContext(MasterToken).

Specified by:

setCryptoContext in interface MslStore

Parameters:

masterToken - the master token.

cryptoContext - the crypto context. May be null.

getMasterToken

public MasterToken getMasterToken()

Description copied from interface: MslStore

Return the newest saved master token in this store.

Specified by:

getMasterToken in interface MslStore

Returns:

the newest saved master token or null.

getNonReplayableId

public long getNonReplayableId(MasterToken masterToken)

Description copied from interface: MslStore

Return the next non-replayable ID of the provided master token. The initial number is one (1). Each call to this function should return the next largest number. The next largest number after MslConstants.MAX_LONG_VALUE is zero (0).

Specified by:

getNonReplayableId in interface MslStore

Returns:

the next non-replayable ID.

getCryptoContext

public ICryptoContext getCryptoContext(MasterToken masterToken)

Description copied from interface: MslStore

Return the crypto context associated with the provided master token.

Specified by:

getCryptoContext in interface MslStore

Parameters:

masterToken - the master token.

Returns:

the crypto context for the master token or null if not found.

removeCryptoContext

public void removeCryptoContext(MasterToken masterToken)

Description copied from interface: MslStore

Remove a master token and its associated crypto context. This also removes any stored user ID tokens and service tokens that are no longer bound to a known master token.

Specified by:

removeCryptoContext in interface MslStore

Parameters:

masterToken - the master token.

clearCryptoContexts

public void clearCryptoContexts()

Description copied from interface: MslStore

Removes all master tokens and crypto contexts and bound user ID tokens and their bound service tokens.

Specified by:

clearCryptoContexts in interface MslStore

addUserIdToken

public void addUserIdToken(java.lang.String userId,
                           UserIdToken userIdToken)

Description copied from interface: MslStore

Add a user ID token to the store, replacing any existing user ID token of the same user. The local user ID has no meeting external to the store.

Specified by:

addUserIdToken in interface MslStore

Parameters:

userId - local user ID.

userIdToken - the user ID token.

getUserIdToken

public UserIdToken getUserIdToken(java.lang.String userId)

Description copied from interface: MslStore

Returns the user ID token, if any, for the specified local user ID.

Specified by:

getUserIdToken in interface MslStore

Parameters:

userId - local user ID.

Returns:

the user ID token for the local user ID or null.

removeUserIdToken

public void removeUserIdToken(UserIdToken userIdToken)

Description copied from interface: MslStore

Remove a user ID token. This also removes any service tokens no longer bound to a known user ID token.

Specified by:

removeUserIdToken in interface MslStore

Parameters:

userIdToken - the user ID token.

clearUserIdTokens

public void clearUserIdTokens()

Description copied from interface: MslStore

Removes all user ID tokens and user ID token bound service tokens.

Specified by:

clearUserIdTokens in interface MslStore

addServiceTokens

public void addServiceTokens(java.util.Set<ServiceToken> tokens)

Description copied from interface: MslStore

Add a set of service tokens to the store.

Either all or none of the provided service tokens will be added.

Specified by:

addServiceTokens in interface MslStore

Parameters:

tokens - the service tokens.

getServiceTokens

public java.util.Set<ServiceToken> getServiceTokens(MasterToken masterToken,
                                                    UserIdToken userIdToken)
                                             throws MslException

Description copied from interface: MslStore

Return the set of service tokens that are applicable to the provided pair of master token and user ID token. The base set consists of the service tokens that are not bound to any master token or user ID token.

If a master token is provided, the service tokens that are bound to the master token and not bound to any user ID token are also provided.

If a master token and user ID token is provided, the service tokens that are bound to both the master token and user ID token are also provided.

Specified by:

getServiceTokens in interface MslStore

Parameters:

masterToken - the master token. May be null.

userIdToken - the user ID token. May be null.

Returns:

the set of service tokens applicable to the message.

Throws:

MslException - if the user ID token is not bound to the master token or a user ID token is provided without also providing a master token.

removeServiceTokens

public void removeServiceTokens(java.lang.String name,
                                MasterToken masterToken,
                                UserIdToken userIdToken)
                         throws MslException

Description copied from interface: MslStore

Remove all service tokens matching all the specified parameters.

If a name is provided, only tokens with that name are removed. If a master token is provided, only tokens bound to that master token are removed. If a user ID token is provided, only tokens bound to that user ID token are removed.

For example, if a name and master token is provided, only tokens with that name and bound to that master token are removed.

If no parameters are provided, no tokens are removed.

Specified by:

removeServiceTokens in interface MslStore

Parameters:

name - service token name. May be null.

masterToken - master token. May be null.

userIdToken - user ID token. May be null.

Throws:

MslException - if the user ID token is not bound to the master token.

clearServiceTokens

public void clearServiceTokens()

Description copied from interface: MslStore

Removes all service tokens.

Specified by:

clearServiceTokens in interface MslStore