org.apache.qpid.server.security.access.config

Class RuleSet

java.lang.Object

org.apache.qpid.server.security.access.config.RuleSet

All Implemented Interfaces:

EventLoggerProvider

public class RuleSet
extends Object
implements EventLoggerProvider

Models the rule configuration for the access control plugin.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ALLOW
static String	DEFAULT_DENY

Constructor Summary

Constructors

Constructor and Description
RuleSet(EventLoggerProvider eventLogger, Collection<Rule> rules, Result defaultResult)

Method Summary

Methods

Modifier and Type	Method and Description
Result	check(Subject subject, LegacyOperation operation, ObjectType objectType, ObjectProperties properties) Checks for the case when the client's address is not known.
Result	check(Subject subject, LegacyOperation operation, ObjectType objectType, ObjectProperties properties, InetAddress addressOfClient) Check the authorisation granted to a particular identity for an operation on an object type with specific properties.
void	configure(Map<String,Boolean> properties) Configure properties for the plugin instance.
List<Rule>	getAllRules() Returns all rules in the RuleSet.
Result	getDefault() Default deny.
EventLogger	getEventLogger()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ALLOW

public static final String DEFAULT_ALLOW

See Also:

Constant Field Values

DEFAULT_DENY

public static final String DEFAULT_DENY

See Also:

Constant Field Values

Constructor Detail

RuleSet

public RuleSet(EventLoggerProvider eventLogger,
       Collection<Rule> rules,
       Result defaultResult)

Method Detail

check

public Result check(Subject subject,
           LegacyOperation operation,
           ObjectType objectType,
           ObjectProperties properties)

Checks for the case when the client's address is not known.

See Also:

check(Subject, LegacyOperation, ObjectType, ObjectProperties, InetAddress)

check

public Result check(Subject subject,
           LegacyOperation operation,
           ObjectType objectType,
           ObjectProperties properties,
           InetAddress addressOfClient)

Check the authorisation granted to a particular identity for an operation on an object type with specific properties. Looks up the entire ruleset, which may be cached, for the user and operation and goes through the rules in order to find the first one that matches. Either defers if there are no rules, returns the result of the first match found, or denies access if there are no matching rules. Normally, it would be expected to have a default deny or allow rule at the end of an access configuration however.

getDefault

public Result getDefault()

Default deny.

configure

public void configure(Map<String,Boolean> properties)

Configure properties for the plugin instance.

Parameters:

properties -

getAllRules

public List<Rule> getAllRules()

Returns all rules in the RuleSet. Primarily intended to support unit-testing.

Returns:

map of rules

getEventLogger

public EventLogger getEventLogger()

Specified by:

getEventLogger in interface EventLoggerProvider