org.jboss.as.controller.interfaces

Interface InterfaceCriteria

All Superinterfaces:

Comparable<InterfaceCriteria>, Serializable

All Known Implementing Classes:

AbstractInterfaceCriteria, AnyInterfaceCriteria, InetAddressMatchInterfaceCriteria, LinkLocalInterfaceCriteria, LoopbackAddressInterfaceCriteria, LoopbackInterfaceCriteria, NicInterfaceCriteria, NicMatchInterfaceCriteria, NotInterfaceCriteria, OverallInterfaceCriteria, PointToPointInterfaceCriteria, PublicAddressInterfaceCriteria, SiteLocalInterfaceCriteria, SubnetMatchInterfaceCriteria, SupportsMulticastInterfaceCriteria, UpInterfaceCriteria, VirtualInterfaceCriteria, WildcardInetAddressInterfaceCriteria

public interface InterfaceCriteria
extends Serializable, Comparable<InterfaceCriteria>

A criteria used to determine what IP address to use for an interface.

Author:

Brian Stansberry

Method Summary

Modifier and Type	Method and Description
Map<NetworkInterface,Set<InetAddress>>	getAcceptableAddresses(Map<NetworkInterface,Set<InetAddress>> candidates) Gets which of the available network interfaces and addresses are acceptable for use.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getAcceptableAddresses

Map<NetworkInterface,Set<InetAddress>> getAcceptableAddresses(Map<NetworkInterface,Set<InetAddress>> candidates)
                                                       throws SocketException

Gets which of the available network interfaces and addresses are acceptable for use. Acceptance is indicated by including a network interface and the acceptable addresses associated with it in a map. The map may include more than one entry, and the set of addresses for any given entry may include more than one value. For those criteria which override the configured addresses (e.g. LoopbackAddressInterfaceCriteria, the override address should be returned in the set associated with the relevant interface.

Parameters:

candidates - map of candidate interfaces and addresses. This map may include all known interfaces and addresses or the system, or a subset of them that were acceptable to other criteria.

Returns:

map of accepted network interfaces to their acceptable addresses. Cannot return null; an empty map should be returned if no acceptable items are found. The set of addresses stored as values in the map should not be null or empty; no key for an interface should be stored if no addresses are acceptable. A criteria that only cares about the network interface should return a map including all provided candidate addresses for that interface.

Throws:

SocketException