org.jboss.as.controller.capability.registry

Interface CapabilityContext

public interface CapabilityContext

Context in which a capability is available.

The GLOBAL context can be used for most cases. A Host Controller will use a different implementation of this interface for capabilities that are limited to some subset of the domain-wide model, e.g. a single profile.

Implementations of this interface should override #equals(Object) and #hashCode() such that logically equivalent but non-identical instances can function as keys in a hash map.

Author:

Brian Stansberry (c) 2014 Red Hat Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static CapabilityContext	GLOBAL A CapabilityContext that can satisfy any dependent context.

Method Summary

Modifier and Type	Method and Description
boolean	canSatisfyRequirements(CapabilityContext dependentContext) Gets whether this context can satisfy a requirement associated with another context.
String	getName() Gets a descriptive name of the context
boolean	requiresConsistencyCheck() Gets whether a consistency check must be performed when other capabilities depend on capabilities in this context.

Field Detail

GLOBAL

static final CapabilityContext GLOBAL

A CapabilityContext that can satisfy any dependent context. Meant for capabilities that are present regardless of any context, or for convenience use in cases where there is only one context.

Method Detail

canSatisfyRequirements

boolean canSatisfyRequirements(CapabilityContext dependentContext)

Gets whether this context can satisfy a requirement associated with another context.

Parameters:

dependentContext - a context associated with a capability that may require the capabilities associated with this context

Returns:

true if this context can satisfy requirements from capabilities in dependentContext

requiresConsistencyCheck

boolean requiresConsistencyCheck()

Gets whether a consistency check must be performed when other capabilities depend on capabilities in this context. A consistency check is necessary if different capabilities in the dependent context can potentially require capabilities in different other contexts, but all such capabilities must be available in at least one context.

Returns:

true if a consistency check is required

getName

String getName()

Gets a descriptive name of the context

Returns:

the name. Will not return null