Project: stp

javax.wvcm
Interface ProviderFactory.Callback

All Known Subinterfaces:
StpProvider.StpCallback
Enclosing class:
ProviderFactory

public static interface ProviderFactory.Callback

Provides callback functions that can be invoked by a provider.


Nested Class Summary
static interface ProviderFactory.Callback.Authentication
          Authentication information for the current user.
 
Method Summary
 ProviderFactory.Callback.Authentication getAuthentication(String realm, int retryCount)
          Get authentication information for the current user.
 

Method Detail

getAuthentication

ProviderFactory.Callback.Authentication getAuthentication(String realm,
                                                          int retryCount)
                                                          throws WvcmException
Get authentication information for the current user.

The provider calls Callback.getAuthentication, and the client returns an object that implements the Authentication interface. The provider will then call the Authentication interface methods on that object to obtain authentication information for the current user.

Parameters:
realm - an identifier for the authentication realm that is requesting credentials. A single provider instance can access resources in different authentication realms, so the user must be provided with the name of the authentication realm in order to determine what credentials to provide.
retryCount - the number of times the provider has unsuccessfully attempted to get authentication for this operation. This parameter helps the client decide when to provide a more detailed authentication dialog, or potentially abort the operation rather than making additional attempts to get credentials from the user.
Returns:
user and password authentication interface. If null is returned, the user wishes to login anonymously.
Throws:
WvcmException - if the user aborted the authentication request.

Generated Thu 18-Feb-2010 12:40 PM

Copyright © IBM 2010. All rights reserved.