org.onosproject.incubator.net.domain

Class IntentDomain

java.lang.Object

org.onosproject.incubator.net.domain.IntentDomain

@Beta
public class IntentDomain
extends java.lang.Object

Representation of an intent domain which includes the set of internal devices, the set of edge ports, and the implementation of the domain provider.

Constructor Summary

Constructors

Constructor and Description
IntentDomain(IntentDomainId id, java.lang.String name, java.util.Set<DeviceId> internalDevices, java.util.Set<ConnectPoint> edgePorts)

Method Summary

Modifier and Type	Method and Description
java.util.Set<ConnectPoint>	edgePorts() Returns the set of edge ports for the intent domain.
IntentDomainId	id() Returns the id for the intent domain.
java.util.Set<DeviceId>	internalDevices() Returns the set of internal devices for the intent domain (devices under exclusive control of the intent domain).
boolean	isActive() Returns the status of the intent domain.
java.lang.String	name() Returns the friendly name for the intent domain.
IntentDomainProvider	provider() Returns the provider for the intent domain.
void	setProvider(IntentDomainProvider provider) Sets the provider for the intent domain if one is not already set.
void	unsetProvider() Unsets the provider for the intent domain.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntentDomain

public IntentDomain(IntentDomainId id,
                    java.lang.String name,
                    java.util.Set<DeviceId> internalDevices,
                    java.util.Set<ConnectPoint> edgePorts)

Method Detail

id

public IntentDomainId id()

Returns the id for the intent domain.

Returns:

intent domain id

name

public java.lang.String name()

Returns the friendly name for the intent domain.

Returns:

intent domain name

internalDevices

public java.util.Set<DeviceId> internalDevices()

Returns the set of internal devices for the intent domain (devices under exclusive control of the intent domain).

Returns:

set of internal devices

edgePorts

public java.util.Set<ConnectPoint> edgePorts()

Returns the set of edge ports for the intent domain.

Returns:

set of edge ports

provider

public IntentDomainProvider provider()

Returns the provider for the intent domain.

Returns:

intent domain provider

isActive

public boolean isActive()

Returns the status of the intent domain. An intent domain is active if it has an intent domain provider bound, and it is inactive if one is not bound.

Returns:

true if active; false otherwise

setProvider

public void setProvider(IntentDomainProvider provider)

Sets the provider for the intent domain if one is not already set.

Parameters:

provider - new intent domain provider

unsetProvider

public void unsetProvider()

Unsets the provider for the intent domain.