org.jboss.as.controller.access.constraint

Interface ConstraintFactory

All Superinterfaces:

Comparable<ConstraintFactory>

All Known Subinterfaces:

ScopingConstraintFactory

All Known Implementing Classes:

ApplicationTypeConstraint.Factory, SensitiveTargetConstraint.Factory

public interface ConstraintFactory
extends Comparable<ConstraintFactory>

A factory for constraints.

Implementations of this interface should implement #equals(Object) and #hashCode() such that two factories that produce the same constraints can be treated as equal in hash-based collections.

Author:

Brian Stansberry (c) 2013 Red Hat Inc.

Method Summary

Modifier and Type	Method and Description
Constraint	getRequiredConstraint(Action.ActionEffect actionEffect, Action action, TargetAttribute target) Provides a constraint appropriate for the given action and target
Constraint	getRequiredConstraint(Action.ActionEffect actionEffect, Action action, TargetResource target) Provides a constraint appropriate for the given action and target
Constraint	getRequiredConstraint(Action.ActionEffect actionEffect, JmxAction action, JmxTarget target) Provides a constraint appropriate for the given action and target
Constraint	getStandardUserConstraint(StandardRole role, Action.ActionEffect actionEffect) Provides a constraint suitable for the given role in the standard WildFly role based access control system.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getStandardUserConstraint

Constraint getStandardUserConstraint(StandardRole role,
                                     Action.ActionEffect actionEffect)

Provides a constraint suitable for the given role in the standard WildFly role based access control system.

Parameters:

role - the role

actionEffect - the Action.ActionEffect for which the constraint is relevant

Returns:

the constraint. Cannot return null

getRequiredConstraint

Constraint getRequiredConstraint(Action.ActionEffect actionEffect,
                                 Action action,
                                 TargetAttribute target)

Provides a constraint appropriate for the given action and target

Parameters:

actionEffect - the Action.ActionEffect for which the constraint is relevant

action - the action

target - the attribute that is the target of the action

Returns:

the constraint. Cannot return null

getRequiredConstraint

Constraint getRequiredConstraint(Action.ActionEffect actionEffect,
                                 Action action,
                                 TargetResource target)

Provides a constraint appropriate for the given action and target

Parameters:

actionEffect - the Action.ActionEffect for which the constraint is relevant

action - the action

target - the resource that is the target of the action

Returns:

the constraint. Cannot return null

getRequiredConstraint

Constraint getRequiredConstraint(Action.ActionEffect actionEffect,
                                 JmxAction action,
                                 JmxTarget target)

Provides a constraint appropriate for the given action and target

Parameters:

actionEffect - the Action.ActionEffect for which the constraint is relevant

action - the action

target - the jmx bean that is the target of the action

Returns:

the constraint. Cannot return null