Project: stp

com.ibm.rational.wvcm.stp
Interface StpProvider.StpCallback

All Superinterfaces:
ProviderFactory.Callback
Enclosing interface:
StpProvider

public static interface StpProvider.StpCallback
extends ProviderFactory.Callback

An extended version of javax.wvcm.ProviderFactory.Callback whose getAuthentication method provides additional information to the client when being asked for credentials. If the Callback object passed to this Provider implements this interface, its getAuthenticationEx will be called rather than Callback.getAuthentication each time an Authentication object is required.


Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.wvcm.ProviderFactory.Callback
ProviderFactory.Callback.Authentication
 
Method Summary
 ProviderFactory.Callback.Authentication getAuthenticationEx(StpProvider.Domain domain, String realm, int retryCount, StpProvider provider, WvcmException failure)
          An extended version of Callback.getAuthentication that provides additional information to the client when being asked for credentials.
 
Methods inherited from interface javax.wvcm.ProviderFactory.Callback
getAuthentication
 

Method Detail

getAuthenticationEx

ProviderFactory.Callback.Authentication getAuthenticationEx(StpProvider.Domain domain,
                                                            String realm,
                                                            int retryCount,
                                                            StpProvider provider,
                                                            WvcmException failure)
                                                            throws WvcmException
An extended version of Callback.getAuthentication that provides additional information to the client when being asked for credentials. If the Callback object passed to this Provider implements this interface, the getAuthenticationEx will be called rather than getAuthentication each time an Authentication object is required.

Parameters:
domain - The Domain that is requesting credentials.
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.
provider - The StpProvider instance that is requesting authentication.
failure - The WvcmException generated by the attempt to log onto the realm using the Authentication object last provided by this Callback. This will be null when retryCount is zero.
Returns:
user and password authentication interface. Must not be null
Throws:
WvcmException - if the user or client wish to abort the authentication request. Note: this method throwing an exception is the only way the authentication retry process can be terminated. The provider has no preset retry limits or conditions and will repeatedly call this Callback object until a valid set of credentials is returned or this method throws an exception.

Generated Tue 22-May-2012 12:04 PM

Copyright © IBM 2012. All rights reserved.