Package org.openmuc.jeebus.ship.api

Class ShipNodeConfiguration

java.lang.Object

org.openmuc.jeebus.ship.api.ShipNodeConfiguration

public class ShipNodeConfiguration
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ShipNodeConfiguration(int port, java.lang.String wssPath, boolean keepAlive, java.lang.String serviceId, java.lang.String serviceDomain, java.lang.String serviceInstance, java.lang.String alias, char[] keyStorePassphrase, char[] keyPairPassphrase, java.lang.String distinguishedName, int certificateValidityInDays)	See ShipNodeConfiguration.
ShipNodeConfiguration(int port, java.lang.String wssPath, boolean keepAlive, java.lang.String serviceId, java.lang.String serviceDomain, java.lang.String serviceInstance, java.lang.String alias, java.lang.String certPath, char[] keyStorePassphrase, char[] keyPairPassphrase, java.lang.String distinguishedName, int certificateValidityInDays)	See ShipNodeConfiguration.
ShipNodeConfiguration(java.lang.String ipAddress, int port, java.lang.String wssPath, boolean keepAlive, java.lang.String serviceId, java.lang.String serviceDomain, java.lang.String serviceInstance, java.lang.String alias, char[] keyStorePassphrase, char[] keyPairPassphrase, java.lang.String distinguishedName, int certificateValidityInDays)	Wrapper class for parameters for initial ship node configuration.
ShipNodeConfiguration(java.lang.String ipAddress, int port, java.lang.String wssPath, boolean keepAlive, java.lang.String serviceId, java.lang.String serviceDomain, java.lang.String serviceInstance, java.lang.String alias, java.lang.String certPath, char[] keyStorePassphrase, char[] keyPairPassphrase, java.lang.String distinguishedName, int certificateValidityInDays)	See ShipNodeConfiguration.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAlias()
int	getCertificateValidityInDays()
java.lang.String	getCertPath()
java.lang.String	getDistinguishedName()
java.net.InetAddress	getIpAddress()
char[]	getKeyPairPassphrase()
char[]	getKeyStorePassphrase()
int	getPort()
java.lang.String	getServiceDomain()
java.lang.String	getServiceId()
java.lang.String	getServiceInstance()
java.lang.String	getWssPath()
boolean	isKeepAlive()
void	setAlias(java.lang.String alias)
void	setCertPath(java.lang.String certPath)
void	setIpAddress(java.net.InetAddress ipAddress)
void	setKeepAlive(boolean keepAlive)
void	setPort(int port)
void	setServiceDomain(java.lang.String serviceDomain)
void	setServiceId(java.lang.String serviceId)
void	setServiceInstance(java.lang.String serviceInstance)
void	setWssPath(java.lang.String wssPath)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShipNodeConfiguration

public ShipNodeConfiguration(java.lang.String ipAddress,
                             int port,
                             java.lang.String wssPath,
                             boolean keepAlive,
                             java.lang.String serviceId,
                             java.lang.String serviceDomain,
                             java.lang.String serviceInstance,
                             java.lang.String alias,
                             char[] keyStorePassphrase,
                             char[] keyPairPassphrase,
                             java.lang.String distinguishedName,
                             int certificateValidityInDays)

Wrapper class for parameters for initial ship node configuration. If a certificate should be loaded or stored, use the other constructor instead

Parameters:

ipAddress - ip address of network interface to bind this Ship node to, example: "192.168.1.2"

port - port for initial server

wssPath - wss path for initial server, example: "/ship/"

keepAlive - indicates if keepAlive packets are allowed

serviceId - host name for JmDNS instance (service discovery), example: "EXAMPLEBRAND-EEB01M3EU-001122334455"

serviceDomain - which domain for service types to listen to, example: "local"

serviceInstance - service instance label for initial server, example: "Dishwasher ExampleCompany EEB01M3EU"

alias - the alias for the key pair that should be loaded or created

keyStorePassphrase - passphrase for the whole key store, see KeyManagement class

keyPairPassphrase - passphrase for the key pair to be generated

distinguishedName - X.509 Distinguished Name, eg "CN=Test, L=London, C=GB". For IoT devices, usually the DeviceID

certificateValidityInDays - how many days the certificate should be valid for

ShipNodeConfiguration

public ShipNodeConfiguration(int port,
                             java.lang.String wssPath,
                             boolean keepAlive,
                             java.lang.String serviceId,
                             java.lang.String serviceDomain,
                             java.lang.String serviceInstance,
                             java.lang.String alias,
                             java.lang.String certPath,
                             char[] keyStorePassphrase,
                             char[] keyPairPassphrase,
                             java.lang.String distinguishedName,
                             int certificateValidityInDays)

See ShipNodeConfiguration. This constructor additionally takes a path pointing to an existing certificate and sets the ipAddress to null. For example: "certs/keystore.jks" or "C:/User/Test/certs/keystore.jks". If there is no certificate found at the location, a new certificate will be created in the ShipNode class at the location. Wrapper class for parameters for initial ship node configuration. If a certificate should be loaded or stored, use the other constructor instead

Parameters:

port - port for initial server

wssPath - wss path for initial server, example: "/ship/"

keepAlive - indicates if keepAlive packets are allowed

serviceId - host name for JmDNS instance (service discovery), example: "EXAMPLEBRAND-EEB01M3EU-001122334455"

serviceDomain - which domain for service types to listen to, example: "local"

serviceInstance - service instance label for initial server, example: "Dishwasher ExampleCompany EEB01M3EU"

alias - the alias for the key pair that should be loaded or created

certPath - path pointing to an existing certificate

keyStorePassphrase - passphrase for the whole key store, see KeyManagement class

keyPairPassphrase - passphrase for the key pair to be generated

distinguishedName - X.509 Distinguished Name, eg "CN=Test, L=London, C=GB". For IoT devices, usually the DeviceID

certificateValidityInDays - how many days the certificate should be valid for

ShipNodeConfiguration

public ShipNodeConfiguration(java.lang.String ipAddress,
                             int port,
                             java.lang.String wssPath,
                             boolean keepAlive,
                             java.lang.String serviceId,
                             java.lang.String serviceDomain,
                             java.lang.String serviceInstance,
                             java.lang.String alias,
                             java.lang.String certPath,
                             char[] keyStorePassphrase,
                             char[] keyPairPassphrase,
                             java.lang.String distinguishedName,
                             int certificateValidityInDays)

See ShipNodeConfiguration. This constructor additionally takes a path pointing to an existing certificate, and an ipAddress. For example: "certs/keystore.jks" or "C:/User/Test/certs/keystore.jks". If there is no certificate found at the location, a new certificate will be created in the ShipNode class at the location

Parameters:

ipAddress - IP address of network interface to bind this Ship node to, example: "192.168.1.2"

port - port for initial server

wssPath - wss path for initial server, example: "/ship/"

keepAlive - indicates if keepAlive packets are allowed

serviceId - host name for JmDNS instance (service discovery), example: "EXAMPLEBRAND-EEB01M3EU-001122334455"

serviceDomain - which domain for service types to listen to, example: "local"

serviceInstance - service instance label for initial server, example: "Dishwasher ExampleCompany EEB01M3EU"

alias - the alias for the key pair that should be loaded or created

certPath - path pointing to an existing certificate

keyStorePassphrase - passphrase for the whole key store, see KeyManagement class

keyPairPassphrase - passphrase for the key pair to be generated

distinguishedName - X.509 Distinguished Name, eg "CN=Test, L=London, C=GB". For IoT devices, usually the DeviceID

certificateValidityInDays - how many days the certificate should be valid for

ShipNodeConfiguration

public ShipNodeConfiguration(int port,
                             java.lang.String wssPath,
                             boolean keepAlive,
                             java.lang.String serviceId,
                             java.lang.String serviceDomain,
                             java.lang.String serviceInstance,
                             java.lang.String alias,
                             char[] keyStorePassphrase,
                             char[] keyPairPassphrase,
                             java.lang.String distinguishedName,
                             int certificateValidityInDays)

See ShipNodeConfiguration. this constructor sets the ipAddress to null, so the ShipNode will take the IP address of an arbitrary network interface to bind the connection to.

Parameters:

port - port for initial server

wssPath - wss path for initial server, example: "/ship/"

keepAlive - indicates if keepAlive packets are allowed

serviceId - host name for JmDNS instance (service discovery), example: "EXAMPLEBRAND-EEB01M3EU-001122334455"

serviceDomain - which domain for service types to listen to, example: "local"

serviceInstance - service instance label for initial server, example: "Dishwasher ExampleCompany EEB01M3EU"

alias - the alias for the key pair that should be loaded or created

keyStorePassphrase - passphrase for the whole key store, see KeyManagement class

keyPairPassphrase - passphrase for the key pair to be generated

distinguishedName - X.509 Distinguished Name, eg "CN=Test, L=London, C=GB". For IoT devices, usually the DeviceID

certificateValidityInDays - how many days the certificate should be valid for

Method Detail

getIpAddress

public java.net.InetAddress getIpAddress()

setIpAddress

public void setIpAddress(java.net.InetAddress ipAddress)

getPort

public int getPort()

setPort

public void setPort(int port)

getWssPath

public java.lang.String getWssPath()

setWssPath

public void setWssPath(java.lang.String wssPath)

isKeepAlive

public boolean isKeepAlive()

setKeepAlive

public void setKeepAlive(boolean keepAlive)

getServiceId

public java.lang.String getServiceId()

setServiceId

public void setServiceId(java.lang.String serviceId)

getServiceDomain

public java.lang.String getServiceDomain()

setServiceDomain

public void setServiceDomain(java.lang.String serviceDomain)

getServiceInstance

public java.lang.String getServiceInstance()

setServiceInstance

public void setServiceInstance(java.lang.String serviceInstance)

getAlias

public java.lang.String getAlias()

setAlias

public void setAlias(java.lang.String alias)

getCertPath

public java.lang.String getCertPath()

setCertPath

public void setCertPath(java.lang.String certPath)

getKeyStorePassphrase

public char[] getKeyStorePassphrase()

getKeyPairPassphrase

public char[] getKeyPairPassphrase()

getDistinguishedName

public java.lang.String getDistinguishedName()

getCertificateValidityInDays

public int getCertificateValidityInDays()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object