com.xdev.security.authorization.ui

Class Authorization

java.lang.Object

com.xdev.security.authorization.ui.Authorization

public final class Authorization
extends Object

Utility class for authorization purposes.

Author:

XDEV Software

Method Summary

Modifier and Type	Method and Description
static void	evaluateComponent(XdevComponent component, Subject subject) Evaluates the SubjectEvaluatingComponentExtension of the component against the given subject.
static void	evaluateComponents(XdevComponent root) Evaluates all SubjectEvaluatingComponentExtensions in the component hierarchy of root against the current user.
static void	evaluateComponents(XdevComponent root, Subject subject) Evaluates all SubjectEvaluatingComponentExtensions in the component hierarchy of root against the given subject.
static AuthorizationManager	getAuthorizationManager() Returns the AuthorizationManager of the current user session.
static Resource	getResource(String name) Searches for a specific resource in the current AuthorizationManager.
static Resource	resource(String name) Searches for a specific resource with getResource(String).
static void	setAuthorizationManager(AuthorizationManager authorizationManager) Registers an AuthorizationManager in the current user session.
static void	setSubjectEvaluatingComponentExtension(XdevComponent component, SubjectEvaluatingComponentExtension extension) Registers a SubjectEvaluatingComponentExtension with component.

Methods inherited from class java.lang.Object

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

Method Detail

setAuthorizationManager

public static void setAuthorizationManager(AuthorizationManager authorizationManager)

Registers an AuthorizationManager in the current user session.

Parameters:

authorizationManager - the AuthorizationManager to register

See Also:

getAuthorizationManager()

getAuthorizationManager

public static AuthorizationManager getAuthorizationManager()

Returns the AuthorizationManager of the current user session.

Returns:

the AuthorizationManager

See Also:

setAuthorizationManager(AuthorizationManager)

getResource

public static Resource getResource(String name)
                            throws IllegalStateException,
                                   IllegalArgumentException

Searches for a specific resource in the current AuthorizationManager. If no resource is found an IllegalArgumentException is thrown.

Parameters:

name - the resource's name to search for

Returns:

the resource

Throws:

IllegalStateException - if no authorization manager has been initialized

IllegalArgumentException - if the resources couldn't be found

See Also:

resource(String)

resource

public static Resource resource(String name)

Searches for a specific resource with getResource(String). If no resource with the specific name is present a new one will be created and returned.

Parameters:

name - the resource's name

Returns:

the found or created resource

See Also:

getResource(String)

setSubjectEvaluatingComponentExtension

public static void setSubjectEvaluatingComponentExtension(XdevComponent component,
                                                          SubjectEvaluatingComponentExtension extension)

Registers a SubjectEvaluatingComponentExtension with component.

Parameters:

component - the component to register the extension with

extension - the extension to register

See Also:

evaluateComponents(XdevComponent)

evaluateComponents

public static void evaluateComponents(XdevComponent root)

Evaluates all SubjectEvaluatingComponentExtensions in the component hierarchy of root against the current user.

Parameters:

root - the root component

See Also:

Authentication.isUserLoggedIn(), Authentication.login(Subject, Object), Authentication.setUser(Subject, Object), Authentication.getUser(), setSubjectEvaluatingComponentExtension(XdevComponent, SubjectEvaluatingComponentExtension)

evaluateComponents

public static void evaluateComponents(XdevComponent root,
                                      Subject subject)

Evaluates all SubjectEvaluatingComponentExtensions in the component hierarchy of root against the given subject.

Parameters:

root - the root component

subject - the subject to evaluate against

See Also:

evaluateComponents(XdevComponent), setSubjectEvaluatingComponentExtension(XdevComponent, SubjectEvaluatingComponentExtension)

evaluateComponent

public static void evaluateComponent(XdevComponent component,
                                     Subject subject)

Evaluates the SubjectEvaluatingComponentExtension of the component against the given subject.

If no SubjectEvaluatingComponentExtension has been registered with the component this method has no effect.

Parameters:

component - the component to check

subject - the subject to evaluate against

See Also:

setSubjectEvaluatingComponentExtension(XdevComponent, SubjectEvaluatingComponentExtension)