org.apache.cocoon.webapps.authentication.components
Class Authenticator.AuthenticationResult

java.lang.Object
  org.apache.cocoon.webapps.authentication.components.Authenticator.AuthenticationResult

Enclosing interface:

Authenticator

public static class Authenticator.AuthenticationResult
extends Object

This object describes the success or the failure of an attempt to authenticate a user. The boolean flag valid specifies a success (valid) or a failure (not valid). The document result contains in the case of a success the authentication xml that is store in the session. In the case of a failure, the result can contain information about the failure (or the document can be null). If in the case of a failure the result contains information, the xml must follow this format: if data is available data is included, otherwise: No information If exception message contains info, it is included into failed The root element is removed and the contained elements are stored into the temporary context.

Field Summary

Document	result
boolean	valid

Constructor Summary

Authenticator.AuthenticationResult(boolean valid, Document result)

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

valid

public final boolean valid

result

public final Document result

Constructor Detail

Authenticator.AuthenticationResult

public Authenticator.AuthenticationResult(boolean valid,
                                          Document result)