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

Modifier and Type	Field and Description
static int	CATIA5READER Deprecated. Use ServiceSettings.Extensions.CATIA5READER instead.
static int	CATIA6READER Deprecated. Use ServiceSettings.Extensions.CATIA6READER instead.
static int	DWGREADER Deprecated. Use ServiceSettings.Extensions.DWGREADER instead.
static int	HARDCOPY Deprecated. Use ServiceSettings.Extensions.HARDCOPY instead.
static int	IGESREADER Deprecated. Use ServiceSettings.Extensions.IGESREADER instead.
static int	IMAGEVIZ Deprecated. Use ServiceSettings.Extensions.IMAGEVIZ instead.
static int	INDEPENDENT_SERVICE Deprecated. Use ServiceSettings.RunModes.INDEPENDENT_SERVICE instead.
static int	INVENTOR_APPLICATION Deprecated. Use ServiceSettings.RunModes.INVENTOR_APPLICATION instead.
static int	INVENTOR_SERVICE Deprecated. Use ServiceSettings.RunModes.INVENTOR_SERVICE instead.
static int	JTREADER Deprecated. Use ServiceSettings.Extensions.JTREADER instead.
static int	MESHVIZ Deprecated. Use ServiceSettings.Extensions.MESHVIZ instead.
static int	MESHVIZXLM Deprecated. Use ServiceSettings.Extensions.MESHVIZXLM instead.
static int	PROEREADER Deprecated. Use ServiceSettings.Extensions.PROEREADER instead.
static int	SOLIDEDGEREADER Deprecated. Use ServiceSettings.Extensions.SOLIDEDGEREADER instead.
static int	SOLIDWORKSREADER Deprecated. Use ServiceSettings.Extensions.SOLIDWORKSREADER instead.
static int	SSLv2 Deprecated. Use ServiceSettings.SecurityProtocols.SSLv2 instead.
static int	SSLv3 Deprecated. Use ServiceSettings.SecurityProtocols.SSLv3 instead.
static int	STEPREADER Deprecated. Use ServiceSettings.Extensions.STEPREADER instead.
static int	TLSv1 Deprecated. Use ServiceSettings.SecurityProtocols.TLSv1 instead.
static int	TLSv1_1 Deprecated. Use ServiceSettings.SecurityProtocols.TLSv1_1 instead.
static int	TLSv1_2 Deprecated. Use ServiceSettings.SecurityProtocols.TLSv1_2 instead.
static int	UGREADER Deprecated. Use ServiceSettings.Extensions.UGREADER instead.
static int	VDAREADER Deprecated. Use ServiceSettings.Extensions.VDAREADER instead.
static int	VOLUMEVIZ Deprecated. Use ServiceSettings.Extensions.VOLUMEVIZ instead.
static int	VOLUMEVIZLDM Deprecated. Use ServiceSettings.Extensions.VOLUMEVIZLDM instead.
static int	XMTREADER Deprecated. Use ServiceSettings.Extensions.XMTREADER instead.

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, ServiceSettings.SecurityProtocols.TLSv1_1, ServiceSettings.SecurityProtocols.TLSv1_2 )).
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.
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 in RemoteViz.
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, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

INVENTOR_SERVICE

@Deprecated
public static final int INVENTOR_SERVICE

Deprecated. Use ServiceSettings.RunModes.INVENTOR_SERVICE instead.

INVENTOR_APPLICATION

@Deprecated
public static final int INVENTOR_APPLICATION

Deprecated. Use ServiceSettings.RunModes.INVENTOR_APPLICATION instead.

INDEPENDENT_SERVICE

@Deprecated
public static final int INDEPENDENT_SERVICE

Deprecated. Use ServiceSettings.RunModes.INDEPENDENT_SERVICE instead.

VOLUMEVIZ

@Deprecated
public static final int VOLUMEVIZ

Deprecated. Use ServiceSettings.Extensions.VOLUMEVIZ instead.

VOLUMEVIZLDM

@Deprecated
public static final int VOLUMEVIZLDM

Deprecated. Use ServiceSettings.Extensions.VOLUMEVIZLDM instead.

MESHVIZ

@Deprecated
public static final int MESHVIZ

Deprecated. Use ServiceSettings.Extensions.MESHVIZ instead.

MESHVIZXLM

@Deprecated
public static final int MESHVIZXLM

Deprecated. Use ServiceSettings.Extensions.MESHVIZXLM instead.

IMAGEVIZ

@Deprecated
public static final int IMAGEVIZ

Deprecated. Use ServiceSettings.Extensions.IMAGEVIZ instead.

HARDCOPY

@Deprecated
public static final int HARDCOPY

Deprecated. Use ServiceSettings.Extensions.HARDCOPY instead.

CATIA5READER

@Deprecated
public static final int CATIA5READER

Deprecated. Use ServiceSettings.Extensions.CATIA5READER instead.

CATIA6READER

@Deprecated
public static final int CATIA6READER

Deprecated. Use ServiceSettings.Extensions.CATIA6READER instead.

DWGREADER

@Deprecated
public static final int DWGREADER

Deprecated. Use ServiceSettings.Extensions.DWGREADER instead.

IGESREADER

@Deprecated
public static final int IGESREADER

Deprecated. Use ServiceSettings.Extensions.IGESREADER instead.

JTREADER

@Deprecated
public static final int JTREADER

Deprecated. Use ServiceSettings.Extensions.JTREADER instead.

PROEREADER

@Deprecated
public static final int PROEREADER

Deprecated. Use ServiceSettings.Extensions.PROEREADER instead.

SOLIDEDGEREADER

@Deprecated
public static final int SOLIDEDGEREADER

Deprecated. Use ServiceSettings.Extensions.SOLIDEDGEREADER instead.

STEPREADER

@Deprecated
public static final int STEPREADER

Deprecated. Use ServiceSettings.Extensions.STEPREADER instead.

SOLIDWORKSREADER

@Deprecated
public static final int SOLIDWORKSREADER

Deprecated. Use ServiceSettings.Extensions.SOLIDWORKSREADER instead.

UGREADER

@Deprecated
public static final int UGREADER

Deprecated. Use ServiceSettings.Extensions.UGREADER instead.

VDAREADER

@Deprecated
public static final int VDAREADER

Deprecated. Use ServiceSettings.Extensions.VDAREADER instead.

XMTREADER

@Deprecated
public static final int XMTREADER

Deprecated. Use ServiceSettings.Extensions.XMTREADER instead.

SSLv2

@Deprecated
public static final int SSLv2

Deprecated. Use ServiceSettings.SecurityProtocols.SSLv2 instead.

SSLv3

@Deprecated
public static final int SSLv3

Deprecated. Use ServiceSettings.SecurityProtocols.SSLv3 instead.

TLSv1

@Deprecated
public static final int TLSv1

Deprecated. Use ServiceSettings.SecurityProtocols.TLSv1 instead.

TLSv1_1

@Deprecated
public static final int TLSv1_1

Deprecated. Use ServiceSettings.SecurityProtocols.TLSv1_1 instead.

TLSv1_2

@Deprecated
public static final int TLSv1_2

Deprecated. Use ServiceSettings.SecurityProtocols.TLSv1_2 instead.

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)

enableSecureConnection

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

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

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

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.

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, 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.

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

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

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

getEnabledSecurityProtocols

public ServiceSettings.SecurityProtocols getEnabledSecurityProtocols()

Gets the security procotols used in RemoteViz.

Returns:

the bitmask of used security protocols.

isSecureConnection

public boolean isSecureConnection()

Gets the SSL engine activation.

Returns:

true if the secure connection is enabled.

getOivUsedExtensions

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

Gets the used Open Inventor extensions.

Returns:

the bitmask of used Open Inventor extensions.

setOivUsedExtensions

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

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.
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)

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