Style Intelligence v12.0

inetsoft.sree.security
Interface WebServiceLoginProvider

All Known Implementing Classes:
DefaultLoginProvider

public interface WebServiceLoginProvider

Interface that handles the authentication of a web service client. Implementing classes must provide a default (no argument) constructor.

Since:
11.3

Method Summary
 Principal authenticate(String authenticationToken, String address)
          Authenticates a remote client.
 String getAuthenticationToken(String userName, String password)
          Gets the token that is passed from the client to the server for authentication.
 boolean isCredentialsRequired()
          Gets the flag that determines if the user is required to supply their user name and password.
 

Method Detail

isCredentialsRequired

boolean isCredentialsRequired()
Gets the flag that determines if the user is required to supply their user name and password. This method is only called on the client side.

Returns:
true if the credentials are required; false otherwise.

getAuthenticationToken

String getAuthenticationToken(String userName,
                              String password)
Gets the token that is passed from the client to the server for authentication. This method is only called on the client side.

Parameters:
userName - the user name of the client. This value may be null if isCredentialsRequired() returns false.
password - the password of the client. This value may be null if isCredentialsRequired() returns false.
Returns:
the authentication token.

authenticate

Principal authenticate(String authenticationToken,
                       String address)
Authenticates a remote client. This method is only called on the server side.

Parameters:
authenticationToken - the token provided by the client for authentication.
address - the address of the remote client.
Returns:
a Principal object identifying the remote user if successful; null if unsuccessful.

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.