org.apache.wicket.settings

Class SecuritySettings

java.lang.Object

org.apache.wicket.settings.SecuritySettings

public class SecuritySettings
extends Object

Class for security related settings

Author:

Jonathan Locke, Chris Turner, Eelco Hillenius, Juergen Donnerstag, Johan Compagner, Igor Vaynberg (ivaynberg), Martijn Dashorst, James Carman

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENCRYPTION_KEY encryption key used by default crypt factory

Constructor Summary

Constructors

Constructor and Description
SecuritySettings()

Method Summary

Modifier and Type	Method and Description
IAuthenticationStrategy	getAuthenticationStrategy() Gets the authentication strategy.
IAuthorizationStrategy	getAuthorizationStrategy() Gets the authorization strategy.
ICryptFactory	getCryptFactory() Note: Prints a warning to stderr if no factory was set and DEFAULT_ENCRYPTION_KEY is used instead.
boolean	getEnforceMounts() Gets whether page mounts should be enforced.
IUnauthorizedComponentInstantiationListener	getUnauthorizedComponentInstantiationListener()
IUnauthorizedResourceRequestListener	getUnauthorizedResourceRequestListener()
SecuritySettings	setAuthenticationStrategy(IAuthenticationStrategy strategy) Sets the authentication strategy.
SecuritySettings	setAuthorizationStrategy(IAuthorizationStrategy strategy) Sets the authorization strategy.
SecuritySettings	setCryptFactory(ICryptFactory cryptFactory) Sets the factory that will be used to create crypt objects.
SecuritySettings	setEnforceMounts(boolean enforce) Sets whether mounts should be enforced.
SecuritySettings	setUnauthorizedComponentInstantiationListener(IUnauthorizedComponentInstantiationListener listener)
SecuritySettings	setUnauthorizedResourceRequestListener(IUnauthorizedResourceRequestListener listener) Sets a listener that will be used when a request to an IResource is not allowed for some reason

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENCRYPTION_KEY

public static final String DEFAULT_ENCRYPTION_KEY

encryption key used by default crypt factory

See Also:

Constant Field Values

Constructor Detail

SecuritySettings

public SecuritySettings()

Method Detail

getAuthorizationStrategy

public IAuthorizationStrategy getAuthorizationStrategy()

Gets the authorization strategy.

Returns:

Returns the authorizationStrategy.

getCryptFactory

public ICryptFactory getCryptFactory()

Note: Prints a warning to stderr if no factory was set and DEFAULT_ENCRYPTION_KEY is used instead.

Returns:

crypt factory used to generate crypt objects

getEnforceMounts

public boolean getEnforceMounts()

Gets whether page mounts should be enforced. If true, requests for a page will be allowed only if the page has been explicitly mounted in MyApplication#init(). This setting basically disables BookmarkableMapper

Returns:

Whether mounts should be enforced

getUnauthorizedComponentInstantiationListener

public IUnauthorizedComponentInstantiationListener getUnauthorizedComponentInstantiationListener()

Returns:

The listener

See Also:

IUnauthorizedComponentInstantiationListener

setAuthorizationStrategy

public SecuritySettings setAuthorizationStrategy(IAuthorizationStrategy strategy)

Sets the authorization strategy.

Parameters:

strategy - new authorization strategy

Returns:

this object for chaining

setCryptFactory

public SecuritySettings setCryptFactory(ICryptFactory cryptFactory)

Sets the factory that will be used to create crypt objects. The crypt object returned from the first call is cached.

Parameters:

cryptFactory -

Returns:

this object for chaining

setEnforceMounts

public SecuritySettings setEnforceMounts(boolean enforce)

Sets whether mounts should be enforced. If true, requests for mounted targets have to done through the mounted paths. If, for instance, a bookmarkable page is mounted to a path, a request to that same page via the bookmarkablePage parameter will be denied.

Parameters:

enforce - Whether mounts should be enforced

Returns:

this object for chaining

setUnauthorizedComponentInstantiationListener

public SecuritySettings setUnauthorizedComponentInstantiationListener(IUnauthorizedComponentInstantiationListener listener)

Parameters:

listener - The listener to set

Returns:

this object for chaining

See Also:

IUnauthorizedComponentInstantiationListener

getUnauthorizedResourceRequestListener

public IUnauthorizedResourceRequestListener getUnauthorizedResourceRequestListener()

Returns:

The listener that will be used when a request to an IResource is not allowed for some reason

setUnauthorizedResourceRequestListener

public SecuritySettings setUnauthorizedResourceRequestListener(IUnauthorizedResourceRequestListener listener)

Sets a listener that will be used when a request to an IResource is not allowed for some reason

Parameters:

listener - The listener

Returns:

this object for chaining

getAuthenticationStrategy

public IAuthenticationStrategy getAuthenticationStrategy()

Gets the authentication strategy.

Returns:

Returns the authentication strategy.

setAuthenticationStrategy

public SecuritySettings setAuthenticationStrategy(IAuthenticationStrategy strategy)

Sets the authentication strategy.

Parameters:

strategy - new authentication strategy

Returns:

this object for chaining