com.apama.dashboard.security
Interface IUserCredentials


public interface IUserCredentials

UserCredentials contain information about a user attempting to access data or perform an operation. An instance is created on each access request and the validate method called.

If user caching is enabled the validate method will check its cache for a matching username & password pair. If present, the validate method returns true. If user caching is not enabled the validate method will call to the configured JAAS LoginModules to authenticate the user.

An instance of UserCredentials is passed to implementations of IScenarioAuthority to provide the identiy of the user.


Method Summary
 java.lang.String getPassword()
          Get the password.
 javax.security.auth.Subject getSubject()
          Get the javax security subject for this user.
 java.lang.String getUsername()
          Get the username
 boolean validate()
          Validate the user credentials
 

Method Detail

getUsername

java.lang.String getUsername()
Get the username

Returns:
The username

getPassword

java.lang.String getPassword()
Get the password.

Returns:
The password

getSubject

javax.security.auth.Subject getSubject()
Get the javax security subject for this user. This contains the principals and other apsect of the users identify.

Returns:
The security subject for this user

validate

boolean validate()
Validate the user credentials

Returns:
true if valid, false otherwise


Submit a bug or feature
Copyright (c) 2013 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or Terracotta Inc., San Francisco, CA, USA, and/or Software AG (Canada) Inc., Cambridge, Ontario, Canada, and/or, Software AG (UK) Ltd., Derby, United Kingdom, and/or Software A.G. (Israel) Ltd., Or-Yehuda, Israel and/or their licensors. Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG