Package de.mid.innovator.srv

Class LicenseServer

java.lang.Object

de.mid.innovator.srv.LicenseServer

All Implemented Interfaces:

ILicensingService, INetworkInformationService

public class LicenseServer
extends Object
implements ILicensingService, INetworkInformationService

The class represents an Innovator license server that provides various information about running client and server programs. A license server acts as a name service to enable clients to find running servers. This means that one license server provides exactly one Innovator network which can be viewed with the Innovator client programs. An Innovator network consists of exactly one main license server and several project license servers (acting as clients to the main license server).

By default, all Innovator UNIX clients use the environment variable INOHOST to determine the Innovator network. On Windows platforms, the license server can be configured in the file inoenv.ini that can be found in the Windows system directory.

As the Innovator Java API uses pure Java code, it is 100% independent of this client configuration; this means that a Java process is free to talk to any license server that is available via TCP/IP connection.

Note: This class can be used to connect either to a project license server or to a main (enterprise) license server.

Author:

borschet

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LicenseServer.License

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VERS_STRING

Constructor Summary

Constructors

Constructor	Description
LicenseServer()	The default constructor that instantiates a license server object using host and port from the environment variable INOHOST or property de.mid.innovator.inohost.
LicenseServer(int pid, String iHost, String ipAdr, String userName, String displayName)	The constructor creates an instance that can be used to communicate with the Innovator license server.
LicenseServer(String lHost, int lPort)	Only for JNI.
LicenseServer(String lHost, int lPort, boolean useTLS, String tlsConfig, boolean useIPv6, boolean useNAT)	The constructor creates an instance that can be used to communicate with the Innovator license server.

Method Summary

Modifier and Type	Method	Description
boolean	canLogout(String repName, String mdlName)
LicSrvUserChkMdlAdminReplyTelegram.SsoMdlUserData	chkMdlAdmin(InoUser user, String repName, String mdlName, K_ADMODEL mdlType)	Returns a flag if repository admin login is allowed.
LicSrvUserChkRepAdminReplyTelegram.SsoUserData	chkVersAdmin(InoUser user, String repName, String mdlName, K_ADMODEL mdlType)	Returns a flag if repository admin login is allowed.
LicSrvUserChkMdlAdminReplyTelegram.SsoMdlUserData	chkVersMdlAdmin(InoUser user, String repName, String mdlName, K_ADMODEL mdlType, String versName)	Returns a flag if repository admin login is allowed.
RepositoryServer	findServer(String repName)	Finds a specific running repository server.
LSrvClientData	getClientInfo()
InoProgram.Type	getConnectedProgram()
String	getHost()	Gets the license server's getHost() name.
String	getHostId()	Gets the host id.
List<InoNetClient>	getInnovatorClients()	Returns a list of all known clients.
String	getInohost()
int	getLicenseCount(LicenseServer.License lic)	Gets the total number of licenses of a given license type.
String	getLicensee()	Gets the licensee.
String	getMainInohost()
int	getPort()	Gets the license server's TCP/IP port.
InoProxyProgram	getProxy(de.mid.innovator.srv.LicSrvGetSrvPrjListReplyTelegram.SrvConData conData)	The method retrieves the complete list of proxys known by this license server.
List<InoProxyProgram>	getProxyList()	The method retrieves the complete list of proxys known by this license server.
int	getSerialNumber()
List<RepositoryServer>	getServerList()	The method retrieves the complete list of repository servers known by this license server.
EnumSet<ServerStatus>	getServerStatus(String repName)	The method returns a set of runtime status flags of the given repository server.
String	getSvgServer()	The method retrieves the complete list of repository servers known by this license server.
InoUser	getUser()	Returns the info for the current system user.
String	getUserJWT()
List<InoUser>	getUserList()
List<de.mid.innovator.srv.LicSrvGetLoginListReplyTelegram.InoUserLogin>	getUserLoginList()
List<String>	getUserRoleList(InoUser inoUser, String repName, String mdlName, K_ADMODEL mdlType)
List<String>	getUserVersRoleList(InoUser inoUser, String repName, String mdlName, K_ADMODEL mdlType, String versName)
InoVersion	getVersion()	Retrieves the version of the license server.
boolean	hasEnvironRight(InoUser user)	Returns a flag if configuration of environments is allowed.
boolean	isLicenseRegistered()	Determines whether [is license registered].
boolean	isSubscription()
void	lockLicense(LicenseServer.License license)	Locks another license of given type.
void	registerLicense(String key)	Registers a new obtained license.
void	registerProgram(InoProgram.Type progType)
void	sendLicenseFile(FileInputStream fs)
void	setClientInfo(int pid, String iHost, String ipAdr, String userName, String displayName)
void	unregisterProgram()
void	unregisterProgram(InoProgram.Type programType)
void	updateConnection()

Methods inherited from class java.lang.Object

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

Field Details

VERS_STRING

public static final String VERS_STRING

See Also:

• Constant Field Values

Constructor Details

LicenseServer

public LicenseServer()
              throws InoNetException

The default constructor that instantiates a license server object using host and port from the environment variable INOHOST or property de.mid.innovator.inohost.

Throws:

InoNetException

LicenseServer

public LicenseServer(String lHost,
 int lPort)
              throws InoNetException

Only for JNI.

Parameters:

lHost -

lPort -

Throws:

InoNetException

LicenseServer

public LicenseServer(String lHost,
 int lPort,
 boolean useTLS,
 String tlsConfig,
 boolean useIPv6,
 boolean useNAT)
              throws InoNetException

The constructor creates an instance that can be used to communicate with the Innovator license server. A host and port can be entered if required to be used when connecting to or disconnecting from the license server.

Parameters:

lHost - optional; the host name as a TCP/IP host name String. If this argument is omitted, the value of the environment variable 'INOHOST' or the 'de.mid.innovator.inohost' system property is used.

lPort - optional; the port. It should be omitted if no host name is given.

useTLS - optional; Use secure communication via SSL / TLS?

tlsConfig - optional; Path and filename of JSON configuration file with path and password of trust store.

useIPv6 - optional; Use addresses in format IPv6?

useNAT - optional; Use NAT(the addresses are not reachable)?

Throws:

InoNetException

LicenseServer

public LicenseServer(int pid,
 String iHost,
 String ipAdr,
 String userName,
 String displayName)
              throws InoNetException

The constructor creates an instance that can be used to communicate with the Innovator license server. A host and port can be entered if required to be used when connecting to or disconnecting from the license server. Shortcut for: licSrv = new LicenseServer(); licSrv.setClientInfo(oid, iHost, ipAdr, userName, displayName);

Parameters:

pid - Process ID

iHost - ; the host name of the client as a TCP/IP host name String.

ipAdr - ; the IP address of the client.

userName - Name of user

displayName - Name of display

Throws:

InoNetException

Method Details

getHost

public String getHost()

Gets the license server's getHost() name.

Specified by:

getHost in interface INetworkInformationService

Returns:

getHost() name as a String

isSubscription

public boolean isSubscription()
                       throws InoNetException

Throws:

InoNetException

getPort

public int getPort()

Gets the license server's TCP/IP port.

Specified by:

getPort in interface INetworkInformationService

Returns:

a port number

getClientInfo

public LSrvClientData getClientInfo()

setClientInfo

public void setClientInfo(int pid,
 String iHost,
 String ipAdr,
 String userName,
 String displayName)

getVersion

public InoVersion getVersion()
                      throws InoNetException

Retrieves the version of the license server. The method explicitly sends a telegram to the license server to get the version number and caches its value for further calls.

Specified by:

getVersion in interface INetworkInformationService

Returns:

the license server version as an integer value

Throws:

InoNetException - for any network problems

getConnectedProgram

public InoProgram.Type getConnectedProgram()

getSerialNumber

public int getSerialNumber()
                    throws InoNetException

Specified by:

getSerialNumber in interface ILicensingService

Throws:

InoNetException

registerProgram

public void registerProgram(InoProgram.Type progType)
                     throws InoNetException,
IllegalStateException

Specified by:

registerProgram in interface ILicensingService

Throws:

InoNetException

IllegalStateException

unregisterProgram

public void unregisterProgram(InoProgram.Type programType)
                       throws InoNetException

Throws:

InoNetException

unregisterProgram

public void unregisterProgram()
                       throws InoNetException

Specified by:

unregisterProgram in interface ILicensingService

Throws:

InoNetException

updateConnection

public void updateConnection()
                      throws InoNetException,
IllegalStateException

Throws:

InoNetException

IllegalStateException

lockLicense

public void lockLicense(LicenseServer.License license)
                 throws InoNetException

Description copied from interface: ILicensingService

Locks another license of given type.

Specified by:

lockLicense in interface ILicensingService

Parameters:

license - The type of the license to lock.

Throws:

InoNetException

findServer

public RepositoryServer findServer(String repName)
                            throws InoNetException

Finds a specific running repository server.

Specified by:

findServer in interface INetworkInformationService

Parameters:

repName - the name of a repository server (without path or extension)

Returns:

an instance of RepositoryServer or null if no such server was found.

Throws:

InoNetException

getServerList

public List<RepositoryServer> getServerList()
                                     throws InoNetException

The method retrieves the complete list of repository servers known by this license server.

Specified by:

getServerList in interface INetworkInformationService

Returns:

a list of running server instances

Throws:

InoNetException

getSvgServer

public String getSvgServer()
                    throws InoNetException

The method retrieves the complete list of repository servers known by this license server.

Returns:

a list of running server instances

Throws:

InoNetException

getProxy

public InoProxyProgram getProxy(de.mid.innovator.srv.LicSrvGetSrvPrjListReplyTelegram.SrvConData conData)
                         throws InoNetException

The method retrieves the complete list of proxys known by this license server.

Returns:

a list of running server instances

Throws:

InoNetException

getProxyList

public List<InoProxyProgram> getProxyList()
                                   throws InoNetException

The method retrieves the complete list of proxys known by this license server.

Returns:

a list of running server instances

Throws:

InoNetException

getServerStatus

public EnumSet<ServerStatus> getServerStatus(String repName)
                                      throws InoNetException

The method returns a set of runtime status flags of the given repository server.

Parameters:

repName - short name of a repository server

Returns:

the set of status values that can be checked with the members of the ServerStatus enumeration

Throws:

InoNetException

getInnovatorClients

public List<InoNetClient> getInnovatorClients()
                                       throws InoNetException

Returns a list of all known clients. The list contains every getHost() that runs an Innovator application which has been registered at the current license server.

Specified by:

getInnovatorClients in interface INetworkInformationService

Returns:

A list of all Innovator network clients that are connected to the license server.

Throws:

InoNetException

getUser

public InoUser getUser()
                throws InoNetException

Returns the info for the current system user.

Returns:

A list of all Innovator network clients that are connected to the license server.

Throws:

InoNetException

getUserJWT

public String getUserJWT()
                  throws InoNetException

Throws:

InoNetException

getUserList

public List<InoUser> getUserList()
                          throws InoNetException

Throws:

InoNetException

getUserLoginList

public List<de.mid.innovator.srv.LicSrvGetLoginListReplyTelegram.InoUserLogin> getUserLoginList()
                                                                                         throws InoNetException

Throws:

InoNetException

getUserRoleList

public List<String> getUserRoleList(InoUser inoUser,
 String repName,
 String mdlName,
 K_ADMODEL mdlType)
                             throws InoNetException

Throws:

InoNetException

getUserVersRoleList

public List<String> getUserVersRoleList(InoUser inoUser,
 String repName,
 String mdlName,
 K_ADMODEL mdlType,
 String versName)
                                 throws InoNetException

Throws:

InoNetException

chkMdlAdmin

public LicSrvUserChkMdlAdminReplyTelegram.SsoMdlUserData chkMdlAdmin(InoUser user,
 String repName,
 String mdlName,
 K_ADMODEL mdlType)
                                                              throws InoNetException

Returns a flag if repository admin login is allowed. The information has to be used for the connect

Returns:

A list of all Innovator network clients that are connected to the license server.

Throws:

InoNetException

chkVersMdlAdmin

public LicSrvUserChkMdlAdminReplyTelegram.SsoMdlUserData chkVersMdlAdmin(InoUser user,
 String repName,
 String mdlName,
 K_ADMODEL mdlType,
 String versName)
                                                                  throws InoNetException

Returns a flag if repository admin login is allowed. The information has to be used for the connect

Returns:

A list of all Innovator network clients that are connected to the license server.

Throws:

InoNetException

chkVersAdmin

public LicSrvUserChkRepAdminReplyTelegram.SsoUserData chkVersAdmin(InoUser user,
 String repName,
 String mdlName,
 K_ADMODEL mdlType)
                                                            throws InoNetException

Returns a flag if repository admin login is allowed. The information has to be used for the connect

Returns:

A list of all Innovator network clients that are connected to the license server.

Throws:

InoNetException

hasEnvironRight

public boolean hasEnvironRight(InoUser user)
                        throws InoNetException

Returns a flag if configuration of environments is allowed.

Returns:

Has the right to configure environments.

Throws:

InoNetException

getHostId

public String getHostId()
                 throws InoNetException

Description copied from interface: ILicensingService

Gets the host id.

Specified by:

getHostId in interface ILicensingService

Throws:

InoNetException

getMainInohost

public String getMainInohost()
                      throws InoNetException

Throws:

InoNetException

getInohost

public String getInohost()
                  throws InoNetException

Throws:

InoNetException

getLicensee

public String getLicensee()
                   throws InoNetException

Description copied from interface: ILicensingService

Gets the licensee.

Specified by:

getLicensee in interface ILicensingService

Returns:

a formatted string

Throws:

InoNetException

canLogout

public boolean canLogout(String repName,
 String mdlName)

isLicenseRegistered

public boolean isLicenseRegistered()
                            throws InoNetException

Description copied from interface: ILicensingService

Determines whether [is license registered].

Specified by:

isLicenseRegistered in interface ILicensingService

Returns:

true if [is license registered]; otherwise false

Throws:

InoNetException

registerLicense

public void registerLicense(String key)
                     throws InoNetException

Description copied from interface: ILicensingService

Registers a new obtained license.

Specified by:

registerLicense in interface ILicensingService

Parameters:

key - The key.

Throws:

InoNetException

sendLicenseFile

public void sendLicenseFile(FileInputStream fs)
                     throws InoNetException,
IOException

Specified by:

sendLicenseFile in interface ILicensingService

Throws:

InoNetException

IOException

getLicenseCount

public int getLicenseCount(LicenseServer.License lic)
                    throws InoNetException

Description copied from interface: ILicensingService

Gets the total number of licenses of a given license type.

Specified by:

getLicenseCount in interface ILicensingService

Parameters:

lic - The license.

Returns:

the number of licenses that can be used parallel

Throws:

InoNetException