org.xwiki.security.authorization.cache

Interface SecurityCache

@Role
public interface SecurityCache

A cache for fast access right rules checking.

Since:

4.0M2

Version:

$Id: 7abc976fa019fffeb5cd785d4620ea8fcc874907 $

Method Summary

Methods

Modifier and Type	Method and Description
SecurityRuleEntry	get(SecurityReference entity) Get a cached entry.
SecurityAccessEntry	get(UserSecurityReference user, SecurityReference entity) Get a cached entry.
void	remove(SecurityReference entity) Remove an entry from this cache.
void	remove(UserSecurityReference user, SecurityReference entity) Remove an entry from this cache.

Method Detail

get

SecurityAccessEntry get(UserSecurityReference user,
                      SecurityReference entity)

Get a cached entry.

Parameters:

user - Entity representing the user.

entity - The entity which is the object of this cache entry.

Returns:

The cache entry, or null.

get

SecurityRuleEntry get(SecurityReference entity)

Get a cached entry.

Parameters:

entity - The entity which is the object of this cache entry.

Returns:

The cache entry, or null.

remove

void remove(UserSecurityReference user,
          SecurityReference entity)

Remove an entry from this cache. All child entries of this entry will also be removed.

Parameters:

user - Entity representing the user.

entity - The entity which is the object of this cache entry.

remove

void remove(SecurityReference entity)

Remove an entry from this cache. All child entries of this entry will also be removed.

Parameters:

entity - The entity which is the object of this cache entry.