com.hyperion.css
Interface CSSSecurityAgentIF

public interface CSSSecurityAgentIF

Interface defining the getter methods for Username and Password. Note that password is an optional parameter. If the implementation of this interface returns a null password, security authentication will treat all providers as trusted and will verify for the existence of the username across all configured providers. Any non-null value will be treated as a valid password and an authentication request using the username and password returned by this implementation will be performed.

Author:

Arokiaraj Joseph

Method Summary

java.lang.String	getPassword(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Contract to return the password computed from the request object.
java.lang.String	getUserName(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Contract to return the username computed from the request object.

Method Detail

getUserName

java.lang.String getUserName(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse res)
                             throws java.lang.Exception

Contract to return the username computed from the request object.

Parameters:

req - - Http request that carries information with which the username will be computed.

res - - Not used. Preset for backward compatibility reasons.

Returns:

user name for authentication.

Throws:

java.lang.Exception - - in case of any failures.

getPassword

java.lang.String getPassword(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse res)
                             throws java.lang.Exception

Contract to return the password computed from the request object. Note that password is an optional parameter. If the implementation of this method returns null, security authentication will treat all providers as trusted and will verify for the existence of the username across all configured providers. Any non-null value will be treated as a valid password and an authentication request using the username and password returned by this implementation will be performed.

Parameters:

req - - Http request that carries information with which the password will be computed.

res - - Not used. Preset for backward compatibility reasons.

Returns:

password in clear text for authentication.

Throws:

java.lang.Exception - - in case of any failures.