Package org.jboss.as.controller.access
Interface HostEffect
-
public interface HostEffect
Encapsulates information about the relationship of a resource to hosts in a domain.- Author:
- Brian Stansberry (c) 2013 Red Hat Inc.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Set<String>
getAffectedHosts()
PathAddress
getResourceAddress()
Gets the address of the resource whose hosts relationships are described by this object.boolean
isHostEffectGlobal()
Gets whether the resource logically affects all hosts, including hosts that may not presently exist.boolean
isServerEffect()
Gets whether the resource is related to a specific server (either a server resource or a server-config).
-
-
-
Method Detail
-
getResourceAddress
PathAddress getResourceAddress()
Gets the address of the resource whose hosts relationships are described by this object.- Returns:
- the resource address. Will not be
null
-
isHostEffectGlobal
boolean isHostEffectGlobal()
Gets whether the resource logically affects all hosts, including hosts that may not presently exist.Domain level resources (i.e. those that persist configuration to domain.xml) logically affect all hosts even if the servers running on some or all of the current set of hosts are not affected by the resource.
- Returns:
true
if the resource logically affects all hosts;false
if the resource is logically limited to a set of hosts.
-
isServerEffect
boolean isServerEffect()
Gets whether the resource is related to a specific server (either a server resource or a server-config).- Returns:
true
if the resource relates to a specific server.
-
getAffectedHosts
Set<String> getAffectedHosts()
- Returns:
- the names of the hosts, or
null
ifisHostEffectGlobal()
returnstrue
. Will not returnnull
ifisHostEffectGlobal()
returnsfalse
, although it may return an empty set.
-
-