Module org.apache.wicket.core

Package org.apache.wicket.markup.html

Class PackageResourceGuard

java.lang.Object

org.apache.wicket.markup.html.PackageResourceGuard

All Implemented Interfaces:

IPackageResourceGuard

Direct Known Subclasses:

SecurePackageResourceGuard

public class PackageResourceGuard
extends Object
implements IPackageResourceGuard

Default implementation of IPackageResourceGuard. By default, the extensions 'properties', 'class' and 'java' are blocked and files like 'log4j.xml' and 'applicationContext.xml' A more secure implementation which by default denies access to any resource is SecurePackageResourceGuard

Author:

eelcohillenius

Constructor Summary

Constructors

Constructor	Description
PackageResourceGuard()	Construct.

Method Summary

Modifier and Type	Method	Description
boolean	accept(String path)	Whether the package resource that can be reached using the provided parameters may be accessed.
protected boolean	acceptExtension(String extension)	Whether the provided extension is accepted.
protected boolean	acceptFile(String file)	Whether the provided filename is accepted.
protected Set<String>	getBlockedExtensions()	Gets the set of extensions that are denied access.
protected Set<String>	getBlockedFiles()	Gets the set of extensions that are denied access.
boolean	isAllowAccessToRootResources()	Checks whether or not resources in the web root folder can be access.
void	setAllowAccessToRootResources(boolean allowAccessToRootResources)	Sets whether or not resources in the web root folder can be accessed.
protected void	setBlockedExtensions(Set<String> blockedExtensions)	Sets the set of extensions that are denied access.
protected void	setBlockedFiles(Set<String> blockedFiles)	Sets the set of filenames that are denied access.

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageResourceGuard

public PackageResourceGuard()

Construct.

Method Detail

accept

public boolean accept(String path)

Description copied from interface: IPackageResourceGuard

Whether the package resource that can be reached using the provided parameters may be accessed.

Specified by:

accept in interface IPackageResourceGuard

Parameters:

path - The absolute path, starting from the class root (packages are separated with forward slashes instead of dots).

Returns:

True if access is permitted, false otherwise

See Also:

IPackageResourceGuard.accept(java.lang.String)

acceptExtension

protected boolean acceptExtension(String extension)

Whether the provided extension is accepted.

Parameters:

extension - The extension, starting from the class root (packages are separated with forward slashes instead of dots).

Returns:

True if accepted, false otherwise.

acceptFile

protected boolean acceptFile(String file)

Whether the provided filename is accepted.

Parameters:

file - filename

Returns:

True if accepted, false otherwise.

getBlockedExtensions

protected final Set<String> getBlockedExtensions()

Gets the set of extensions that are denied access.

Returns:

The set of extensions that are denied access

getBlockedFiles

protected final Set<String> getBlockedFiles()

Gets the set of extensions that are denied access.

Returns:

The set of extensions that are denied access

setBlockedExtensions

protected final void setBlockedExtensions(Set<String> blockedExtensions)

Sets the set of extensions that are denied access.

Parameters:

blockedExtensions - Set of extensions that are denied access

setBlockedFiles

protected final void setBlockedFiles(Set<String> blockedFiles)

Sets the set of filenames that are denied access.

Parameters:

blockedFiles - Set of extensions that are denied access

isAllowAccessToRootResources

public final boolean isAllowAccessToRootResources()

Checks whether or not resources in the web root folder can be access.

Returns:

true iff root resources can be accessed

setAllowAccessToRootResources

public final void setAllowAccessToRootResources(boolean allowAccessToRootResources)

Sets whether or not resources in the web root folder can be accessed.

Parameters:

allowAccessToRootResources -