Public Member Functions
	PSL (NALP nalp, int oset)

void	PSLSetLicNo (String licNo)

String	PSLGetLicNo ()

String	callPSLGetVersion () throws nalpError
	Gets the vewrsion of the PSL library being accessed. See PSLGetVersion() More...

long	callPSLGetLibraryOptions () throws nalpError
	Retrieves the library stamp options for the current library. See NSLGetLibraryOptions(). More...

String	callPSLGetComputerID () throws nalpError
	Gets the computer ID of the current system. See PSLGetComputerID(). More...

int	callPSLGetLeaseExpSec () throws nalpError
	Get the lease expiration time in seconds. See PSLGetLeaseExpSec(). More...

String	callPSLGetLeaseExpDate () throws nalpError
	Get the lease expiration date. See PSLGetLeaseExpDate(). More...

int	callPSLGetMaintExpSec () throws nalpError
	Get remaining seconds in maintanence period. Available only on certain platforms. More...

String	callPSLGetMaintExpDate () throws nalpError
	Get the maintanence expiration date. Available only on certain platforms. More...

int	callPSLImportLicense (String licenseNo, String cert) throws nalpError
	Imports a license from the given certificate. See PSLImportCertificate(). More...

int	callPSLValidateLibrary (int custID, int prodID) throws nalpError
	Verifies that the shared library you are accessing is the library you stamped at Nalpeiron's website. It does this by checking the customerID and productID sent in against the stamped values. See PSLValidateLibrary(). Any negative return value, even if it is not a known error code, is cause to consider the library invalid. More...

int	callPSLGetLicenseStatus () throws nalpError
	Retrieves the status of the current license. Negative values indicate an invalid license state. See PSLGetLicenseStatus(). More...

int	callPSLGetMaxProcs () throws nalpError
	If the number of concurrent processes was limited when the system's license was created, this function will return the maximum number of allowed processes. More...

int	callPSLGetAvailProcs () throws nalpError
	If the number of concurrent processes was limited when the system's license was created, this function will return the number of allowed processes still remaining for use. More...

String	callPSLGetLicenseCode () throws nalpError
	Retrieves the license code used with the current license. NOTE: a license code will only be present if one has already been assigned to the current license via PSLGetLicense, PSLImportCert, etc. See PSLGetLicenseCode(). More...

int	callPSLGetFeatureStatus (String featureName) throws nalpError
	Checks the current license for the status of featureName. See PSLGetFeatureStatus(). More...

String	callPSLGetUDFValue (String UDFName) throws nalpError
	Retrieve the value of a UDF (AA). See PSLGetUDFValue(). More...

Constructor & Destructor Documentation

com.nalpeiron.passlibrary.PSL.PSL	(	NALP	nalp,
		int	oset
	)

inline

Member Function Documentation

int com.nalpeiron.passlibrary.PSL.callPSLGetAvailProcs ( ) throws nalpError

inline

If the number of concurrent processes was limited when the system's license was created, this function will return the number of allowed processes still remaining for use.

A license may limit the number of simultaneous copies allowed to run on a specific computer. This limit is disabled by default and, if desired, must be enabled on the Nalpeiron server. The number of copies available is set to noProcs+1 and availProc is the number of copies still available for use. When an application instance is started and returns availProc=0, the number of instances exceeds the maximum allowed and this instance should be terminated.

When disabled, this fuction will always return zero (0) as noProcs and one (1) as the number of availProc. NOTE limiting the number of processes allowed on a machine ("Number of concurrent Processes" setting on server) is not affected by the "Concurrency Mode" setting. See PSLGetNumbAvailProc()

Returns: Number of processes still available for use.

Exceptions

nalpError If there was a problem calling the PSLfunction, this error will be thrown (Nalpeiron V10 error returns)

String com.nalpeiron.passlibrary.PSL.callPSLGetComputerID ( ) throws nalpError

inline

Gets the computer ID of the current system. See PSLGetComputerID().

Returns: A string containing the computerID of the system.

Exceptions

nalpError If there was a problem calling the PSL function, this error will be thrown (Nalpeiron V10 error returns)

int com.nalpeiron.passlibrary.PSL.callPSLGetFeatureStatus ( String featureName ) throws nalpError

inline

Checks the current license for the status of featureName. See PSLGetFeatureStatus().

Parameters

featureName a string containing the five (5) character feature code of the feature to be checked out.

Returns: An integer representing the status of the checked-out feature (FEATSTATUS)

Exceptions

nalpError If there was a problem calling the PSL function, this error will be thrown (Nalpeiron V10 error returns)

String com.nalpeiron.passlibrary.PSL.callPSLGetLeaseExpDate ( ) throws nalpError

inline

Get the lease expiration date. See PSLGetLeaseExpDate().

Returns: Returns a string containing the expiration of the license as a time/date string (Wed Jul 17 19:59:12 2013, for example). If the license has expired the date will contain the system's current time.

Exceptions

nalpError If there was a problem calling the PSL function, this error will be thrown (Nalpeiron V10 error returns)

int com.nalpeiron.passlibrary.PSL.callPSLGetLeaseExpSec ( ) throws nalpError

inline

Get the lease expiration time in seconds. See PSLGetLeaseExpSec().

Returns: A integer containing the number of seconds remaining in the current lease. If the lease is expired the number of seconds remaining will be 0 (zero).

Exceptions

nalpError If there was a problem calling the PSL function, this error will be thrown (Nalpeiron V10 error returns)

long com.nalpeiron.passlibrary.PSL.callPSLGetLibraryOptions ( ) throws nalpError

inline

Retrieves the library stamp options for the current library. See NSLGetLibraryOptions().

Returns: An unsigned 64 bit integer containing the library options. (LIBOPTS)

Exceptions

nalpError If there was a problem calling the NSLfunction, this error will be thrown (Nalpeiron V10 error returns)

String com.nalpeiron.passlibrary.PSL.callPSLGetLicenseCode ( ) throws nalpError

inline

Retrieves the license code used with the current license. NOTE: a license code will only be present if one has already been assigned to the current license via PSLGetLicense, PSLImportCert, etc. See PSLGetLicenseCode().

Returns: String containing the current license code.

Exceptions

nalpError If there was a problem calling the PSL function, this error will be thrown (Nalpeiron V10 error returns)

int com.nalpeiron.passlibrary.PSL.callPSLGetLicenseStatus ( ) throws nalpError

inline

Retrieves the status of the current license. Negative values indicate an invalid license state. See PSLGetLicenseStatus().

Returns: An integer representing the status of the current license (see License status values)

Exceptions

nalpError If there was a problem calling the PSLfunction, this error will be thrown (Nalpeiron V10 error returns)

String com.nalpeiron.passlibrary.PSL.callPSLGetMaintExpDate ( ) throws nalpError

inline

Get the maintanence expiration date. Available only on certain platforms.

Returns: Returns a string containing the maintanence date of the license as a time/date string (Wed Jul 17 19:59:12 2013, for example). If the license maintancence date has passed the return will contain the system's current time.

Exceptions

nalpError If there was a problem calling the PSL function, this error will be thrown (Nalpeiron V10 error returns)

int com.nalpeiron.passlibrary.PSL.callPSLGetMaintExpSec ( ) throws nalpError

inline

Get remaining seconds in maintanence period. Available only on certain platforms.

Returns: A integer containing the number of seconds remaining in the current maintanence period. If the maintanence period has expired the number of seconds remaining will be 0 (zero).

Exceptions

nalpError If there was a problem calling the PSL function, this error will be thrown (Nalpeiron V10 error returns)

int com.nalpeiron.passlibrary.PSL.callPSLGetMaxProcs ( ) throws nalpError

inline

If the number of concurrent processes was limited when the system's license was created, this function will return the maximum number of allowed processes.

A license may limit the number of simultaneous copies allowed to run on a specific computer. This limit is disabled by default and, if desired, must be enabled on the Nalpeiron server. The number of copies available is set to noProcs+1 and availProc is the number of copies still available for use. When an application instance is started and returns availProc=0, the number of instances exceeds the maximum allowed and this instance should be terminated.

When disabled, this fuction will always return zero (0) as noProcs and one (1) as the number of availProc. NOTE limiting the number of processes allowed on a machine ("Number of concurrent Processes" setting on server) is not affected by the "Concurrency Mode" setting. See PSLGetNumbAvailProc()

Returns: Maximum number of processes allowed

Exceptions

nalpError If there was a problem calling the PSLfunction, this error will be thrown (Nalpeiron V10 error returns)

String com.nalpeiron.passlibrary.PSL.callPSLGetUDFValue ( String UDFName ) throws nalpError

inline

Retrieve the value of a UDF (AA). See PSLGetUDFValue().

Parameters

UDFName a string containing the five (5) character UDF code of the value to be accessed

Returns: A string containing the UDF value.

Exceptions

nalpError If there was a problem calling the PSL function, this error will be thrown (Nalpeiron V10 error returns)

String com.nalpeiron.passlibrary.PSL.callPSLGetVersion ( ) throws nalpError

inline

Gets the vewrsion of the PSL library being accessed. See PSLGetVersion()

Returns: A String containing the version of the Nalpeiron Passive library

Exceptions

nalpError If there was a problem calling the PSL function, this error will be thrown (Nalpeiron V10 error returns)

int com.nalpeiron.passlibrary.PSL.callPSLImportLicense	(	String	licenseNo,
		String	cert
	)		throws nalpError

inline

Imports a license from the given certificate. See PSLImportCertificate().

Parameters

licenseNo	the license number associated with the given license certificate
cert	Either the certificate itself passed in as a NULL terminated string or the full path to a file containing the certificate.

Returns: The license status of the imported certificate.

Exceptions

nalpError If there was a problem calling the PSL function, this error will be thrown (Nalpeiron V10 error returns)

int com.nalpeiron.passlibrary.PSL.callPSLValidateLibrary	(	int	custID,
		int	prodID
	)		throws nalpError

inline

Verifies that the shared library you are accessing is the library you stamped at Nalpeiron's website. It does this by checking the customerID and productID sent in against the stamped values. See PSLValidateLibrary(). Any negative return value, even if it is not a known error code, is cause to consider the library invalid.

Parameters

custID	a unsigned 32 bit integer containing your Nalpeiron customer ID.
prodID	a unsigned 32 bit integer containing your Nalpeiron product ID.

Returns: = 0(zero) is returned if the customerID/productID passed into the function match those from the library. A non-zero values indicates a validation failure.

Exceptions

nalpError If there was a problem calling the PSL function, this error will be thrown (Nalpeiron V10 error returns)

String com.nalpeiron.passlibrary.PSL.PSLGetLicNo ( )

inline

void com.nalpeiron.passlibrary.PSL.PSLSetLicNo ( String licNo )

inline

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation