Modifier and Type	Class and Description
pack-priv class	HTAccessHandler.DummyPrincipal DummyPrincipal For use when there is no user realm configured.
private static class	HTAccessHandler.HTAccess

Modifier and Type	Field and Description
pack-priv String	_accessFile
pack-priv String	_default
pack-priv transient HashMap<K, V>	_htCache
private static Logger	log
private Handler	protegee

Access	Constructor and Description
public	HTAccessHandler()

Method Summary

Modifier and Type	Method and Description
public Principal	getPrincipal(String user, UserRealm realm) Get a Principal matching the user.
protected Handler	Returns: Returns the protegee. getProtegee() Getter for property protegee.
public void	handle(String The target of the request - either a URI or a name. target, HttpServletRequest The request either as the `Request` object or a wrapper of that request. The `HttpConnection#getCurrentConnection()` method can be used access the Request object if required. request, HttpServletResponse The response as the `Response` object or a wrapper of that request. The `HttpConnection#getCurrentConnection()` method can be used access the Response object if required. response, int The dispatch mode: `REQUEST`, `FORWARD`, `INCLUDE`, `ERROR` dispatch) Overrides org.mortbay.jetty.security.ConstraintsSecurityHandler.handle. Implements org.mortbay.jetty.Handler.handle. Handle a request.
public void	setAccessFile(String anArg)
public void	setDefault(String dir) set functions for the following .xml administration statements.</set></set></new></arg></call>
public void	setProtegee(Handler The protegee to set. protegee) Setter for property protegee.

Inherited from org.mortbay.jetty.security.ConstraintsSecurityHandler:: checkSecurityConstraints doStart getAuthenticator getAuthMethod getConstraintMappings getUserRealm hasConstraints isCheckWelcomeFiles setAuthenticator setAuthMethod setCheckWelcomeFiles setConstraintMappings setUserRealm

Field Detail

_accessFile	back to summary
pack-priv String _accessFile

_default	back to summary
pack-priv String _default

_htCache	back to summary
pack-priv transient HashMap<K, V> _htCache

log	back to summary
private static Logger log

protegee	back to summary
private Handler protegee

HTAccessHandler	back to summary
public HTAccessHandler()

Method Detail

getPrincipal	back to summary
public Principal getPrincipal(String user, UserRealm realm) Get a Principal matching the user. If there is no user realm, and therefore we are using a htpassword file instead, then just return a dummy Principal.

getProtegee	back to summary
protected Handler getProtegee() Getter for property protegee. Returns:Handler Returns the protegee.

getProtegee

back to summary

protected Handler getProtegee()

Getter for property protegee.

Returns:Handler: Returns the protegee.

handle back to summary

handle	back to summary
public void handle(String target, HttpServletRequest request, HttpServletResponse response, int dispatch) throws IOException, ServletException Overrides org.mortbay.jetty.security.ConstraintsSecurityHandler.handle. Implements org.mortbay.jetty.Handler.handle. Doc from org.mortbay.jetty.Handler.handle. Handle a request. Parameters target:String The target of the request - either a URI or a name. request:HttpServletRequest The request either as the `Request` object or a wrapper of that request. The `HttpConnection#getCurrentConnection()` method can be used access the Request object if required. response:HttpServletResponse The response as the `Response` object or a wrapper of that request. The `HttpConnection#getCurrentConnection()` method can be used access the Response object if required. dispatch:int The dispatch mode: `REQUEST`, `FORWARD`, `INCLUDE`, `ERROR` See Also `org.mortbay.jetty.Handler#handle(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, int)`

public void handle(String target, HttpServletRequest request, HttpServletResponse response, int dispatch) throws IOException, ServletException

Overrides org.mortbay.jetty.security.ConstraintsSecurityHandler.handle.

Implements org.mortbay.jetty.Handler.handle.

Doc from org.mortbay.jetty.Handler.handle.

Handle a request.

Parameters

target:String: The target of the request - either a URI or a name.
request:HttpServletRequest: The request either as the Request object or a wrapper of that request. The HttpConnection#getCurrentConnection() method can be used access the Request object if required.
response:HttpServletResponse: The response as the Response object or a wrapper of that request. The HttpConnection#getCurrentConnection() method can be used access the Response object if required.
dispatch:int: The dispatch mode: REQUEST, FORWARD, INCLUDE, ERROR

See Also

org.mortbay.jetty.Handler#handle(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, int)

setAccessFile	back to summary
public void setAccessFile(String anArg)

setDefault	back to summary
public void setDefault(String dir) set functions for the following .xml administration statements. ./etc/htaccess .htaccess

setProtegee	back to summary
public void setProtegee(Handler protegee) Setter for property protegee. Parameters protegee:Handler The protegee to set.

setProtegee

back to summary

public void setProtegee(Handler protegee)

Setter for property protegee.

Parameters

protegee:Handler: The protegee to set.

org.mortbay.jetty.security back to summary

pack-priv Class HTAccessHandler.DummyPrincipal

Class Inheritance

extends Object
implements Principal

java.lang.Object
org.mortbay.jetty.security.HTAccessHandler.DummyPrincipal

All Implemented Interfaces

java.security.Principal

DummyPrincipal For use when there is no user realm configured.

Field Summary

Modifier and Type	Field and Description
private String	_userName

Constructor Summary

Access	Constructor and Description
public	DummyPrincipal(String name)

Method Summary

Modifier and Type	Method and Description
public String	getName() Implements java.security.Principal.getName. Returns the name of this `Principal`.
public String	toString() Overrides java.lang.Object.toString. Implements java.security.Principal.toString. Returns a string representation of this `Principal`.

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

Field Detail

_userName	back to summary
private String _userName

Constructor Detail

DummyPrincipal	back to summary
public DummyPrincipal(String name)

Method Detail

getName back to summary

getName	back to summary
public String getName() Implements java.security.Principal.getName. Doc from java.security.Principal.getName. Returns the name of this `Principal`. Returns:String the name of this `Principal`.

public String getName()

Implements java.security.Principal.getName.

Doc from java.security.Principal.getName.

Returns the name of this Principal.

Returns:String: the name of this Principal.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements java.security.Principal.toString. Doc from java.security.Principal.toString. Returns a string representation of this `Principal`. Returns:String a string representation of this `Principal`.

public String toString()

Overrides java.lang.Object.toString.

Implements java.security.Principal.toString.

Doc from java.security.Principal.toString.

Returns a string representation of this Principal.

Returns:String: a string representation of this Principal.

org.mortbay.jetty.security back to summary

private Class HTAccessHandler.HTAccess

Class Inheritance

extends Object

java.lang.Object
org.mortbay.jetty.security.HTAccessHandler.HTAccess

Field Summary

Modifier and Type	Field and Description
pack-priv ArrayList<E>	_allowList
pack-priv ArrayList<E>	_denyList
pack-priv boolean	_forbidden
pack-priv String	_groupFile
pack-priv long	_groupModified
pack-priv Resource	_groupResource
pack-priv HashMap<K, V>	_groups
pack-priv long	_lastModified
pack-priv HashMap<K, V>	_methods
pack-priv String	_name
pack-priv int	_order
pack-priv HashSet<E>	_requireEntities
pack-priv String	_requireName
pack-priv int	_satisfy
pack-priv String	_type
pack-priv String	_userFile
pack-priv long	_userModified
pack-priv Resource	_userResource
pack-priv HashMap<K, V>	_users
pack-priv static final int	ALL
pack-priv static final int	ANY
pack-priv static final String	GROUP
pack-priv static final String	USER
pack-priv static final String	VALID_USER

Constructor Summary

Access	Constructor and Description
public	HTAccess(Resource resource)

Method Summary

Modifier and Type	Method and Description
public boolean	checkAccess(String host, String ip)
public boolean	checkAuth(String user, String pass, UserRealm realm, Request request)
public Resource	getGroupResource()
public long	getLastModified()
public HashMap<K, V>	getMethods()
public String	getName()
public int	getSatisfy()
public String	getType()
private String	getUserCode(String user)
private ArrayList<E>	getUserGroups(String group)
public Resource	getUserResource()
public boolean	isAccessLimited()
public boolean	isAuthLimited()
public boolean	isForbidden()
private void	parse(BufferedReader htin)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

_allowList	back to summary
pack-priv ArrayList<E> _allowList

_denyList	back to summary
pack-priv ArrayList<E> _denyList

_forbidden	back to summary
pack-priv boolean _forbidden

_groupFile	back to summary
pack-priv String _groupFile

_groupModified	back to summary
pack-priv long _groupModified

_groupResource	back to summary
pack-priv Resource _groupResource

_groups	back to summary
pack-priv HashMap<K, V> _groups

_lastModified	back to summary
pack-priv long _lastModified

_methods	back to summary
pack-priv HashMap<K, V> _methods

_name	back to summary
pack-priv String _name

_order	back to summary
pack-priv int _order

_requireEntities	back to summary
pack-priv HashSet<E> _requireEntities

_requireName	back to summary
pack-priv String _requireName

_satisfy	back to summary
pack-priv int _satisfy

_type	back to summary
pack-priv String _type

_userFile	back to summary
pack-priv String _userFile

_userModified	back to summary
pack-priv long _userModified

_userResource	back to summary
pack-priv Resource _userResource

_users	back to summary
pack-priv HashMap<K, V> _users

ALL	back to summary
pack-priv static final int ALL

ANY	back to summary
pack-priv static final int ANY

GROUP	back to summary
pack-priv static final String GROUP

USER	back to summary
pack-priv static final String USER

VALID_USER	back to summary
pack-priv static final String VALID_USER

Constructor Detail

HTAccess	back to summary
public HTAccess(Resource resource)

Method Detail

checkAccess	back to summary
public boolean checkAccess(String host, String ip)

checkAuth	back to summary
public boolean checkAuth(String user, String pass, UserRealm realm, Request request)

getGroupResource	back to summary
public Resource getGroupResource()

getLastModified	back to summary
public long getLastModified()

getMethods	back to summary
public HashMap<K, V> getMethods()

getName	back to summary
public String getName()

getSatisfy	back to summary
public int getSatisfy()

getType	back to summary
public String getType()

getUserCode	back to summary
private String getUserCode(String user)

getUserGroups	back to summary
private ArrayList<E> getUserGroups(String group)

getUserResource	back to summary
public Resource getUserResource()

isAccessLimited	back to summary
public boolean isAccessLimited()

isAuthLimited	back to summary
public boolean isAuthLimited()

isForbidden	back to summary
public boolean isForbidden()

parse	back to summary
private void parse(BufferedReader htin) throws IOException

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

public Class HTAccessHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class HTAccessHandler.DummyPrincipal

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class HTAccessHandler.HTAccess

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail