Package net.solarnetwork.node.service
Interface IdentityService
public interface IdentityService
API for knowing information about the node's identity.
- Version:
- 1.2
- Author:
- matt
-
Method Summary
Modifier and TypeMethodDescriptionGet the ID of the current node.Get aPrincipalfor the current node.Return an absolute URL to the SolarIn service.Get the URL to the SolarIn MQTT service.Get the host name for the SolarNet central service.Get the host port for the SolarNet central service.Get the URL prefix for the SolarIn service.
-
Method Details
-
getNodeId
Long getNodeId()Get the ID of the current node.- Returns:
- node ID, or null if the ID is not known
-
getNodePrincipal
Principal getNodePrincipal()Get aPrincipalfor the current node.- Returns:
- The node Principal, or null if none available.
-
getSolarNetHostName
String getSolarNetHostName()Get the host name for the SolarNet central service.- Returns:
- a host name
-
getSolarNetHostPort
Integer getSolarNetHostPort()Get the host port for the SolarNet central service.- Returns:
- a host name
-
getSolarNetSolarInUrlPrefix
String getSolarNetSolarInUrlPrefix()Get the URL prefix for the SolarIn service.- Returns:
- a URL prefix
-
getSolarInBaseUrl
String getSolarInBaseUrl()Return an absolute URL to the SolarIn service.This is a convenience method for generating a URL for the correct SolarNet host, SolarNet port, and SolarIn URL prefix as a single absolute URL string.
- Returns:
- SolarIn base URL
-
getSolarInMqttUrl
String getSolarInMqttUrl()Get the URL to the SolarIn MQTT service.- Returns:
- the SolarIn MQTT URL, or null if not available
- Since:
- 1.2
-