com.openinventor.remoteviz.rendering

Class ServiceSettings

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.remoteviz.rendering.ServiceSettings

All Implemented Interfaces:

java.lang.Cloneable

public class ServiceSettings
extends Inventor
implements java.lang.Cloneable

Settings that define the rendering Service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceSettings.Extensions Each enumeration represents an Open Inventor extension.
static class	ServiceSettings.RunModes The run mode is used to change the behaviour of the RemoteViz execution in three environments.
static class	ServiceSettings.SecurityProtocols Each enumeration represents a security protocol.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
ServiceSettings() Constructor.
ServiceSettings(ServiceSettings obj) Copy constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
void	enableSecureConnection(java.lang.String publicCertificateFilePath, java.lang.String privateKeyFilePath) Calls enableSecureConnection(publicCertificateFilePath, privateKeyFilePath, java.util.EnumSet.of( ServiceSettings.SecurityProtocols.TLSv1_1, ServiceSettings.SecurityProtocols.TLSv1_2, ServiceSettings.SecurityProtocols.TLSv1_3 )).
void	enableSecureConnection(java.lang.String publicCertificateFilePath, java.lang.String privateKeyFilePath, java.util.EnumSet<ServiceSettings.SecurityProtocols> enabledSecurityProtocols) Secures the connection between the server and the clients.
void	enableSecureConnection(java.lang.String publicCertificateFilePath, java.lang.String privateKeyFilePath, int enabledSecurityProtocols) Deprecated. As of Open Inventor 9.8.0, use #enableSecureConnection(java.lang.String publicCertificateFilePath, java.lang.String privateKeyFilePath, java.util.EnumSet enabledSecurityProtocols) instead.
void	enableSecureConnection(java.lang.String publicCertificateFilePath, java.lang.String privateKeyFilePath, ServiceSettings.SecurityProtocols enabledSecurityProtocols) Deprecated. As of Open Inventor 9.7.2, use enableSecureConnection(java.lang.String publicCertificateFilePath, java.lang.String privateKeyFilePath, int enabledSecurityProtocols) instead.
ServiceSettings.SecurityProtocols	getEnabledSecurityProtocols() Gets the security procotols used in RemoteViz.
java.lang.String	getHostname() Gets the current host name.
java.lang.String	getIP() Gets the IP address.
Monitoring	getMonitoring() Gets the monitoring object which allows to manage metrics listeners that monitor states and performances of the service.
java.util.EnumSet<ServiceSettings.Extensions>	getOivUsedExtensions() Gets the used Open Inventor extensions.
short	getPort() Gets the port of the service.
java.lang.String	getPrivateKeyFile() Gets the private key used to sign the server key exchange between the client and the server.
java.lang.String	getPublicCertificateFile() Gets the public certificate authenticating the server to the clients.
ServiceSettings.RunModes	getRunMode() Gets the run mode of the service.
ServiceSettings.Extensions	getUsedExtensions() Deprecated. As of Open Inventor 9800. See documentation for more details.
boolean	isSecureConnection() Gets the SSL engine activation.
void	setIP(java.lang.String ip) Sets the IP address.
void	setOivUsedExtensions(java.util.EnumSet<ServiceSettings.Extensions> extensions) Sets the Open Inventor extensions used by a RemoteViz application.
void	setPort(short port) Sets the port of the service.
void	setRunMode(ServiceSettings.RunModes runmode) Sets the run mode of the service.
void	setUsedExtensions(ServiceSettings.Extensions extensions) Deprecated. As of Open Inventor 9800. See documentation for more details.

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getNativeResourceHandle

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceSettings

public ServiceSettings(ServiceSettings obj)

Copy constructor.

ServiceSettings

public ServiceSettings()

Constructor.

Method Detail

enableSecureConnection

@Deprecated
public void enableSecureConnection(java.lang.String publicCertificateFilePath,
                                                java.lang.String privateKeyFilePath,
                                                ServiceSettings.SecurityProtocols enabledSecurityProtocols)

Deprecated. As of Open Inventor 9.7.2, use enableSecureConnection(java.lang.String publicCertificateFilePath, java.lang.String privateKeyFilePath, int enabledSecurityProtocols) instead.

Secures the connection between the server and the clients.
Deprecated since Open Inventor 9720
Use enableSecureConnection method instead.

Parameters:

publicCertificateFilePath - : Path to a file containing the public certificate used to authenticate the server to the clients. The certificate has to be a PEM ("Privacy Enhanced Mail") encoded certificate.

privateKeyFilePath - : Path to a file containing the private key used to sign the server key exchange between the client and the server. If the private key is protected by a passphrase, set the passphrase into the ServiceListener.onRequestedPrivateKeyPassphrase callback.

enabledSecurityProtocols - : Defines the security protocols used to secure the exchange between the client and the server. By default, the TLSv1, TLSv1.1 and TLSv1.2 protocols are enabled. A bitmask of the security protocols is used. Many security protocols can be enabled by using the logical OR operator.

enableSecureConnection

@Deprecated
public void enableSecureConnection(java.lang.String publicCertificateFilePath,
                                                java.lang.String privateKeyFilePath,
                                                int enabledSecurityProtocols)

Deprecated. As of Open Inventor 9.8.0, use #enableSecureConnection(java.lang.String publicCertificateFilePath, java.lang.String privateKeyFilePath, java.util.EnumSet enabledSecurityProtocols) instead.

Secures the connection between the server and the clients.
Deprecated since Open Inventor 9800
Use enableSecureConnection method instead.

Parameters:

publicCertificateFilePath - : Path to a file containing the public certificate used to authenticate the server to the clients. The certificate has to be a PEM ("Privacy Enhanced Mail") encoded certificate.

privateKeyFilePath - : Path to a file containing the private key used to sign the server key exchange between the client and the server. If the private key is protected by a passphrase, set the passphrase into the ServiceListener.onRequestedPrivateKeyPassphrase callback.

enabledSecurityProtocols - : Defines the security protocols used to secure the exchange between the client and the server. By default, the TLSv1, TLSv1.1 and TLSv1.2 protocols are enabled. A bitmask of the security protocols is used. Many security protocols can be enabled by using the logical OR operator.

getUsedExtensions

@Deprecated
public ServiceSettings.Extensions getUsedExtensions()

Deprecated. As of Open Inventor 9800. See documentation for more details.

Gets the used Open Inventor extensions.
Deprecated since Open Inventor 9800
Use getOivUsedExtensions method instead.

Returns:

the bitmask of used Open Inventor extensions.

setUsedExtensions

@Deprecated
public void setUsedExtensions(ServiceSettings.Extensions extensions)

Deprecated. As of Open Inventor 9800. See documentation for more details.

Sets the Open Inventor extensions used in RemoteViz. In addition to one Open Inventor and one RemoteViz license, a license of each used extension will be required to start the service and will be checked out for each connected client.
Deprecated since Open Inventor 9800
Use setOivUsedExtensions method instead. The activation of VolumeVizLDM extension will lead to the activation of VolumeViz extension.

Parameters:

extensions - : the bitmask of the Open Inventor extensions used in RemoteViz. Many extensions can be activated by using the logical OR operator.
For example : setUsedExtensions(VOLUMEVIZ | MESHVIZ)

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

enableSecureConnection

public void enableSecureConnection(java.lang.String publicCertificateFilePath,
                                   java.lang.String privateKeyFilePath)

Calls enableSecureConnection(publicCertificateFilePath, privateKeyFilePath, java.util.EnumSet.of( ServiceSettings.SecurityProtocols.TLSv1_1, ServiceSettings.SecurityProtocols.TLSv1_2, ServiceSettings.SecurityProtocols.TLSv1_3 )).

setPort

public void setPort(short port)

Sets the port of the service. Default value is 8080.
In case you are behind a firewall, please ensure your IT department configured the firewall to accommodate the selected port.

Parameters:

port - : the port used by the instance

getPublicCertificateFile

public java.lang.String getPublicCertificateFile()

Gets the public certificate authenticating the server to the clients.

Returns:

the path to the file containing the certificate.

setIP

public void setIP(java.lang.String ip)

Sets the IP address.
IP version 4 (IPv4: X.X.X.X) and IP version 6 (IPv6: X.X.X.X.X.X.X.X) are supported. Default value is "auto"
If you set the value to "auto", an IPv4 address will be automatically selected among the available interfaces.

Parameters:

ip - : the IP address used by the instance

getOivUsedExtensions

public java.util.EnumSet<ServiceSettings.Extensions> getOivUsedExtensions()

Gets the used Open Inventor extensions.

Returns:

the bitmask of used Open Inventor extensions.

getIP

public java.lang.String getIP()

Gets the IP address. Default value is "auto".

Returns:

the IP address used by the instance

getPrivateKeyFile

public java.lang.String getPrivateKeyFile()

Gets the private key used to sign the server key exchange between the client and the server.

Returns:

the path to the file containing the private key.

getHostname

public java.lang.String getHostname()

Gets the current host name.

Returns:

the current host name

isSecureConnection

public boolean isSecureConnection()

Gets the SSL engine activation.

Returns:

true if the secure connection is enabled.

enableSecureConnection

public void enableSecureConnection(java.lang.String publicCertificateFilePath,
                                   java.lang.String privateKeyFilePath,
                                   java.util.EnumSet<ServiceSettings.SecurityProtocols> enabledSecurityProtocols)

Secures the connection between the server and the clients.

Parameters:

publicCertificateFilePath - : Path to a file containing the public certificate used to authenticate the server to the clients. The certificate has to be a PEM ("Privacy Enhanced Mail") encoded certificate.

privateKeyFilePath - : Path to a file containing the private key used to sign the server key exchange between the client and the server. If the private key is protected by a passphrase, set the passphrase into the ServiceListener.onRequestedPrivateKeyPassphrase callback.

enabledSecurityProtocols - : Defines the security protocols used to secure the exchange between the client and the server. By default, TLSv1.1, TLSv1.2 and TLSv1.3 protocols are enabled. A bitmask of the security protocols is used. Many security protocols can be enabled by using the logical OR operator.

getMonitoring

public Monitoring getMonitoring()

Gets the monitoring object which allows to manage metrics listeners that monitor states and performances of the service.

Returns:

a pointer to the monitoring object.

setOivUsedExtensions

public void setOivUsedExtensions(java.util.EnumSet<ServiceSettings.Extensions> extensions)

Sets the Open Inventor extensions used by a RemoteViz application. Convenience method that will be used by Service.open() to check if all the licenses necessary to start the Service are available (necessary licenses are explained below) RemoteViz and Open Inventor (if used) is protected by a license key mechanism that limits its usage to specified computers or network environments based on a commercial agreement. Depending on the license agreement, license keys are floating licenses managed by a license server or an encrypted "master password" string (see SoLockManager).

If the Service uses Open Inventor for rendering (runMode is not INDEPENDENT_SERVICE), then one Open Inventor license plus one license of each used extension is required to start the service. (An SDK license for development/debugging or a Runtime license for deployment.) If this method was called and licenses are missing, Service.open() will return false. If this method was not called, the licenses will not be checked until the first call to create an Open Inventor node. Alternatively the application can do explicit license checks by calling SoLicensesInfo.check() before opening the Service or creating any Open Inventor nodes. Note: Enabling the VolumeVizLDM extension automatically enables the VolumeViz extension.

One RemoteViz license is required for each Connection created. (An SDK license for development/debugging or a Runtime license for deployment.) If the RemoteViz license is missing when a Connection is needed, ServiceListener.onMissingLicense() will be called.

When using the run mode INDEPENDENT_SERVICE, this method has no effect, i.e., no Open Inventor licenses will be required to start the service.

Parameters:

extensions - : the bitmask of the Open Inventor extensions used in RemoteViz. Many extensions can be activated by using the logical OR operator.
For example : setUsedExtensions(VOLUMEVIZ | MESHVIZ)

getPort

public short getPort()

Gets the port of the service. Default value is 8080.

Returns:

the port used by the instance

setRunMode

public void setRunMode(ServiceSettings.RunModes runmode)

Sets the run mode of the service. Default value is INVENTOR_SERVICE.

Parameters:

runmode - : the type of run mode used by the instance

getRunMode

public ServiceSettings.RunModes getRunMode()

Gets the run mode of the service. Default value is INVENTOR_SERVICE.

Returns:

the run mode used by the instance

getEnabledSecurityProtocols

public ServiceSettings.SecurityProtocols getEnabledSecurityProtocols()

Gets the security procotols used in RemoteViz.

Returns:

the bitmask of used security protocols.