Package net.solarnetwork.domain

Class BasicNetworkIdentity

java.lang.Object

net.solarnetwork.domain.BasicNetworkIdentity

All Implemented Interfaces:

Serializable, NetworkIdentity

Direct Known Subclasses:

NetworkAssociationDetails

public class BasicNetworkIdentity
extends Object
implements NetworkIdentity, Serializable

Basic implementation of NetworkIdentity.

Version:

1.2

Author:

matt

See Also:

• Serialized Form

Field Summary

Fields inherited from interface net.solarnetwork.domain.NetworkIdentity

SOLARIN_MQTT_NETWORK_SERVICE_KEY, SOLARQUERY_NETWORK_SERVICE_KEY, SOLARUSER_NETWORK_SERVICE_KEY

Constructor Summary

Constructors

Constructor	Description
BasicNetworkIdentity()	Default constructor.
BasicNetworkIdentity(String identityKey, String termsOfService, String host, Integer port, Boolean forceTLS)	Construct with an identity key.

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	getSolarInMqttServiceURL()	Get the NetworkIdentity.SOLARIN_MQTT_NETWORK_SERVICE_KEY networkServiceURLs value.
String	getSolarQueryServiceURL()	Get the NetworkIdentity.SOLARQUERY_NETWORK_SERVICE_KEY networkServiceURLs value.
String	getSolarUserServiceURL()	Get the NetworkIdentity.SOLARUSER_NETWORK_SERVICE_KEY networkServiceURLs value.
String	getTermsOfService()	Get the terms of service for this service.
boolean	isForceTLS()	Flag indicating if TLS must be used.
void	setForceTLS(boolean forceTLS)
void	setHost(String host)
void	setIdentityKey(String identityKey)
void	setNetworkServiceURLs(Map<String,String> networkServiceURLs)
void	setPort(Integer port)
void	setSolarInMqttServiceURL(String url)	Put a networkServiceURLs value for the NetworkIdentity.SOLARIN_MQTT_NETWORK_SERVICE_KEY key.
void	setSolarQueryServiceURL(String url)	Put a networkServiceURLs value for the NetworkIdentity.SOLARQUERY_NETWORK_SERVICE_KEY key.
void	setSolarUserServiceURL(String url)	Put a networkServiceURLs value for the NetworkIdentity.SOLARUSER_NETWORK_SERVICE_KEY key.
void	setTermsOfService(String termsOfService)

Methods inherited from class java.lang.Object

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

Constructor Details

BasicNetworkIdentity

public BasicNetworkIdentity()

Default constructor.

BasicNetworkIdentity

public BasicNetworkIdentity(String identityKey,
 String termsOfService,
 String host,
 Integer port,
 Boolean forceTLS)

Construct with an identity key.

Parameters:

identityKey - the identity key

termsOfService - the TOS

host - the service host

port - the service port

forceTLS - true if TLS should be used on a port other than 443

Method Details

getIdentityKey

public String getIdentityKey()

Description copied from interface: NetworkIdentity

Get a universally unique key that identifies this service.

Specified by:

getIdentityKey in interface NetworkIdentity

Returns:

unique key

getTermsOfService

public String getTermsOfService()

Description copied from interface: NetworkIdentity

Get the terms of service for this service.

Specified by:

getTermsOfService in interface NetworkIdentity

Returns:

the terms of service

getHost

public String getHost()

Description copied from interface: NetworkIdentity

Get the service host name.

Specified by:

getHost in interface NetworkIdentity

Returns:

map of service host name

getPort

public Integer getPort()

Description copied from interface: NetworkIdentity

The host port to use.

Specified by:

getPort in interface NetworkIdentity

Returns:

the port

isForceTLS

public boolean isForceTLS()

Description copied from interface: NetworkIdentity

Flag indicating if TLS must be used.

Specified by:

isForceTLS in interface NetworkIdentity

Returns:

boolean

setIdentityKey

public void setIdentityKey(String identityKey)

setTermsOfService

public void setTermsOfService(String termsOfService)

setHost

public void setHost(String host)

setPort

public void setPort(Integer port)

setForceTLS

public void setForceTLS(boolean forceTLS)

getNetworkServiceURLs

public Map<String,String> getNetworkServiceURLs()

Description copied from interface: NetworkIdentity

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

Specified by:

getNetworkServiceURLs in interface NetworkIdentity

Returns:

a mapping of keys to string URLs

setNetworkServiceURLs

public void setNetworkServiceURLs(Map<String,String> networkServiceURLs)

setSolarUserServiceURL

public void setSolarUserServiceURL(String url)

Put a networkServiceURLs value for the NetworkIdentity.SOLARUSER_NETWORK_SERVICE_KEY key.

Parameters:

url - The URL to set, or null to remove.

getSolarUserServiceURL

public String getSolarUserServiceURL()

Get the NetworkIdentity.SOLARUSER_NETWORK_SERVICE_KEY networkServiceURLs value.

Returns:

the URL

setSolarQueryServiceURL

public void setSolarQueryServiceURL(String url)

Put a networkServiceURLs value for the NetworkIdentity.SOLARQUERY_NETWORK_SERVICE_KEY key.

Parameters:

url - The URL to set, or null to remove.

getSolarQueryServiceURL

public String getSolarQueryServiceURL()

Get the NetworkIdentity.SOLARQUERY_NETWORK_SERVICE_KEY networkServiceURLs value.

Returns:

the URL

setSolarInMqttServiceURL

public void setSolarInMqttServiceURL(String url)

Put a networkServiceURLs value for the NetworkIdentity.SOLARIN_MQTT_NETWORK_SERVICE_KEY key.

Parameters:

url - The URL to set, or null to remove.

getSolarInMqttServiceURL

public String getSolarInMqttServiceURL()

Get the NetworkIdentity.SOLARIN_MQTT_NETWORK_SERVICE_KEY networkServiceURLs value.

Returns:

the URL