Package net.solarnetwork.node.runtime

Class DefaultSecurityTokenService

java.lang.Object

net.solarnetwork.service.support.BasicIdentifiable

net.solarnetwork.node.service.support.BaseIdentifiable

net.solarnetwork.node.runtime.DefaultSecurityTokenService

All Implemented Interfaces:

SecurityTokenService, net.solarnetwork.service.Identifiable

public class DefaultSecurityTokenService
extends BaseIdentifiable
implements SecurityTokenService

Default implementation of SecurityTokenService

Since:

3.4

Version:

1.0

Author:

matt

Field Summary

Fields inherited from class net.solarnetwork.node.service.support.BaseIdentifiable

log

Fields inherited from interface net.solarnetwork.service.Identifiable

GROUP_UID_PROPERTY, UID_PROPERTY

Constructor Summary

Constructors

Constructor	Description
DefaultSecurityTokenService(SecureRandom rng, net.solarnetwork.service.OptionalService<SecurityTokenDao> securityTokenDao)	Constructor.
DefaultSecurityTokenService(net.solarnetwork.service.OptionalService<SecurityTokenDao> securityTokenDao)	Constructor.

Method Summary

Modifier and Type	Method	Description
net.solarnetwork.domain.KeyValuePair	createToken(SecurityToken details)	Create a new token.
void	deleteToken(String tokenId)	Delete a security token.
Collection<SecurityToken>	getAvailableTokens()	Get all available security tokens.
SecurityToken	tokenForId(String tokenId)	Get a security token for a given ID.
void	updateToken(SecurityToken token)	Update the modifiable values of a security token.

Methods inherited from class net.solarnetwork.node.service.support.BaseIdentifiable

baseIdentifiableSettings, baseIdentifiableSettings, getExpressionServices, getPlaceholderService, populateExpressionDatumProperties, resolvePlaceholders, resolvePlaceholders, setExpressionServices, setPlaceholderService

Methods inherited from class net.solarnetwork.service.support.BasicIdentifiable

basicIdentifiableMetadataSettings, basicIdentifiableSettings, basicIdentifiableSettings, basicIdentifiableSettings, doubleMetadataValue, getDisplayName, getGroupUid, getGroupUID, getMessageSource, getMetadata, getMetadataCount, getUid, getUID, integerMetadataValue, metadataValue, numberMetadataValue, saveMetadataValue, saveMetadataValue, setDisplayName, setGroupUid, setGroupUID, setMessageSource, setMetadata, setMetadataCount, setUid, setUID, smartMetadataValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.solarnetwork.service.Identifiable

getDisplayName, getGroupUid, getUid

Constructor Details

DefaultSecurityTokenService

public DefaultSecurityTokenService(net.solarnetwork.service.OptionalService<SecurityTokenDao> securityTokenDao)

Constructor.

Parameters:

securityTokenDao - the DAO to use

Throws:

IllegalArgumentException - if any argument is null

DefaultSecurityTokenService

public DefaultSecurityTokenService(SecureRandom rng,
 net.solarnetwork.service.OptionalService<SecurityTokenDao> securityTokenDao)

Constructor.

Parameters:

rng - the random number generator

securityTokenDao - the DAO to use

Throws:

IllegalArgumentException - if any argument is null

Method Details

getAvailableTokens

public Collection<SecurityToken> getAvailableTokens()

Description copied from interface: SecurityTokenService

Get all available security tokens.

The token secrets are not returned by this method.

Specified by:

getAvailableTokens in interface SecurityTokenService

Returns:

the tokens, never null

tokenForId

public SecurityToken tokenForId(String tokenId)

Description copied from interface: SecurityTokenService

Get a security token for a given ID.

Specified by:

tokenForId in interface SecurityTokenService

Parameters:

tokenId - the token ID

Returns:

the token, or null if not found

createToken

public net.solarnetwork.domain.KeyValuePair createToken(SecurityToken details)

Description copied from interface: SecurityTokenService

Create a new token.

This method will generate a new security token and return the generated token ID and secret.

Specified by:

createToken in interface SecurityTokenService

Parameters:

details - the optional details (name, description) to use

Returns:

the token ID and token secret

updateToken

public void updateToken(SecurityToken token)

Description copied from interface: SecurityTokenService

Update the modifiable values of a security token.

The token ID and secret cannot be changed by this method, but properties like name and description can.

Specified by:

updateToken in interface SecurityTokenService

Parameters:

token - the token details to update

deleteToken

public void deleteToken(String tokenId)

Description copied from interface: SecurityTokenService

Delete a security token.

No error is thrown if the given tokenId does not exist.

Specified by:

deleteToken in interface SecurityTokenService

Parameters:

tokenId - the ID of the token to delete