org.onosproject.incubator.store.resource.impl

Class DistributedLabelResourceStore

java.lang.Object

org.onosproject.store.AbstractStore<LabelResourceEvent,LabelResourceDelegate>

org.onosproject.incubator.store.resource.impl.DistributedLabelResourceStore

All Implemented Interfaces:

LabelResourceStore, org.onosproject.store.Store<LabelResourceEvent,LabelResourceDelegate>

@Service
public class DistributedLabelResourceStore
extends org.onosproject.store.AbstractStore<LabelResourceEvent,LabelResourceDelegate>
implements LabelResourceStore

Manages label resources using copycat.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.store.cluster.messaging.ClusterCommunicationService	clusterCommunicator
protected org.onosproject.cluster.ClusterService	clusterService
protected org.onosproject.net.device.DeviceService	deviceService
protected org.onosproject.mastership.MastershipService	mastershipService
protected org.onosproject.store.service.StorageService	storageService

Fields inherited from class org.onosproject.store.AbstractStore

delegate

Constructor Summary

Constructors

Constructor and Description
DistributedLabelResourceStore()

Method Summary

Modifier and Type	Method and Description
void	activate()
java.util.Collection<LabelResource>	applyFromDevicePool(org.onosproject.net.DeviceId deviceId, long applyNum) Returns labels from resource pool by a specific device id.
java.util.Collection<LabelResource>	applyFromGlobalPool(long applyNum) Returns labels from the global label resource pool.
boolean	createDevicePool(org.onosproject.net.DeviceId deviceId, LabelResourceId beginLabel, LabelResourceId endLabel) Creates a label resource of some device id from begin label to end label.
boolean	createGlobalPool(LabelResourceId beginLabel, LabelResourceId endLabel) Creates the global label resource pool.
void	deactivate()
boolean	destroyDevicePool(org.onosproject.net.DeviceId deviceId) Destroys a label resource pool of a specific device id.
boolean	destroyGlobalPool() Destroys a the global label resource pool.
LabelResourcePool	getDeviceLabelResourcePool(org.onosproject.net.DeviceId deviceId) Returns the label resource pool by a specific device id.
long	getFreeNumOfDevicePool(org.onosproject.net.DeviceId deviceId) Returns the unused label number of a label resource pool by a specific device id.
long	getFreeNumOfGlobalPool() Returns the unused number of a global label resource pool.
LabelResourcePool	getGlobalLabelResourcePool() Returns the global label resource pool.
boolean	isDevicePoolFull(org.onosproject.net.DeviceId deviceId) Judges if the pool of a specific device id is full.
boolean	isGlobalPoolFull() Judges if the global resource pool is full.
boolean	releaseToDevicePool(com.google.common.collect.Multimap<org.onosproject.net.DeviceId,LabelResource> release) Releases unused labels to device pools .
boolean	releaseToGlobalPool(java.util.Set<LabelResourceId> release) Releases unused labels to the global resource pool.

Methods inherited from class org.onosproject.store.AbstractStore

hasDelegate, notifyDelegate, notifyDelegate, setDelegate, unsetDelegate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Field Detail

storageService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.store.service.StorageService storageService

mastershipService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.mastership.MastershipService mastershipService

clusterCommunicator

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.store.cluster.messaging.ClusterCommunicationService clusterCommunicator

clusterService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.cluster.ClusterService clusterService

deviceService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.net.device.DeviceService deviceService

Constructor Detail

DistributedLabelResourceStore

public DistributedLabelResourceStore()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

createDevicePool

public boolean createDevicePool(org.onosproject.net.DeviceId deviceId,
                                LabelResourceId beginLabel,
                                LabelResourceId endLabel)

Description copied from interface: LabelResourceStore

Creates a label resource of some device id from begin label to end label.

Specified by:

createDevicePool in interface LabelResourceStore

Parameters:

deviceId - device identifier

beginLabel - represents for the first label id in the range of label pool

endLabel - represents for the last label id in the range of label pool

Returns:

success or fail

createGlobalPool

public boolean createGlobalPool(LabelResourceId beginLabel,
                                LabelResourceId endLabel)

Description copied from interface: LabelResourceStore

Creates the global label resource pool.

Specified by:

createGlobalPool in interface LabelResourceStore

Parameters:

beginLabel - represents for the first label id in the range of label pool

endLabel - represents for the last label id in the range of label pool

Returns:

success or fail

destroyDevicePool

public boolean destroyDevicePool(org.onosproject.net.DeviceId deviceId)

Description copied from interface: LabelResourceStore

Destroys a label resource pool of a specific device id.

Specified by:

destroyDevicePool in interface LabelResourceStore

Parameters:

deviceId - device identifier

Returns:

success or fail

applyFromDevicePool

public java.util.Collection<LabelResource> applyFromDevicePool(org.onosproject.net.DeviceId deviceId,
                                                               long applyNum)

Description copied from interface: LabelResourceStore

Returns labels from resource pool by a specific device id.

Specified by:

applyFromDevicePool in interface LabelResourceStore

Parameters:

deviceId - device identifier

applyNum - the applying number

Returns:

collection of applying labels

releaseToDevicePool

public boolean releaseToDevicePool(com.google.common.collect.Multimap<org.onosproject.net.DeviceId,LabelResource> release)

Description copied from interface: LabelResourceStore

Releases unused labels to device pools .

Specified by:

releaseToDevicePool in interface LabelResourceStore

Parameters:

release - the collection of releasing labels

Returns:

success or fail

isDevicePoolFull

public boolean isDevicePoolFull(org.onosproject.net.DeviceId deviceId)

Description copied from interface: LabelResourceStore

Judges if the pool of a specific device id is full.

Specified by:

isDevicePoolFull in interface LabelResourceStore

Parameters:

deviceId - device identifier

Returns:

yes or no

getFreeNumOfDevicePool

public long getFreeNumOfDevicePool(org.onosproject.net.DeviceId deviceId)

Description copied from interface: LabelResourceStore

Returns the unused label number of a label resource pool by a specific device id.

Specified by:

getFreeNumOfDevicePool in interface LabelResourceStore

Parameters:

deviceId - device identifier

Returns:

number of unused labels

getDeviceLabelResourcePool

public LabelResourcePool getDeviceLabelResourcePool(org.onosproject.net.DeviceId deviceId)

Description copied from interface: LabelResourceStore

Returns the label resource pool by a specific device id.

Specified by:

getDeviceLabelResourcePool in interface LabelResourceStore

Parameters:

deviceId - device identifier

Returns:

the device label resource pool

destroyGlobalPool

public boolean destroyGlobalPool()

Description copied from interface: LabelResourceStore

Destroys a the global label resource pool.

Specified by:

destroyGlobalPool in interface LabelResourceStore

Returns:

success or fail

applyFromGlobalPool

public java.util.Collection<LabelResource> applyFromGlobalPool(long applyNum)

Description copied from interface: LabelResourceStore

Returns labels from the global label resource pool.

Specified by:

applyFromGlobalPool in interface LabelResourceStore

Parameters:

applyNum - apply the number of labels

Returns:

collection of labels

releaseToGlobalPool

public boolean releaseToGlobalPool(java.util.Set<LabelResourceId> release)

Description copied from interface: LabelResourceStore

Releases unused labels to the global resource pool.

Specified by:

releaseToGlobalPool in interface LabelResourceStore

Parameters:

release - release the collection of releasing labels

Returns:

success or fail

isGlobalPoolFull

public boolean isGlobalPoolFull()

Description copied from interface: LabelResourceStore

Judges if the global resource pool is full.

Specified by:

isGlobalPoolFull in interface LabelResourceStore

Returns:

yes or no

getFreeNumOfGlobalPool

public long getFreeNumOfGlobalPool()

Description copied from interface: LabelResourceStore

Returns the unused number of a global label resource pool.

Specified by:

getFreeNumOfGlobalPool in interface LabelResourceStore

Returns:

number of unused labels

getGlobalLabelResourcePool

public LabelResourcePool getGlobalLabelResourcePool()

Description copied from interface: LabelResourceStore

Returns the global label resource pool.

Specified by:

getGlobalLabelResourcePool in interface LabelResourceStore

Returns:

the global label resource pool