org.jboss.as.controller.capability.registry

Interface CapabilityContext

All Known Implementing Classes:

HostCapabilityContext, ProfileChildCapabilityContext, SocketBindingGroupChildContext

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	canSatisfyRequirement(CapabilityId dependent, String required, CapabilityResolutionContext context) Gets whether a given capability associated with this context can satisfy the given requirement.
default Set<CapabilityContext>	getIncludingContexts(CapabilityResolutionContext context) Gets any contexts that logically include this one, i.e.
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

canSatisfyRequirement

boolean canSatisfyRequirement(CapabilityId dependent,
                              String required,
                              CapabilityResolutionContext context)

Gets whether a given capability associated with this context can satisfy the given requirement.

Parameters:

dependent - id of the dependent capability. Cannot be null

required - name of the capability associated with this capability context. May be null if the dependent name is not known.

context - resolution context in use for this resolution run

Returns:

true if the requirement can be satisfied from this context; false otherwise

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

getIncludingContexts

default Set<CapabilityContext> getIncludingContexts(CapabilityResolutionContext context)

Gets any contexts that logically include this one, i.e. where this context can satisfy requirements as if it were the including context.

Parameters:

context - resolution context in use for this resolution run

Returns:

the including contexts. Will not be null but may be empty.