Package net.solarnetwork.domain

Interface NetworkIdentity

All Known Subinterfaces:

NetworkAssociation

All Known Implementing Classes:

BasicNetworkIdentity, NetworkAssociationDetails

public interface NetworkIdentity

Information that identifies the central SolarNet network.

Version:

1.2

Author:

matt

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SOLARIN_MQTT_NETWORK_SERVICE_KEY	The getNetworkServiceURLs() key for the SolarIn MQTT service.
static final String	SOLARQUERY_NETWORK_SERVICE_KEY	The getNetworkServiceURLs() key for the SolarQuery service.
static final String	SOLARUSER_NETWORK_SERVICE_KEY	The getNetworkServiceURLs() key for the SolarUser service.

Method Summary

Modifier and Type	Method	Description
String	getHost()	Get the service host name.
String	getIdentityKey()	Get a universally unique key that identifies this service.
Map<String,String>	getNetworkServiceURLs()	Get a mapping of pre-defined network service URLs, to be used by clients to provide links to the SolarNetwork they are associated with.
Integer	getPort()	The host port to use.
String	getTermsOfService()	Get the terms of service for this service.
boolean	isForceTLS()	Flag indicating if TLS must be used.

Field Details

SOLARUSER_NETWORK_SERVICE_KEY

static final String SOLARUSER_NETWORK_SERVICE_KEY

The getNetworkServiceURLs() key for the SolarUser service.

Since:

1.1

See Also:

• Constant Field Values

SOLARQUERY_NETWORK_SERVICE_KEY

static final String SOLARQUERY_NETWORK_SERVICE_KEY

The getNetworkServiceURLs() key for the SolarQuery service.

Since:

1.1

See Also:

• Constant Field Values

SOLARIN_MQTT_NETWORK_SERVICE_KEY

static final String SOLARIN_MQTT_NETWORK_SERVICE_KEY

The getNetworkServiceURLs() key for the SolarIn MQTT service.

Since:

1.2

See Also:

• Constant Field Values

Method Details

getHost

String getHost()

Get the service host name.

Returns:

map of service host name

getPort

Integer getPort()

The host port to use.

Returns:

the port

isForceTLS

boolean isForceTLS()

Flag indicating if TLS must be used.

Returns:

boolean

getIdentityKey

String getIdentityKey()

Get a universally unique key that identifies this service.

Returns:

unique key

getTermsOfService

String getTermsOfService()

Get the terms of service for this service.

Returns:

the terms of service

getNetworkServiceURLs

Map<String,String> getNetworkServiceURLs()

Get a mapping of pre-defined network service URLs, to be used by clients to provide links to the SolarNetwork they are associated with.

Returns:

a mapping of keys to string URLs

Since:

1.1