com.xdev.security.authorization

Interface Resource

All Known Implementing Classes:

Resource.StringResource

public interface Resource

The type representing a resource that shall be handled by the authorization framework. When building authorization structures, every permission instance is associated with exactely one resource instance with a specific weight value.

A resource can potentially have linked child resources

Author:

XDEV Software (TM)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Resource.StringResource Simple value type wrapper implementation for a resource String.

Method Summary

Modifier and Type	Method and Description
default Set<? extends Resource>	children() Returns children Resource instances associated with this instance, potentially none (empty collection, but never null).
static Resource	New(String name) Creates a new Resource instance of a simple default type with the passed resource name.
static Resource	provide(Resource existingInstance, String name, Set<String> children) Provides a Resource instance for the passed name.
static void	update(Resource resource, String resourceName, Set<Resource> children) Updates the passed Resource instance for the passed values, where updating means simply validating the instance in the simple default case.

Method Detail

children

default Set<? extends Resource> children()

Returns children Resource instances associated with this instance, potentially none (empty collection, but never null).

Returns:

the child resources of this resource, potentially none.

New

static Resource New(String name)

Creates a new Resource instance of a simple default type with the passed resource name. The passed name may not be null.

Parameters:

name - the name of the new Resource instance.

Returns:

a new Resource instance with the passed name.

provide

static Resource provide(Resource existingInstance,
                        String name,
                        Set<String> children)

Provides a Resource instance for the passed name. If the passed existing instance is not null, it is validated for the specified values, otherwise, a new Resource instance of a simple default type is created and returned.

Parameters:

name - the identifying name of the Resource to be provided

existingInstance - an already existing Resource instance for the passed name, potentially null.

children - the identifying names of the specified resource's child resources, potentially empty.

Returns:

a Resource instance that is guaranteed to have the specified name.

update

static void update(Resource resource,
                   String resourceName,
                   Set<Resource> children)

Updates the passed Resource instance for the passed values, where updating means simply validating the instance in the simple default case.

Parameters:

resourceName - the resource's identifying name.

resource - the Resource instance to be updated.

children - the resource's children, potentially none.