Public Member Functions
	NSA (NALP nalp)

String	callNSAGetVersion () throws nalpError
	Gets the version of the NSA library being accessed. See NSAGetVersion(). More...

int	callNSACheckCache () throws nalpError
	Retrieves the current size of the analytics cache file. More...

String	callNSAGetHostName () throws nalpError
	Gets the name of the SOAP server the library contacts for licensing information. See NSAGetHostName(). More...

int	callNSALogin (String Username, String clientData, long[] lid) throws nalpError
	Records login of username. See NSALogin(). More...

int	callNSALogout (String Username, String clientData, long[] lid) throws nalpError
	Records login of username. See NSALogout(). More...

int	callNSAFeatureStart (String Username, String FeatureCode, String clientData, long[] fid) throws nalpError
	Records start of feature access. See NSAFeatureStart(). More...

int	callNSAFeatureStop (String Username, String FeatureCode, String clientData, long[] fid) throws nalpError
	Records end of feature access. See NSAFeatureEnd(). More...

int	callNSAException (String Username, String ExceptionCode, String clientData, String Description) throws nalpError
	Records an error of type exceptionCode by username with details in description. See NSAException(). More...

int	callNSASysInfo (String Username, String Applang, String Version, String Edition, String Build, String LicenseStat, String clientData) throws nalpError
	Sends information about the end user's system to Nalpeiron. See NSASysInfo(). In addtion to the parameters the function will send the following information. More...

int	callNSASendCache (String Username) throws nalpError
	If a cache file of analytics data exists on the end user's system send it to Nalpeiron. Cache files are created when a system is offline or has been placed in offline mode. See NSASendCache(). More...

int	callNSAApStart (String Username, String clientData, long[] aid) throws nalpError
	Records start of application. See NSAAppStart(). More...

int	callNSAApStop (String Username, String clientData, long[] aid) throws nalpError
	Records end of application. See NSAAppStop(). More...

int	callNSAGetPrivacy () throws nalpError
	Checks the current privacy setting. If privacy is unset, the privacy setting used by the library will be the one stamped into it. See NSAGetPrivacy(). More...

int	callNSASetPrivacy (int Privacy) throws nalpError
	Sets the library's privacy setting to nsaPriv. See NSASetPrivacy(). More...

String	callNSAGetStats () throws nalpError
	Returns status information from the NSA library. See NSAGetStats(). More...

Constructor & Destructor Documentation

com.nalpeiron.nalplibrary.NSA.NSA ( NALP nalp )

inline

Member Function Documentation

int com.nalpeiron.nalplibrary.NSA.callNSAApStart	(	String	Username,
		String	clientData,
		long[]	aid
	)		throws nalpError

inline

Records start of application. See NSAAppStart().

Parameters

Username	a string containing the username that will be passed to the Nalpeiron server or daemon with your call.
clientData	a string containing a valid XML fragment with whatever data you care to pass to the Nalpeiron server or daemon with your call.
aid	transID allows a series of transactions to be grouped together with a transaction ID. To retrieve a transaction ID from any function, set transID = 0 and call the function. Upon return, transID will be set with a random number that will be passed to the Nalpeiron server to identify the transaction. Send this value into any functions that are to be grouped together. This is particularly useful for function pairs such as NSALogin/NSALogout, NSAAppStart/NSAAppStop, NSAFeatureStart/NSAFeatureEnd, etc. If you do not wish to use the transaction ID a NULL pointer will disable it.

Returns: 0 If the call succeeded

Exceptions

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

int com.nalpeiron.nalplibrary.NSA.callNSAApStop	(	String	Username,
		String	clientData,
		long[]	aid
	)		throws nalpError

inline

Records end of application. See NSAAppStop().

Parameters

Username	a string containing the username that will be passed to the Nalpeiron server or daemon with your call.
clientData	a string containing a valid XML fragment with whatever data you care to pass to the Nalpeiron server or daemon with your call.
aid	transID allows a series of transactions to be grouped together with a transaction ID. To retrieve a transaction ID from any function, set transID = 0 and call the function. Upon return, transID will be set with a random number that will be passed to the Nalpeiron server to identify the transaction. Send this value into any functions that are to be grouped together. This is particularly useful for function pairs such as NSALogin/NSALogout, NSAAppStart/NSAAppStop, NSAFeatureStart/NSAFeatureEnd, etc. If you do not wish to use the transaction ID a NULL pointer will disable it.

Returns: 0 If the call succeeded

Exceptions

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

int com.nalpeiron.nalplibrary.NSA.callNSACheckCache ( ) throws nalpError

inline

Retrieves the current size of the analytics cache file.

Returns: An integer containing the current size in bytes of the cache file.

Exceptions

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

int com.nalpeiron.nalplibrary.NSA.callNSAException	(	String	Username,
		String	ExceptionCode,
		String	clientData,
		String	Description
	)		throws nalpError

inline

Records an error of type exceptionCode by username with details in description. See NSAException().

Parameters

Username	a string containing the username that will be passed to the Nalpeiron server or daemon with your call.
ExceptionCode	a string that will be passed to the Nalpeiron server or daemon with your call.
Description	A string that will be passed to the Nalpeiron server or daemon with your call.
clientData	a XML fragment containing whatever data you would like to pass to the Nalpeiron server or daemon with your call.

Returns: 0 If the call succeeded

Exceptions

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

int com.nalpeiron.nalplibrary.NSA.callNSAFeatureStart	(	String	Username,
		String	FeatureCode,
		String	clientData,
		long[]	fid
	)		throws nalpError

inline

Records start of feature access. See NSAFeatureStart().

Parameters

Username	a string containing the username that will be passed to the Nalpeiron server or daemon with your call.
FeatureCode	a string containing the the five(5) character feature code of the feature to be accessed
clientData	a string containing a valid XML fragment with whatever data you care to pass to the Nalpeiron server or daemon with your call.
fid	transID allows a series of transactions to be grouped together with a transaction ID. To retrieve a transaction ID from any function, set transID = 0 and call the function. Upon return, transID will be set with a random number that will be passed to the Nalpeiron server to identify the transaction. Send this value into any functions that are to be grouped together. This is particularly useful for function pairs such as NSALogin/NSALogout, NSAAppStart/NSAAppStop, NSAFeatureStart/NSAFeatureEnd, etc. If you do not wish to use the transaction ID a NULL pointer will disable it.

Returns: 0 If the call succeeded

Exceptions

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

int com.nalpeiron.nalplibrary.NSA.callNSAFeatureStop	(	String	Username,
		String	FeatureCode,
		String	clientData,
		long[]	fid
	)		throws nalpError

inline

Records end of feature access. See NSAFeatureEnd().

Parameters

Username	a string containing the username that will be passed to the Nalpeiron server or daemon with your call.
FeatureCode	a string containing the the five(5) character feature code of the feature to be accessed
clientData	a string containing a valid XML fragment with whatever data you care to pass to the Nalpeiron server or daemon with your call.
fid	transID allows a series of transactions to be grouped together with a transaction ID. To retrieve a transaction ID from any function, set transID = 0 and call the function. Upon return, transID will be set with a random number that will be passed to the Nalpeiron server to identify the transaction. Send this value into any functions that are to be grouped together. This is particularly useful for function pairs such as NSALogin/NSALogout, NSAAppStart/NSAAppStop, NSAFeatureStart/NSAFeatureEnd, etc. If you do not wish to use the transaction ID a NULL pointer will disable it.

Returns: 0 If the call succeeded

Exceptions

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

String com.nalpeiron.nalplibrary.NSA.callNSAGetHostName ( ) throws nalpError

inline

Gets the name of the SOAP server the library contacts for licensing information. See NSAGetHostName().

Returns: A string containing the hostname of the Nalpeiron server or daemon.

Exceptions

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

int com.nalpeiron.nalplibrary.NSA.callNSAGetPrivacy ( ) throws nalpError

inline

Checks the current privacy setting. If privacy is unset, the privacy setting used by the library will be the one stamped into it. See NSAGetPrivacy().

Returns: 0 No privacy; 1 Privacy Enabled

Exceptions

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

String com.nalpeiron.nalplibrary.NSA.callNSAGetStats ( ) throws nalpError

inline

Returns status information from the NSA library. See NSAGetStats().

Returns

a string containing statistics from the NSA library as a XML string. The format of the return is:

   <?xml version="1.0" encoding="UTF-8"?>
       <NSA Current Statistics>
           <OfflineMode>0</OfflineMode>
           <LocationInfo>1</LocationInfo>
           <Cache Thread>
               <Max Cache Que Len>25</Max Cache Que Len>
               <Current Cache Que Len>0</Current Cache Que Len>
               <Cache writes>1</Cache writes>
               <Cache fails>0</Cache fails>
           </Cache Thread>
           <Soap Pool>
               <Min Soap Threads>10</Min Soap Threads>
               <Max Soap Threads>10</Max Soap Threads>
               <Queued Jobs>0</Queued Jobs>
               <Running Jobs>0</Running Jobs>
               <Finished Jobs>145</Finished Jobs>
           </Soap Pool>
       </NSA Current Statistics>

Exceptions

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

String com.nalpeiron.nalplibrary.NSA.callNSAGetVersion ( ) throws nalpError

inline

Gets the version of the NSA library being accessed. See NSAGetVersion().

Returns: A string containing the library version.

Exceptions

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

int com.nalpeiron.nalplibrary.NSA.callNSALogin	(	String	Username,
		String	clientData,
		long[]	lid
	)		throws nalpError

inline

Records login of username. See NSALogin().

Parameters

Username	a string containing the username that will be passed to the Nalpeiron server or daemon with your call.
clientData	a string containing a valid XML fragment with whatever data you care to pass to the Nalpeiron server or daemon with your call.
lid	transID allows a series of transactions to be grouped together with a transaction ID. To retrieve a transaction ID from any function, set transID = 0 and call the function. Upon return, transID will be set with a random number that will be passed to the Nalpeiron server to identify the transaction. Send this value into any functions that are to be grouped together. This is particularly useful for function pairs such as NSALogin/NSALogout, NSAAppStart/NSAAppStop, NSAFeatureStart/NSAFeatureEnd, etc. If you do not wish to use the transaction ID a NULL pointer will disable it.

Returns: 0 If the call succeeded

Exceptions

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

int com.nalpeiron.nalplibrary.NSA.callNSALogout	(	String	Username,
		String	clientData,
		long[]	lid
	)		throws nalpError

inline

Records login of username. See NSALogout().

Parameters

Username	a string containing the username that will be passed to the Nalpeiron server or daemon with your call.
clientData	a string containing a valid XML fragment with whatever data you care to pass to the Nalpeiron server or daemon with your call.
lid	transID allows a series of transactions to be grouped together with a transaction ID. To retrieve a transaction ID from any function, set transID = 0 and call the function. Upon return, transID will be set with a random number that will be passed to the Nalpeiron server to identify the transaction. Send this value into any functions that are to be grouped together. This is particularly useful for function pairs such as NSALogin/NSALogout, NSAAppStart/NSAAppStop, NSAFeatureStart/NSAFeatureEnd, etc. If you do not wish to use the transaction ID a NULL pointer will disable it.

Returns: 0 If the call succeeded

Exceptions

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

int com.nalpeiron.nalplibrary.NSA.callNSASendCache ( String Username ) throws nalpError

inline

If a cache file of analytics data exists on the end user's system send it to Nalpeiron. Cache files are created when a system is offline or has been placed in offline mode. See NSASendCache().

Parameters

Username a username that will be passed to the Nalpeiron server or daemon with your call.

Returns: 0 If the call succeeded

Exceptions

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

int com.nalpeiron.nalplibrary.NSA.callNSASetPrivacy ( int Privacy ) throws nalpError

inline

Sets the library's privacy setting to nsaPriv. See NSASetPrivacy().

Parameters

Privacy privacy value for the library. Possible values for setting are 0 "no privacy" or 1 "privacy enabled".

Returns: 0 If the call succeeded

Exceptions

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

int com.nalpeiron.nalplibrary.NSA.callNSASysInfo	(	String	Username,
		String	Applang,
		String	Version,
		String	Edition,
		String	Build,
		String	LicenseStat,
		String	clientData
	)		throws nalpError

inline

Sends information about the end user's system to Nalpeiron. See NSASysInfo(). In addtion to the parameters the function will send the following information.

  date            date and time
  username        username as passed into NSASysInfo
  productid       your product ID
  customerid      your customer ID
  computerid      the end user's computer ID
  NSA version     version number of the NSA Library
  location        countryid- Two character country code
  country         country name
  region          state, territory, region as appropriate
  city            city
  zipcode         zipcode as appropriate
  operatingsystem OS (Linux, Windows, OSX, etc)
  bitage          32 or 64
  screenresx      screen width
  screenresy      screen heigth
  proc            processor information
  cores           number of processors or cores
  memory          amount of memory in Meg.
  oslanguage      default OS language
  applanguage     passed in app language
  productstatus   passed in License Status
  profile         type of system(laptop or desktop)

Parameters

Username	a username that will be passed to the Nalpeiron server or daemon with your call.
Applang	a string that will be passed to the Nalpeiron server or daemon with your call.
Version	a string that will be passed to the Nalpeiron server or daemon with your call.
Edition	a string that will be passed to the Nalpeiron server or daemon with your call.
Build	a string that will be passed to the Nalpeiron server or daemon with your call.
LicenseStat	a string that will be passed to the Nalpeiron server or daemon with your call.
clientData	a string containing a valid XML fragment containing whatever data you would like to pass to the Nalpeiron server or daemon with your call.

Returns: 0 on success, negative value on error

Exceptions

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

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation