com.kassenterprises.soapserver
Class AplNavigatorDatabaseService

java.lang.Object
  |
  +--com.kassenterprises.soapserver.AplNavigatorDatabaseService

public class AplNavigatorDatabaseService

extends java.lang.Object

Overview
The AplNavigatorDatabaseService class offers service methods to leverage the data stored in the APL Navigator customer and user databases. The primary methods are authenticateUser() and getAccounts() . The authenticateUser() method can be used verify a user password against the APL Navigator database. The getAccounts() method can be used to obtain a list of accounts the user has access to either based on the APL Navigator database, or through a selection query you provide.

Optional Parameters
Parameters that are not required for a particular data should be passed as null or empty strings. Regardless, they will be ignored if they are not needed. Note that transId (reserved for future async messaging) and allowableAccounts (which may be provided to override the APL Navigator value for the corresponding user) are always optional.

Required Parameters
The parameters customerCode (your APL Navigator assigned acronym) and userId (the APL Navigator on whose behalf the request is being made) are always required. If a required parameter is not supplied for a particular data set, the request will most likely fail.

Miscellaneous
A getVersion() service method is also supplied. This method may be used to retrieve the current name and version of the APL Navigator SOAP AplNavigatorDatabaseService. Note that this service can also be used as a simple test to check whether you can reach the AplNavigatorDatabaseService.

Constructor Summary

AplNavigatorDatabaseService()
Constructor is not needed or used to make requests on AplNavigatorDatabaseService.

Method Summary

java.lang.String	authenticateUser(java.lang.String transId, java.lang.String customerCode, java.lang.String userId, java.lang.String password) Return "true" if the userId/password supplied can be authenticated against the APL Navigator database; otherwise return "false".
java.lang.String	getAccounts(java.lang.String transId, java.lang.String customerCode, java.lang.String userId) Return comma-delimited list of accounts that the supplied userId has access to according to the APL Navigator database.
java.lang.String	getAccounts(java.lang.String transId, java.lang.String customerCode, java.lang.String userId, java.lang.String allowableAccounts) Return comma-delimited list of accounts that the supplied userId has access to based on the supplied allowableAccounts string.
java.lang.String	getVersion(java.lang.String transId, java.lang.String customerCode) Request AplNavigatorDatabaseService Version #.

Methods inherited from class java.lang.Object

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

Constructor Detail

AplNavigatorDatabaseService

public AplNavigatorDatabaseService()

Constructor is not needed or used to make requests on AplNavigatorDatabaseService.

Method Detail

getVersion

public java.lang.String getVersion(java.lang.String transId,
                                   java.lang.String customerCode)

Request AplNavigatorDatabaseService Version #. Doubles as a simple test that the service is up and running.

Parameters:

transId - ignored; reserved for future use of async messaging

customerCode - The APL Navigator acronym of customer making request

authenticateUser

public java.lang.String authenticateUser(java.lang.String transId,
                                         java.lang.String customerCode,
                                         java.lang.String userId,
                                         java.lang.String password)
                                  throws org.apache.soap.SOAPException

Return "true" if the userId/password supplied can be authenticated against the APL Navigator database; otherwise return "false".

Parameters:

transId - ignored; reserved for future use of async messaging

customerCode - The APL Navigator acronym of customer making request

userId - The APL Navigator user id request is on behalf of

password - The supplied password for the userId

Throws:

org.apache.soap.SOAPException -

getAccounts

public java.lang.String getAccounts(java.lang.String transId,
                                    java.lang.String customerCode,
                                    java.lang.String userId)
                             throws org.apache.soap.SOAPException

Return comma-delimited list of accounts that the supplied userId has access to according to the APL Navigator database.

Parameters:

transId - ignored; reserved for future use of async messaging

customerCode - The APL Navigator acronym of customer making request

userId - The APL Navigator user id request is on behalf of

Throws:

org.apache.soap.SOAPException -

getAccounts

public java.lang.String getAccounts(java.lang.String transId,
                                    java.lang.String customerCode,
                                    java.lang.String userId,
                                    java.lang.String allowableAccounts)
                             throws org.apache.soap.SOAPException

Return comma-delimited list of accounts that the supplied userId has access to based on the supplied allowableAccounts string.

Parameters:

transId - ignored; reserved for future use of async messaging

customerCode - The APL Navigator acronym of customer making request

userId - The APL Navigator user id request is on behalf of

allowableAccounts - Temp override of user default for this field

Throws:

org.apache.soap.SOAPException -