Package net.solarnetwork.node.service.support

Class UserMetadataService

java.lang.Object

net.solarnetwork.service.support.BasicIdentifiable

net.solarnetwork.node.service.support.BaseIdentifiable

net.solarnetwork.node.service.support.HttpClientSupport

net.solarnetwork.node.service.support.JsonHttpClientSupport

net.solarnetwork.node.service.support.UserMetadataService

All Implemented Interfaces:

MetadataService, net.solarnetwork.service.Identifiable, net.solarnetwork.settings.SettingsChangeObserver, net.solarnetwork.settings.SettingSpecifierProvider

public class UserMetadataService
extends JsonHttpClientSupport
implements MetadataService, net.solarnetwork.settings.SettingSpecifierProvider, net.solarnetwork.settings.SettingsChangeObserver

Implementation of MetadataService that uses SolarQuery to find user-level metadata.

Version:

1.0

Author:

matt

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CACHE_SECONDS	The cacheSeconds property default value.
static final String	USER_METADATA_PATH	The the user metadata path.

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

JSON_MIME_TYPE

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

ACCEPT_JSON, ACCEPT_TEXT, DEFAULT_CONNECTION_TIMEOUT, HTTP_METHOD_GET, HTTP_METHOD_POST, log

Fields inherited from interface net.solarnetwork.service.Identifiable

GROUP_UID_PROPERTY, UID_PROPERTY

Constructor Summary

Constructors

Constructor	Description
UserMetadataService(net.solarnetwork.service.OptionalService<SetupService> setupService)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	configurationChanged(Map<String,Object> properties)
net.solarnetwork.domain.datum.GeneralDatumMetadata	getAllMetadata()	Get all metadata available.
List<net.solarnetwork.settings.SettingSpecifier>	getSettingSpecifiers()
String	getSettingUid()
void	setCacheSeconds(int cacheSeconds)	Set the number of seconds to cache metadata.
void	setToken(String token)	Set the SolarNetwork token to use.
void	setTokenSecret(String tokenSecret)	Set the SolarNetwork token secret to use.

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

doJson, doJson, extractCollectionResponseData, extractFilterResultsCollectionResponseData, extractResponseData, getObjectMapper, isCompress, jsonGET, jsonGET, jsonPOST, jsonPOST, setCompress, setObjectMapper, verifyResponseSuccess

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

appendXWWWFormURLEncodedValue, getConnectionTimeout, getIdentityService, getInputStreamFromURLConnection, getSslService, getUnicodeReaderFromURLConnection, getURLConnection, getURLConnection, getURLConnection, postXWWWFormURLEncodedData, postXWWWFormURLEncodedDataForString, setConnectionTimeout, setIdentityService, setSslService, setupTokenAuthorization, xWWWFormURLEncoded

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

Methods inherited from interface net.solarnetwork.node.service.MetadataService

metadataAtPath, metadataAtPath

Methods inherited from interface net.solarnetwork.settings.SettingSpecifierProvider

getDisplayName, getMessageSource, templateSettingSpecifiers

Field Details

USER_METADATA_PATH

public static final String USER_METADATA_PATH

The the user metadata path.

See Also:

• Constant Field Values

DEFAULT_CACHE_SECONDS

public static final int DEFAULT_CACHE_SECONDS

The cacheSeconds property default value.

See Also:

• Constant Field Values

Constructor Details

UserMetadataService

public UserMetadataService(net.solarnetwork.service.OptionalService<SetupService> setupService)

Constructor.

Parameters:

setupService - the setup service

Method Details

configurationChanged

public void configurationChanged(Map<String,Object> properties)

Specified by:

configurationChanged in interface net.solarnetwork.settings.SettingsChangeObserver

getAllMetadata

public net.solarnetwork.domain.datum.GeneralDatumMetadata getAllMetadata()

Description copied from interface: MetadataService

Get all metadata available.

Specified by:

getAllMetadata in interface MetadataService

Returns:

the metadata, or null if none available

getSettingUid

public String getSettingUid()

Specified by:

getSettingUid in interface net.solarnetwork.settings.SettingSpecifierProvider

getSettingSpecifiers

public List<net.solarnetwork.settings.SettingSpecifier> getSettingSpecifiers()

Specified by:

getSettingSpecifiers in interface net.solarnetwork.settings.SettingSpecifierProvider

setCacheSeconds

public void setCacheSeconds(int cacheSeconds)

Set the number of seconds to cache metadata.

Parameters:

cacheSeconds - the maximum number of seconds to cache metadata for, or anything less than 1 to disable

setToken

public void setToken(String token)

Set the SolarNetwork token to use.

Parameters:

token - the token to set

setTokenSecret

public void setTokenSecret(String tokenSecret)

Set the SolarNetwork token secret to use.

Parameters:

tokenSecret - the token secret to set