Package org.jboss.as.controller.access.constraint

Class ApplicationTypeConstraint.Factory

java.lang.Object

org.jboss.as.controller.access.constraint.ApplicationTypeConstraint.Factory

All Implemented Interfaces:

Comparable<ConstraintFactory>, ConstraintFactory

Enclosing class:

ApplicationTypeConstraint

public static class ApplicationTypeConstraint.Factory
extends Object

Method Summary

Modifier and Type	Method	Description
ApplicationTypeConfig	addApplicationTypeConfig(ApplicationTypeConfig applicationTypeConfig)	Stores an ApplicationTypeConfig for use in constraints.
int	compareTo(ConstraintFactory o)
Collection<ApplicationTypeConfig>	getApplicationTypeConfigs()
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.
protected int	internalCompare(org.jboss.as.controller.access.constraint.AbstractConstraintFactory other)	Compare this AbstractConstraintFactory to another.

Methods inherited from class java.lang.Object

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

Method Detail

getStandardUserConstraint

public Constraint getStandardUserConstraint(StandardRole role,
                                            Action.ActionEffect actionEffect)

Description copied from interface: ConstraintFactory

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

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

Description copied from interface: ConstraintFactory

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

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

Description copied from interface: ConstraintFactory

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

addApplicationTypeConfig

public ApplicationTypeConfig addApplicationTypeConfig(ApplicationTypeConfig applicationTypeConfig)

Stores an ApplicationTypeConfig for use in constraints.

Parameters:

applicationTypeConfig - the config

Returns:

either the provided confing, or if a compatible one with the same key is already present, that one

Throws:

AssertionError - if a config with the same key is already register and it is not ApplicationTypeConfig.isCompatibleWith(ApplicationTypeConfig) compatible with} the one to be added

getApplicationTypeConfigs

public Collection<ApplicationTypeConfig> getApplicationTypeConfigs()

internalCompare

protected int internalCompare(org.jboss.as.controller.access.constraint.AbstractConstraintFactory other)

Compare this AbstractConstraintFactory to another. Similar contract to Comparable.compareTo(Object) except that a return value of 0 does not imply equality; rather it implies indifference with respect to order. The intended use for this method is in Comparable.compareTo(Object) implementations where the class implementing the method has no preference with respect to order and is willing to go with the preference of the passed in object if it has one.

Parameters:

other - the other constraint factory

getRequiredConstraint

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

Description copied from interface: ConstraintFactory

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

compareTo

public int compareTo(ConstraintFactory o)

Specified by:

compareTo in interface Comparable<ConstraintFactory>