Modifier and Type	Class and Description
private static class	FormAuthenticator.FormCredential FORM Authentication credential holder.

Modifier and Type	Field and Description
public static final String	__J_AUTHENTICATED
public static final String	__J_PASSWORD
public static final String	__J_SECURITY_CHECK
public static final String	__J_URI
public static final String	__J_USERNAME
private String	_formErrorPage
private String	_formErrorPath
private String	_formLoginPage
private String	_formLoginPath

Access	Constructor and Description
public	FormAuthenticator()

Modifier and Type	Method and Description
public Principal	Returns: UserPrincipal if authenticated else null. authenticate(UserRealm an `UserRealm` value realm, String a `String` value pathInContext, Request a `Request` value request, Response a `Response` value. If non-null response is passed, then a failed authentication will result in a challenge response being set in the response. response) Implements org.mortbay.jetty.Authenticator.authenticate. Perform form authentication.
public String	getAuthMethod() Implements org.mortbay.jetty.Authenticator.getAuthMethod.
public String	getErrorPage()
public String	getLoginPage()
public boolean	isLoginOrErrorPage(String pathInContext)
public void	setErrorPage(String path)
public void	setLoginPage(String path)

__J_AUTHENTICATED	back to summary
public static final String __J_AUTHENTICATED

__J_PASSWORD	back to summary
public static final String __J_PASSWORD

__J_SECURITY_CHECK	back to summary
public static final String __J_SECURITY_CHECK

__J_URI	back to summary
public static final String __J_URI

__J_USERNAME	back to summary
public static final String __J_USERNAME

_formErrorPage	back to summary
private String _formErrorPage

_formErrorPath	back to summary
private String _formErrorPath

_formLoginPage	back to summary
private String _formLoginPage

_formLoginPath	back to summary
private String _formLoginPath

FormAuthenticator	back to summary
public FormAuthenticator()

Method Detail

authenticate back to summary

authenticate	back to summary
public Principal authenticate(UserRealm realm, String pathInContext, Request request, Response response) throws IOException Implements org.mortbay.jetty.Authenticator.authenticate. Perform form authentication. Called from SecurityHandler. Parameters realm:UserRealm Doc from org.mortbay.jetty.Authenticator.authenticate. an `UserRealm` value pathInContext:String Doc from org.mortbay.jetty.Authenticator.authenticate. a `String` value request:Request Doc from org.mortbay.jetty.Authenticator.authenticate. a `Request` value response:Response Doc from org.mortbay.jetty.Authenticator.authenticate. a `Response` value. If non-null response is passed, then a failed authentication will result in a challenge response being set in the response. Returns:Principal UserPrincipal if authenticated else null. Exceptions IOException: Doc from org.mortbay.jetty.Authenticator.authenticate. if an error occurs

public Principal authenticate(UserRealm realm, String pathInContext, Request request, Response response) throws IOException

Implements org.mortbay.jetty.Authenticator.authenticate.

Perform form authentication. Called from SecurityHandler.

Parameters

realm:UserRealm

Doc from org.mortbay.jetty.Authenticator.authenticate.

an UserRealm value

pathInContext:String

Doc from org.mortbay.jetty.Authenticator.authenticate.

a String value

request:Request

Doc from org.mortbay.jetty.Authenticator.authenticate.

a Request value

response:Response

Doc from org.mortbay.jetty.Authenticator.authenticate.

a Response value. If non-null response is passed, then a failed authentication will result in a challenge response being set in the response.

Returns:Principal

UserPrincipal if authenticated else null.

Exceptions

IOException:

Doc from org.mortbay.jetty.Authenticator.authenticate.

if an error occurs

getAuthMethod	back to summary
public String getAuthMethod() Implements org.mortbay.jetty.Authenticator.getAuthMethod.

getErrorPage	back to summary
public String getErrorPage()

getLoginPage	back to summary
public String getLoginPage()

isLoginOrErrorPage	back to summary
public boolean isLoginOrErrorPage(String pathInContext)

setErrorPage	back to summary
public void setErrorPage(String path)

setLoginPage	back to summary
public void setLoginPage(String path)

org.mortbay.jetty.security back to summary

private Class FormAuthenticator.FormCredential

Class Inheritance

extends Object
implements Serializable, HttpSessionBindingListener

java.lang.Object
org.mortbay.jetty.security.FormAuthenticator.FormCredential

All Implemented Interfaces

javax.servlet.http.HttpSessionBindingListener, java.util.EventListener, java.io.Serializable

FORM Authentication credential holder.

Field Summary

Modifier and Type	Field and Description
pack-priv String	_jPassword
pack-priv String	_jUserName
pack-priv transient UserRealm	_realm
pack-priv transient Principal	_userPrincipal

Constructor Summary

Access	Constructor and Description
private	FormCredential()

Method Summary

Modifier and Type	Method and Description
pack-priv void	authenticate(UserRealm realm, String user, String password, Request request)
pack-priv void	authenticate(UserRealm realm, Request request)
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	valueBound(HttpSessionBindingEvent the event that identifies the session event) Overrides default javax.servlet.http.HttpSessionBindingListener.valueBound. Notifies the object that it is being bound to a session and identifies the session.
public void	valueUnbound(HttpSessionBindingEvent the event that identifies the session event) Overrides default javax.servlet.http.HttpSessionBindingListener.valueUnbound. Notifies the object that it is being unbound from a session and identifies the session.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

_jPassword	back to summary
pack-priv String _jPassword

_jUserName	back to summary
pack-priv String _jUserName

_realm	back to summary
pack-priv transient UserRealm _realm

_userPrincipal	back to summary
pack-priv transient Principal _userPrincipal

Constructor Detail

FormCredential	back to summary
private FormCredential()

Method Detail

authenticate	back to summary
pack-priv void authenticate(UserRealm realm, String user, String password, Request request)

authenticate	back to summary
pack-priv void authenticate(UserRealm realm, Request request)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object

valueBound	back to summary
public void valueBound(HttpSessionBindingEvent event) Overrides default javax.servlet.http.HttpSessionBindingListener.valueBound. Doc from javax.servlet.http.HttpSessionBindingListener.valueBound. Notifies the object that it is being bound to a session and identifies the session. Parameters event:HttpSessionBindingEvent the event that identifies the session

valueBound

back to summary

public void valueBound(HttpSessionBindingEvent event)

Overrides default javax.servlet.http.HttpSessionBindingListener.valueBound.

Doc from javax.servlet.http.HttpSessionBindingListener.valueBound.

Notifies the object that it is being bound to a session and identifies the session.

Parameters

event:HttpSessionBindingEvent: the event that identifies the session

valueUnbound	back to summary
public void valueUnbound(HttpSessionBindingEvent event) Overrides default javax.servlet.http.HttpSessionBindingListener.valueUnbound. Doc from javax.servlet.http.HttpSessionBindingListener.valueUnbound. Notifies the object that it is being unbound from a session and identifies the session. Parameters event:HttpSessionBindingEvent the event that identifies the session

valueUnbound

back to summary

public void valueUnbound(HttpSessionBindingEvent event)

Overrides default javax.servlet.http.HttpSessionBindingListener.valueUnbound.

Doc from javax.servlet.http.HttpSessionBindingListener.valueUnbound.

Notifies the object that it is being unbound from a session and identifies the session.

Parameters

event:HttpSessionBindingEvent: the event that identifies the session

public Class FormAuthenticator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class FormAuthenticator.FormCredential

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail