|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.ae.toolkit.server.util.credentials.AuthenticationUtil
This is the authentication filter helper API. For use when developing a custom single signon authentication filter. A custom authentication filter must check for whether or not credentials are required, and process only if this flag returns true. The processing in a custom authentication filter must call the setCredentials method of this API upon completion, passing valid userId and password values that will be used by the application.
Constructor Summary | |
AuthenticationUtil()
|
Method Summary | |
static boolean |
credentialsRequired(javax.servlet.ServletRequest request)
Returns true if credentials are required. |
static javax.servlet.http.HttpServletRequest |
getHttpServletRequest(javax.servlet.ServletRequest servletRequest)
Check instanceof HttpServletRequest on servletRequest, and cast it if true. |
static javax.servlet.http.HttpServletResponse |
getHttpServletResponse(javax.servlet.ServletResponse servletResponse)
Check instanceof HttpServletResponse on servletResponse, and cast it if true. |
static java.lang.String |
pushRequestParameters(javax.servlet.ServletRequest servletRequest)
Push request parameters. |
static void |
setCredentials(javax.servlet.ServletRequest request,
java.lang.String userId,
java.lang.String password,
java.lang.String userPrincipalName,
java.util.Map extraParameters,
boolean encrypt)
An SSO filter that is providing credentials must call this method to pass credentials when credentialsRequired has returned true. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AuthenticationUtil()
Method Detail |
public static boolean credentialsRequired(javax.servlet.ServletRequest request)
request
-
public static void setCredentials(javax.servlet.ServletRequest request, java.lang.String userId, java.lang.String password, java.lang.String userPrincipalName, java.util.Map extraParameters, boolean encrypt) throws java.io.IOException
request
- userId
- password
- userPrincipalName
- - This must uniquely identify the user.extraParameters
- encrypt
-
java.io.IOException
public static javax.servlet.http.HttpServletRequest getHttpServletRequest(javax.servlet.ServletRequest servletRequest)
servletRequest
-
public static javax.servlet.http.HttpServletResponse getHttpServletResponse(javax.servlet.ServletResponse servletResponse)
servletResponse
-
public static java.lang.String pushRequestParameters(javax.servlet.ServletRequest servletRequest)
servletRequest
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |