com.signalsoftcorp.lst.provisioning
Interface WPIProvisioning


public interface WPIProvisioning

WPIProvisioning defines the methods offered by the Wireless Provisioning Interface (WPI). This interface provides methods for provisioning Location Studio. System objects data can be listed and retrieved, added, updated, and deleted.
Authentication and access control
Each method takes an account and password as parameters. These are validated and decides under wich role the method is performed. Each method has a execute permission that must allow the role to execute that particular method.
For each get/list- and update method there is also access control permissions on each attribute of the object. For get and list methods, if the permission does not allow access, that attribute is set to null in the returning object. For update methods, if an attribute is not null and access to that attribute is disallowed, the call fails and the response status is set to WRITE_PERMISSION_ERROR. The detail member of the response objects holds a string that indicates witch attribute caused the write permission error.
Updating
For the update methods the attributes of the object are optional. Attributes that are set to null in the request are not updated in the data store.
Adding
The add methods all returns the id of the created object in the return object.


Method Summary
 WPP10ResponseAdd addClient(WPP10Client wppClient, java.lang.String account, java.lang.String password)
          Add a client object to the data store.
 WPP10ResponseAdd addClientGroup(WPP10ClientGroup wppClientGroup, java.lang.String account, java.lang.String password)
          Add a clientGroup object to the data store.
 WPP10ResponseAdd addMERI(WPP10MERI wppMERI, java.lang.String account, java.lang.String password)
          Add a MERI object to the data store.
 WPP10ResponseAdd addOperator(WPP10Operator wppOperator, java.lang.String account, java.lang.String password)
          Add a operator object to the data store.
 WPP10ResponseAddPermission addPermission(WPP10Permission wppPermission, java.lang.String account, java.lang.String password)
          Add a permission object to the data store.
 WPP10ResponseAdd addSubscriber(WPP10Subscriber wppSubscriber, java.lang.String account, java.lang.String password)
          Add a subscriber object to the data store.
 WPP10ResponseAdd addVendor(java.lang.String vendorName, java.lang.String account, java.lang.String password)
          Add a vendor object to the data store.
 WPP10ResponseAuthenticate authenticateSubscriber(java.lang.String account, java.lang.String password)
          Validates the given subscriber credentials.
 WPP10ResponseGetClient getClient(long id, java.lang.String account, java.lang.String password)
          Fetches a client objects data from the data store.
 WPP10ResponseGetClient getClient(java.lang.String id, java.lang.String account, java.lang.String password)
          Fetches a client objects data from the data store.
 WPP10ResponseGetClientGroup getClientGroup(long id, java.lang.String account, java.lang.String password)
          Fetches an clientGroup objects data from the data store.
 WPP10ResponseGetMERI getMERI(long id, java.lang.String account, java.lang.String password)
          Fetches a MERI objects data from the data store.
 WPP10ResponseGetOperator getOperator(long id, java.lang.String account, java.lang.String password)
          Fetches an operator objects data from the data store.
 WPP10ResponseGetPermission getPermission(long subscriberId, long clientId, java.lang.String account, java.lang.String password)
          Fetches a permission objects data from the data store.
 WPP10ResponseListPermissions getPermissionsBySubscriber(long subscriberId, java.lang.String account, java.lang.String password)
          Fetches an array of permission objects data from the data store that belongs to a subscriber.
 WPP10ResponseGetRole getRole(java.lang.String account, java.lang.String password)
          Validates the account and password and returns the name of the provisioning role that the account belongs to, if any.
 WPP10ResponseGetSubscriber getSubscriber(long id, java.lang.String account, java.lang.String password)
          Fetches an subscriber objects data from the data store.
 WPP10ResponseGetSubscriber getSubscriberByLoginID(java.lang.String id, java.lang.String account, java.lang.String password)
          Fetches an subscriber objects data from the data store whos loginID is equal to the parameter id.
 WPP10ResponseGetSubscriber getSubscriberByMSID(java.lang.String id, java.lang.String account, java.lang.String password)
          Fetches an subscriber objects data from the data store whos msid is equal to the parameter id.
 WPP10ResponseGetVendor getVendor(long id, java.lang.String account, java.lang.String password)
          Fetches a vendor objects data from the data store.
 WPP10ResponseListClientGroups listClientGroups(java.lang.String account, java.lang.String password)
          Fetches an array of all clientGroup objects data from the data store.
 WPP10ResponseListMERIs listMERIs(java.lang.String account, java.lang.String password)
          Fetches an array of MERI objects data from the data store.
 WPP10ResponseListOperators listOperators(java.lang.String account, java.lang.String password)
          Returns an array of all operator objects from the data store.
 WPP10ResponseListVendors listVendors(java.lang.String account, java.lang.String password)
          Returns an array of all vendor objects from the data store.
 WPP10Response removeClient(long id, java.lang.String account, java.lang.String password)
          Remove a client object from the data store.
 WPP10Response removeClientGroup(long id, java.lang.String account, java.lang.String password)
          Remove a clientGroup object from the data store.
 WPP10Response removeMERI(long id, java.lang.String account, java.lang.String password)
          Remove a MERI object from the data store.
 WPP10Response removeOperator(long id, java.lang.String account, java.lang.String password)
          Remove an operator from the data store.
 WPP10Response removePermission(long subscriberId, long clientId, java.lang.String account, java.lang.String password)
          Remove a permission from the data store.
 WPP10Response removeSubscriber(long id, java.lang.String account, java.lang.String password)
          Remove a subscriber from the data store.
 WPP10Response removeVendor(long id, java.lang.String account, java.lang.String password)
          Remove a vendor from the data store.
 WPP10ResponseListClientGroups searchClientGroups(java.lang.String searchVariable, java.lang.String searchString, java.lang.String account, java.lang.String password)
          Fetches an array of clientGroup objects data from the data store.
 WPP10ResponseListClients searchClients(java.lang.String searchVariable, java.lang.String searchString, java.lang.String account, java.lang.String password)
          Fetches an array of client objects data from the data store.
 WPP10ResponseListVendors searchVendors(java.lang.String searchString, java.lang.String account, java.lang.String password)
          Returns an array of all vendor objects from the data store who's name starts with the string searchString.
 WPP10Response updateClient(WPP10Client wppClient, java.lang.String account, java.lang.String password)
          Update a client object in the data store.
 WPP10Response updateClientGroup(WPP10ClientGroup wppClientGroup, java.lang.String account, java.lang.String password)
          Update a clientGroup object in the data store.
 WPP10Response updateMERI(WPP10MERI wppMERI, java.lang.String account, java.lang.String password)
          Update a MERI object in the data store.
 WPP10Response updateOperator(WPP10Operator wppOperator, java.lang.String account, java.lang.String password)
          Update a operator object in the data store.
 WPP10Response updatePermission(WPP10Permission wppPermission, java.lang.String account, java.lang.String password)
          Update a permission object in the data store.
 WPP10Response updateSubscriber(WPP10Subscriber wppSubscriber, java.lang.String account, java.lang.String password)
          Update a subscriber object in the data store.
 WPP10Response updateVendor(WPP10Vendor wppVendor, java.lang.String account, java.lang.String password)
          Update a vendor object in the data store.
 

Method Detail

getRole

public WPP10ResponseGetRole getRole(java.lang.String account,
                                    java.lang.String password)
Validates the account and password and returns the name of the provisioning role that the account belongs to, if any.
Parameters:
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseGetRole that includes a status code and the role name, if the call was successfull.

addVendor

public WPP10ResponseAdd addVendor(java.lang.String vendorName,
                                  java.lang.String account,
                                  java.lang.String password)
Add a vendor object to the data store.
Parameters:
vendorName - name of the new vendor.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseAdd that includes the return status of the call, and a id of the newly created object, if the call was successfull.

updateVendor

public WPP10Response updateVendor(WPP10Vendor wppVendor,
                                  java.lang.String account,
                                  java.lang.String password)
Update a vendor object in the data store.
Parameters:
wppVendor - A object represening the vendor data.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

removeVendor

public WPP10Response removeVendor(long id,
                                  java.lang.String account,
                                  java.lang.String password)
Remove a vendor from the data store.
Parameters:
id - id of vendor to remove.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

getVendor

public WPP10ResponseGetVendor getVendor(long id,
                                        java.lang.String account,
                                        java.lang.String password)
Fetches a vendor objects data from the data store.
Parameters:
id - id of vendor.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseGetVendor that includes the return status of the call and a WPP10Vendor object if the call is successfull.

listVendors

public WPP10ResponseListVendors listVendors(java.lang.String account,
                                            java.lang.String password)
Returns an array of all vendor objects from the data store.
Parameters:
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseListVendors that includes the return status of the call and an array of WPP10Vendor objects if the call is successfull.

searchVendors

public WPP10ResponseListVendors searchVendors(java.lang.String searchString,
                                              java.lang.String account,
                                              java.lang.String password)
Returns an array of all vendor objects from the data store who's name starts with the string searchString.
Parameters:
searchString - the returned vendor objects name start with this string.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseListVendors that includes the return status of the call and an array of WPP10Vendor objects if the call is successfull.

addOperator

public WPP10ResponseAdd addOperator(WPP10Operator wppOperator,
                                    java.lang.String account,
                                    java.lang.String password)
Add a operator object to the data store.
Parameters:
wppOperator - operator to be added
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseAdd that includes the return status of the call, and a id of the newly created object, if the call was successfull.

updateOperator

public WPP10Response updateOperator(WPP10Operator wppOperator,
                                    java.lang.String account,
                                    java.lang.String password)
Update a operator object in the data store.
Parameters:
wppOperator - An operator object holding the new data.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

removeOperator

public WPP10Response removeOperator(long id,
                                    java.lang.String account,
                                    java.lang.String password)
Remove an operator from the data store.
Parameters:
id - id of vendor to remove.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

getOperator

public WPP10ResponseGetOperator getOperator(long id,
                                            java.lang.String account,
                                            java.lang.String password)
Fetches an operator objects data from the data store.
Parameters:
id - id of the operator to get.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseGetOperator that includes the return status of the call and a WPP10Operator object if the call is successfull.

listOperators

public WPP10ResponseListOperators listOperators(java.lang.String account,
                                                java.lang.String password)
Returns an array of all operator objects from the data store.
Parameters:
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseListOperators that includes the return status of the call and an array of WPP10Operator objects if the call is successfull.

authenticateSubscriber

public WPP10ResponseAuthenticate authenticateSubscriber(java.lang.String account,
                                                        java.lang.String password)
Validates the given subscriber credentials. This method is an exception to all ohters in this interface in that the account and password parameters does not authenticate a provisiong account. It authenticates a subscribers loginID and password.
Parameters:
account - subscriber loginID.
password - the subscribers password.
Returns:
a response object of type WPP10ResponseAuthenticate that includes the return status of the call and a status that reflects the athentication validity, and a id of the subscriber, if authenticated ok.

addSubscriber

public WPP10ResponseAdd addSubscriber(WPP10Subscriber wppSubscriber,
                                      java.lang.String account,
                                      java.lang.String password)
Add a subscriber object to the data store.
Parameters:
wppSubscriber - subscriber to be added
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseAdd that includes the return status of the call, and a id of the newly created object, if the call was successfull.

updateSubscriber

public WPP10Response updateSubscriber(WPP10Subscriber wppSubscriber,
                                      java.lang.String account,
                                      java.lang.String password)
Update a subscriber object in the data store.
Parameters:
wppSubscriber - An subscriber object holding the new data.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

removeSubscriber

public WPP10Response removeSubscriber(long id,
                                      java.lang.String account,
                                      java.lang.String password)
Remove a subscriber from the data store.
Parameters:
id - id of subscriber to remove.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

getSubscriber

public WPP10ResponseGetSubscriber getSubscriber(long id,
                                                java.lang.String account,
                                                java.lang.String password)
Fetches an subscriber objects data from the data store.
Parameters:
id - id of the subscriber to get.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseGetSubscriber that includes the return status of the call and a WPP10Subscriber object if the call is successfull.

getSubscriberByMSID

public WPP10ResponseGetSubscriber getSubscriberByMSID(java.lang.String id,
                                                      java.lang.String account,
                                                      java.lang.String password)
Fetches an subscriber objects data from the data store whos msid is equal to the parameter id.
Parameters:
id - msid of the subscriber to get.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseGetSubscriber that includes the return status of the call and a WPP10Subscriber object if the call is successfull.

getSubscriberByLoginID

public WPP10ResponseGetSubscriber getSubscriberByLoginID(java.lang.String id,
                                                         java.lang.String account,
                                                         java.lang.String password)
Fetches an subscriber objects data from the data store whos loginID is equal to the parameter id.
Parameters:
id - loginID of the subscriber to get.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseGetSubscriber that includes the return status of the call and a WPP10Subscriber object if the call is successfull.

addPermission

public WPP10ResponseAddPermission addPermission(WPP10Permission wppPermission,
                                                java.lang.String account,
                                                java.lang.String password)
Add a permission object to the data store.
Parameters:
wppPermission - permission to be added
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseAddPermission that includes the return status of the call, and a subscriberID and clientID that identifies the permission, if the call was successfull.

updatePermission

public WPP10Response updatePermission(WPP10Permission wppPermission,
                                      java.lang.String account,
                                      java.lang.String password)
Update a permission object in the data store. If the permission does not exist, it is created.
Parameters:
wppPermission - An permission object holding the new data.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

removePermission

public WPP10Response removePermission(long subscriberId,
                                      long clientId,
                                      java.lang.String account,
                                      java.lang.String password)
Remove a permission from the data store.
Parameters:
subscriberId - subscriber id of the permission to remove.
clientId - client id of the permission to remove.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

getPermission

public WPP10ResponseGetPermission getPermission(long subscriberId,
                                                long clientId,
                                                java.lang.String account,
                                                java.lang.String password)
Fetches a permission objects data from the data store. If no explicit permission for the subscriber/client pair exists, a default permission for the client group the client belongs to is returned.
Parameters:
subscriberId - subscriber id of the permission to get.
clientId - client id of the permission to get.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseGetPermission that includes the return status of the call and a WPP10Permission object if the call is successfull.

getPermissionsBySubscriber

public WPP10ResponseListPermissions getPermissionsBySubscriber(long subscriberId,
                                                               java.lang.String account,
                                                               java.lang.String password)
Fetches an array of permission objects data from the data store that belongs to a subscriber. Only explicit permissions are returned.
Parameters:
subscriberId - id of the subscriber who's permissions to get.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseListPermissions that includes the return status of the call and an array of WPP10Permission objects if the call is successfull.

addMERI

public WPP10ResponseAdd addMERI(WPP10MERI wppMERI,
                                java.lang.String account,
                                java.lang.String password)
Add a MERI object to the data store.
Parameters:
wppMERI - MERI object to be added.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseAdd that includes the return status of the call, and a id of the newly created object, if the call was successfull.

updateMERI

public WPP10Response updateMERI(WPP10MERI wppMERI,
                                java.lang.String account,
                                java.lang.String password)
Update a MERI object in the data store.
Parameters:
wppMERI - A MERI object holding the new data.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

removeMERI

public WPP10Response removeMERI(long id,
                                java.lang.String account,
                                java.lang.String password)
Remove a MERI object from the data store.
Parameters:
id - id of MERI to remove.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

getMERI

public WPP10ResponseGetMERI getMERI(long id,
                                    java.lang.String account,
                                    java.lang.String password)
Fetches a MERI objects data from the data store.
Parameters:
id - id of the MERI.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseGetMERI that includes the return status of the call and a WPP10MERI object if the call is successfull.

listMERIs

public WPP10ResponseListMERIs listMERIs(java.lang.String account,
                                        java.lang.String password)
Fetches an array of MERI objects data from the data store.
Parameters:
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseListMERIs that includes the return status of the call and an array of WPP10MERI objects if the call is successfull.

addClientGroup

public WPP10ResponseAdd addClientGroup(WPP10ClientGroup wppClientGroup,
                                       java.lang.String account,
                                       java.lang.String password)
Add a clientGroup object to the data store.
Parameters:
wppClientGroup - clientGroup object to be added.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseAdd that includes the return status of the call, and a id of the newly created object, if the call was successfull.

updateClientGroup

public WPP10Response updateClientGroup(WPP10ClientGroup wppClientGroup,
                                       java.lang.String account,
                                       java.lang.String password)
Update a clientGroup object in the data store.
Parameters:
wppClientGroup - A clientGroup object holding the new data.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

removeClientGroup

public WPP10Response removeClientGroup(long id,
                                       java.lang.String account,
                                       java.lang.String password)
Remove a clientGroup object from the data store.
Parameters:
id - id of ClientGroup to remove.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

getClientGroup

public WPP10ResponseGetClientGroup getClientGroup(long id,
                                                  java.lang.String account,
                                                  java.lang.String password)
Fetches an clientGroup objects data from the data store.
Parameters:
id - id of the subscriber to get.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseGetClientGroup that includes the return status of the call and a WPP10ClientGroup object if the call is successfull.

listClientGroups

public WPP10ResponseListClientGroups listClientGroups(java.lang.String account,
                                                      java.lang.String password)
Fetches an array of all clientGroup objects data from the data store.
Parameters:
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseListClientGroups that includes the return status of the call and an array of WPP10ClientGroup objects if the call is successfull.

searchClientGroups

public WPP10ResponseListClientGroups searchClientGroups(java.lang.String searchVariable,
                                                        java.lang.String searchString,
                                                        java.lang.String account,
                                                        java.lang.String password)
Fetches an array of clientGroup objects data from the data store. A search is done on the attribute name that is passed in the parameter searchVariable. The attribute name is what it is called in the underlaying DAO layer (i.e. db column name). The result is all clientGroups that has the attribute value starting with the value of the parameter searchString.
Parameters:
searchVariable - name of value to search for
searchString - string witch the value must start with
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseListClientGroups that includes the return status of the call and an array of WPP10ClientGroup objects if the call is successfull.

addClient

public WPP10ResponseAdd addClient(WPP10Client wppClient,
                                  java.lang.String account,
                                  java.lang.String password)
Add a client object to the data store.
Parameters:
wppClient - client object to be added.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseAdd that includes the return status of the call, and a id of the newly created object, if the call was successfull.

updateClient

public WPP10Response updateClient(WPP10Client wppClient,
                                  java.lang.String account,
                                  java.lang.String password)
Update a client object in the data store.
Parameters:
wppClient - A client object holding the new data.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

removeClient

public WPP10Response removeClient(long id,
                                  java.lang.String account,
                                  java.lang.String password)
Remove a client object from the data store.
Parameters:
id - id of client to remove.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10Response that includes the return status of the call.

getClient

public WPP10ResponseGetClient getClient(long id,
                                        java.lang.String account,
                                        java.lang.String password)
Fetches a client objects data from the data store.
Parameters:
id - id of the client to get.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseGetClient that includes the return status of the call and a WPP10Client object if the call is successfull.

getClient

public WPP10ResponseGetClient getClient(java.lang.String id,
                                        java.lang.String account,
                                        java.lang.String password)
Fetches a client objects data from the data store.
Parameters:
id - loginID of the client to get.
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseGetClient that includes the return status of the call and a WPP10Client object if the call is successfull.

searchClients

public WPP10ResponseListClients searchClients(java.lang.String searchVariable,
                                              java.lang.String searchString,
                                              java.lang.String account,
                                              java.lang.String password)
Fetches an array of client objects data from the data store. A search is done on the attribute name that is passed in the parameter searchVariable. The attribute name is what it is called in the underlaying DAO layer (i.e. db column name). The result is all clientGroups that has the attribute value starting with the value of the parameter searchString.
Parameters:
searchVariable - name of value to search for
searchString - string witch the value must start with
account - provisioning account name.
password - the accounts password.
Returns:
a response object of type WPP10ResponseListClients that includes the return status of the call and an array of WPP10Client objects if the call is successfull.


Copyright © SignalSoft Corp. All Rights Reserved.