org.jboss.as.controller.capability.registry

Class RuntimeRequirementRegistration

java.lang.Object

org.jboss.as.controller.capability.registry.RequirementRegistration

org.jboss.as.controller.capability.registry.RuntimeRequirementRegistration

public class RuntimeRequirementRegistration
extends RequirementRegistration

Registration information for requirement for a RuntimeCapability. As a runtime requirement is associated with an actual management model, the registration exposes the point in the model that triggered the requirement.

Author:

Brian Stansberry (c) 2014 Red Hat Inc.

Constructor Summary

Constructors

Constructor and Description
RuntimeRequirementRegistration(RuntimeRequirementRegistration toCopy) Copy constructor.
RuntimeRequirementRegistration(String requiredName, String dependentName, CapabilityContext dependentContext, RegistrationPoint registrationPoint) Creates a new requirement registration.
RuntimeRequirementRegistration(String requiredName, String dependentName, CapabilityContext dependentContext, RegistrationPoint registrationPoint, boolean runtimeOnly) Creates a new requirement registration.

Method Summary

Modifier and Type	Method and Description
boolean	addRegistrationPoint(RegistrationPoint toAdd)
RegistrationPoint	getOldestRegistrationPoint() Gets the registration point that been associated with the registration for the longest period.
int	getRegistrationPointCount()
Set<RegistrationPoint>	getRegistrationPoints() Get all registration points associated with this registration.
boolean	isRuntimeOnly() Gets whether the requirement is optional and runtime-only (i.e.
boolean	removeRegistrationPoint(RegistrationPoint toAdd)

Methods inherited from class org.jboss.as.controller.capability.registry.RequirementRegistration

equals, getDependentContext, getDependentId, getDependentName, getRequiredName, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

RuntimeRequirementRegistration

public RuntimeRequirementRegistration(String requiredName,
                                      String dependentName,
                                      CapabilityContext dependentContext,
                                      RegistrationPoint registrationPoint)

Creates a new requirement registration.

Parameters:

requiredName - the name of the required capability

dependentName - the name of the capability that requires requiredName

dependentContext - context in which the dependent capability exists

registrationPoint - point in the configuration model that triggered the requirement

RuntimeRequirementRegistration

public RuntimeRequirementRegistration(String requiredName,
                                      String dependentName,
                                      CapabilityContext dependentContext,
                                      RegistrationPoint registrationPoint,
                                      boolean runtimeOnly)

Creates a new requirement registration.

Parameters:

requiredName - the name of the required capability

dependentName - the name of the capability that requires requiredName

dependentContext - context in which the dependent capability exists

registrationPoint - point in the configuration model that triggered the requirement

runtimeOnly - true if and only if the requirement is optional and runtime-only (i.e. not mandated by the persistent configuration), and therefore should not result in a configuration validation failure if it is not satisfied

RuntimeRequirementRegistration

public RuntimeRequirementRegistration(RuntimeRequirementRegistration toCopy)

Copy constructor.

Parameters:

toCopy - the registration to copy.

Method Detail

isRuntimeOnly

public boolean isRuntimeOnly()

Gets whether the requirement is optional and runtime-only (i.e. not mandated by the persistent configuration), and therefore should not result in a configuration validation failure if it is not satisfied.

Returns:

true if the requirement is optional and runtime-only

getOldestRegistrationPoint

public RegistrationPoint getOldestRegistrationPoint()

Gets the registration point that been associated with the registration for the longest period.

Returns:

the initial registration point, or null if there are no longer any registration points

getRegistrationPoints

public Set<RegistrationPoint> getRegistrationPoints()

Get all registration points associated with this registration.

Returns:

all registration points. Will not be null but may be empty

addRegistrationPoint

public boolean addRegistrationPoint(RegistrationPoint toAdd)

removeRegistrationPoint

public boolean removeRegistrationPoint(RegistrationPoint toAdd)

getRegistrationPointCount

public int getRegistrationPointCount()