 | Uiinfrastructure API Docs | ||
IAuthenticator Members | |||
| Uiinfrastructure API Docs | ||
IAuthenticator Members | |||
 GetOrSendLoginChallenge | This method returns a Redirect object to the login page. If the login challenge requires additional features (e.g., special HTTP headers in the response, as in the case for HTTP Basic authentication), which cannot be served by a Redirect object, this method may send the login challenge directly using the XPResponse object contained in the requestData. This method may throw an InterpreterException (com.plumtree.uiinfrastructure.interpreter.InterpreterException) if for some reason the login challenge for this authentication method cannot be generated nor sent. |
| Login | This method performs the login operation. The LoginResult returned by this method communicates the status of the login operation. Please do not modify the content of the requestData inside this method (use requestData only as a context to perform the login). LoginResult should be the place to convey any results back to the caller. |
| Logout | This method performs the logout operation. If the user needs to be redirected to some other URL for logout (e.g., SSO logout), this method may internally use the XPResponse in the requestData to send an HTTP redirect to the logout URL. |
| UseThisAuth | This method indicates whether the authentication method this class implements is applicable to the current request given in the requestData. |
IAuthenticator Interface | com.plumtree.uiinfrastructure.login Namespace