org.wicketstuff.security.components

Class SecureComponentHelper

java.lang.Object

org.wicketstuff.security.components.SecureComponentHelper

public final class SecureComponentHelper
extends Object

Utility class for secure components.

Author:

marrink

See Also:

ISecurityCheck, ISecureComponent, ISecureModel

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_SEPARATOR String used to concatenate the parts that make up alias.

Constructor Summary

Constructors

Constructor and Description
SecureComponentHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static String	alias(Class<?> class1) Builds an alias for a class.
static String	alias(org.apache.wicket.Component component) Builds a 'unique' name for the component.
static String	containerAlias(org.apache.wicket.MarkupContainer container) Builds an alias string for MarkupContainers.
static String[]	containerAliasses(org.apache.wicket.Component component) Builds a set of aliases for this component.
static ISecurityCheck	getSecurityCheck(org.apache.wicket.Component component) The security check placed on the component or null.
static boolean	hasSecureModel(org.apache.wicket.Component component) Checks if the component has a ISecureModel.
static boolean	isActionAuthorized(org.apache.wicket.Component component, String action) Default implementation for ISecureComponent.isActionAuthorized(String) and WaspAuthorizationStrategy.isActionAuthorized(Component, org.apache.wicket.authorization.Action) .
static boolean	isActionAuthorized(org.apache.wicket.Component component, WaspAction action) Default implementation for ISecureComponent.isActionAuthorized(WaspAction) and WaspAuthorizationStrategy.isActionAuthorized(Component, org.apache.wicket.authorization.Action) .
static boolean	isAuthenticated(org.apache.wicket.Component component) Default implementation for ISecureComponent.isAuthenticated().
static org.apache.wicket.Component	setSecurityCheck(org.apache.wicket.Component component, ISecurityCheck securityCheck) Places a security check on a component.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEPARATOR

public static final String PATH_SEPARATOR

String used to concatenate the parts that make up alias.

See Also:

alias(Class), alias(Component), containerAlias(MarkupContainer), containerAliasses(Component), Constant Field Values

Constructor Detail

SecureComponentHelper

public SecureComponentHelper()

Method Detail

getSecurityCheck

public static ISecurityCheck getSecurityCheck(org.apache.wicket.Component component)

The security check placed on the component or null. This uses the metadata of a component to store or retrieve the ISecurityCheck.

Parameters:

component - if null, null will be returned

Returns:

the security check or null if none was placed on the component

setSecurityCheck

public static org.apache.wicket.Component setSecurityCheck(org.apache.wicket.Component component,
                                           ISecurityCheck securityCheck)

Places a security check on a component. This uses the metadata of a component to store or retrieve the ISecurityCheck.

Parameters:

component -

securityCheck -

Returns:

the component or null if the component was null to begin with.

hasSecureModel

public static boolean hasSecureModel(org.apache.wicket.Component component)

Checks if the component has a ISecureModel.

Parameters:

component -

Returns:

true if the component has a securemodel, else false.

isActionAuthorized

public static boolean isActionAuthorized(org.apache.wicket.Component component,
                         String action)

Default implementation for ISecureComponent.isActionAuthorized(String) and WaspAuthorizationStrategy.isActionAuthorized(Component, org.apache.wicket.authorization.Action) . First tries to use the ISecurityCheck from the component if that is not available it tries the ISecureModel if neither is present the action is authorized on the component.

Parameters:

component - the component to check

action - the required action(s)

Returns:

true, if the component is authorized, false otherwise.

See Also:

ISecureComponent.isActionAuthorized(String), ISecurityCheck, ISecureModel

isActionAuthorized

public static boolean isActionAuthorized(org.apache.wicket.Component component,
                         WaspAction action)

Default implementation for ISecureComponent.isActionAuthorized(WaspAction) and WaspAuthorizationStrategy.isActionAuthorized(Component, org.apache.wicket.authorization.Action) . First tries to use the ISecurityCheck from the component if that is not available it tries the ISecureModel if neither is present the action is authorized on the component.

Parameters:

component - the component to check

action - the required action(s)

Returns:

true, if the component is authorized, false otherwise.

See Also:

ISecureComponent.isActionAuthorized(WaspAction), ISecurityCheck, ISecureModel

isAuthenticated

public static boolean isAuthenticated(org.apache.wicket.Component component)

Default implementation for ISecureComponent.isAuthenticated(). First tries to use the ISecurityCheck from the component if that is not available it tries the ISecureModel if neither is present the user is authenticated if WaspAuthorizationStrategy.isUserAuthenticated() returns true.

Parameters:

component - the component to check

Returns:

true, if the user is authenticated, false otherwise.

See Also:

ISecureComponent.isAuthenticated(), ISecurityCheck, ISecureModel

alias

public static String alias(org.apache.wicket.Component component)

Builds a 'unique' name for the component. The name is based on the page class alias and the relative path to the page (if not a page itself). Note that although it is unlikely, it is not impossible for two components to have the same alias.

Parameters:

component -

Returns:

an alias.

Throws:

SecurityException - if the component is null, or if the page of the component is not available.

alias

public static String alias(Class<?> class1)

Builds an alias for a class.

Parameters:

class1 -

Returns:

an alias

containerAlias

public static String containerAlias(org.apache.wicket.MarkupContainer container)

Builds an alias string for MarkupContainers.

Parameters:

container -

Returns:

an alias

containerAliasses

public static String[] containerAliasses(org.apache.wicket.Component component)

Builds a set of aliases for this component. Each alias can be used as name in Permission.

Parameters:

component -

Returns:

an array with aliases for this component