com.scms.api.sce
Interface LoginPullListener

All Known Subinterfaces:

DualLoginPullListener

public interface LoginPullListener

LoginPullListener interface defines set of callback functions that are used only in pull model. Policy Servers that are responsible for the Network ID management part of the Subscriber Provisioning process and intend to work in pull model should register a LoginPullListener in order to be able to respond to the login-pull requests from the SCE and to synchronize the SCE platform. In order to be able to listen to those indications the API allows setting a listener for this type of the indications. In order to be able to receive login-pull indication the user should do the following: 1) Register login-pull indications listener within the PRPC_SCESubscriberApi 2) Implement the the LoginPullListener interface: The API supports one LoginPullListener at the same time. Moreover, it is highly un-recommended to have more than one API that registered LoginPullListener as it can lead to non-synchronized SCE platform in case both of them respond to the same login-pull request.

See Also:

SCESubscriberApi

Method Summary

void	getSubscribersBulkResponse(NetworkAndSubscriberID_BULK subs, com.scms.common.SubscribersBulkResponseIterator iterator) Upon receiving getSubscribersBulk request during the SCE synchronization in pull model, the SCE issues asynchronously the getSubscribersBulkResponse indication containing subscriberIDs and corresponding NetworkIDs.
void	loginPullRequest(java.lang.String anonymousSubscriberID, NetworkID networkID) When the SCE encounters an unknown IP address's subscriber-side traffic it issues a request for the subscriber login information based on the IP address The SCE expects the policy server to respond with the subscriber data which this IP was allocated for.
void	loginPullRequestBulk(NetworkAndSubscriberID_BULK subs) This callback function is the bulk version of the loginPullRequest callback function that is described above.

Method Detail

loginPullRequest

void loginPullRequest(java.lang.String anonymousSubscriberID,
                      NetworkID networkID)

When the SCE encounters an unknown IP address's subscriber-side traffic it issues a request for the subscriber login information based on the IP address The SCE expects the policy server to respond with the subscriber data which this IP was allocated for. This request is dispatched to the registered listener and triggers loginPullRequest callback function. Upon this callback the listener should retrieve the subscriber information of the subscriber matching this IP address and activate loginPullResponse to deliver the information to the SCE If no information exists for this IP address no response should be issued

Parameters:

anonymousSubscriberID - - When working in Pull Model the SCE assigns each unknown subscriber NetworkID with a temporary Subscriber ID - Anonymous Subscriber ID - until it receives the real Subscriber ID from the Policy Server.

networkID - - network identifier of the unknown subscriber.login pull request is currently supported for single IP address only

loginPullRequestBulk

void loginPullRequestBulk(NetworkAndSubscriberID_BULK subs)

This callback function is the bulk version of the loginPullRequest callback function that is described above. Policy Server may respond to this request by loginPullResponse method activation or by activating loginPullBulkResponse method for each NetworkID in the bulk. In order to iterate over the data contained in the subs parameter use getNext iteration method provided by the bulk class.

Parameters:

subs - - contains pairs of NetworkIDs and anonymous IDs of several subscribers. See parameters description of the loginPullRequest callback method.

getSubscribersBulkResponse

void getSubscribersBulkResponse(NetworkAndSubscriberID_BULK subs,
                                com.scms.common.SubscribersBulkResponseIterator iterator)

Upon receiving getSubscribersBulk request during the SCE synchronization in pull model, the SCE issues asynchronously the getSubscribersBulkResponse indication containing subscriberIDs and corresponding NetworkIDs. One of the indication parameters is isLastBulk flag that should be checked by the user before calling to the next call to the getSubscribersBulk .

Parameters:

subs - - next bulk of the subscribers ????? isLastBulk - ?????