X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsamples%2Ftoaster-provider%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsample%2Ftoaster%2Fprovider%2FOpendaylightToaster.java;h=e475c320d1e11c45258ebb6415083589fcf0302d;hp=b7518e094d0e61594a391c2fc4a78b181294e00a;hb=390c714cdeae2efe67d55d5a401929653b534f5c;hpb=17d82f582a6bc13c78be3b19954ff8c021180e93 diff --git a/opendaylight/md-sal/samples/toaster-provider/src/main/java/org/opendaylight/controller/sample/toaster/provider/OpendaylightToaster.java b/opendaylight/md-sal/samples/toaster-provider/src/main/java/org/opendaylight/controller/sample/toaster/provider/OpendaylightToaster.java index b7518e094d..e475c320d1 100644 --- a/opendaylight/md-sal/samples/toaster-provider/src/main/java/org/opendaylight/controller/sample/toaster/provider/OpendaylightToaster.java +++ b/opendaylight/md-sal/samples/toaster-provider/src/main/java/org/opendaylight/controller/sample/toaster/provider/OpendaylightToaster.java @@ -7,24 +7,38 @@ */ package org.opendaylight.controller.sample.toaster.provider; +import static org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType.DELETE; +import static org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType.WRITE; +import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.CONFIGURATION; +import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.OPERATIONAL; +import static org.opendaylight.yangtools.yang.common.RpcError.ErrorType.APPLICATION; + +import com.google.common.base.Function; +import com.google.common.base.Optional; +import com.google.common.base.Preconditions; +import com.google.common.util.concurrent.AsyncFunction; +import com.google.common.util.concurrent.FutureCallback; +import com.google.common.util.concurrent.Futures; +import com.google.common.util.concurrent.ListenableFuture; +import com.google.common.util.concurrent.SettableFuture; +import java.util.Collection; import java.util.concurrent.Callable; -import java.util.concurrent.ExecutionException; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.atomic.AtomicLong; import java.util.concurrent.atomic.AtomicReference; - -import org.opendaylight.controller.config.yang.config.toaster_provider.impl.ToasterProviderRuntimeMXBean; import org.opendaylight.controller.md.sal.binding.api.DataBroker; -import org.opendaylight.controller.md.sal.binding.api.DataChangeListener; +import org.opendaylight.controller.md.sal.binding.api.DataObjectModification; +import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener; +import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier; +import org.opendaylight.controller.md.sal.binding.api.DataTreeModification; +import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService; import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction; import org.opendaylight.controller.md.sal.binding.api.WriteTransaction; -import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent; -import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException; import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException; -import org.opendaylight.controller.sal.binding.api.NotificationProviderService; +import org.opendaylight.controller.md.sal.common.util.jmx.AbstractMXBean; import org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.DisplayString; import org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.MakeToastInput; import org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.RestockToasterInput; @@ -35,129 +49,152 @@ import org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120 import org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.ToasterRestocked; import org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.ToasterRestockedBuilder; import org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.ToasterService; -import org.opendaylight.yangtools.yang.binding.DataObject; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.toaster.app.config.rev160503.ToasterAppConfig; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.toaster.app.config.rev160503.ToasterAppConfigBuilder; +import org.opendaylight.yangtools.concepts.ListenerRegistration; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; import org.opendaylight.yangtools.yang.common.RpcError; -import org.opendaylight.yangtools.yang.common.RpcResultBuilder; import org.opendaylight.yangtools.yang.common.RpcError.ErrorType; import org.opendaylight.yangtools.yang.common.RpcResult; +import org.opendaylight.yangtools.yang.common.RpcResultBuilder; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import com.google.common.base.Function; -import com.google.common.base.Optional; -import com.google.common.util.concurrent.AsyncFunction; -import com.google.common.util.concurrent.FutureCallback; -import com.google.common.util.concurrent.Futures; -import com.google.common.util.concurrent.ListenableFuture; -import com.google.common.util.concurrent.SettableFuture; - -public class OpendaylightToaster implements ToasterService, ToasterProviderRuntimeMXBean, - DataChangeListener, AutoCloseable { +public class OpendaylightToaster extends AbstractMXBean + implements ToasterService, ToasterProviderRuntimeMXBean, DataTreeChangeListener, AutoCloseable { private static final Logger LOG = LoggerFactory.getLogger(OpendaylightToaster.class); - public static final InstanceIdentifier TOASTER_IID = InstanceIdentifier.builder(Toaster.class).build(); - + private static final InstanceIdentifier TOASTER_IID = InstanceIdentifier.builder(Toaster.class).build(); private static final DisplayString TOASTER_MANUFACTURER = new DisplayString("Opendaylight"); private static final DisplayString TOASTER_MODEL_NUMBER = new DisplayString("Model 1 - Binding Aware"); - private NotificationProviderService notificationProvider; - private DataBroker dataProvider; + private DataBroker dataBroker; + private NotificationPublishService notificationProvider; + private ListenerRegistration dataTreeChangeListenerRegistration; private final ExecutorService executor; - // The following holds the Future for the current make toast task. - // This is used to cancel the current toast. + // This holds the Future for the current make toast task and is used to cancel the current toast. private final AtomicReference> currentMakeToastTask = new AtomicReference<>(); - private final AtomicLong amountOfBreadInStock = new AtomicLong( 100 ); - + // Thread safe holders + private final AtomicLong amountOfBreadInStock = new AtomicLong(100); private final AtomicLong toastsMade = new AtomicLong(0); + private final AtomicLong darknessFactor = new AtomicLong(1000); - // Thread safe holder for our darkness multiplier. - private final AtomicLong darknessFactor = new AtomicLong( 1000 ); + private final ToasterAppConfig toasterAppConfig; public OpendaylightToaster() { + this(new ToasterAppConfigBuilder().setManufacturer(TOASTER_MANUFACTURER).setModelNumber(TOASTER_MODEL_NUMBER) + .setMaxMakeToastTries(2).build()); + } + + public OpendaylightToaster(ToasterAppConfig toasterAppConfig) { + super("OpendaylightToaster", "toaster-provider", null); executor = Executors.newFixedThreadPool(1); + this.toasterAppConfig = toasterAppConfig; } - public void setNotificationProvider(final NotificationProviderService salService) { - this.notificationProvider = salService; + public void setNotificationProvider(final NotificationPublishService notificationPublishService) { + this.notificationProvider = notificationPublishService; } - public void setDataProvider(final DataBroker salDataProvider) { - this.dataProvider = salDataProvider; - setToasterStatusUp( null ); + public void setDataBroker(final DataBroker dataBroker) { + this.dataBroker = dataBroker; + } + + public void init() { + LOG.info("Initializing..."); + + Preconditions.checkNotNull(dataBroker, "dataBroker must be set"); + dataTreeChangeListenerRegistration = dataBroker.registerDataTreeChangeListener( + new DataTreeIdentifier<>(CONFIGURATION, TOASTER_IID), this); + setToasterStatusUp(null); + + // Register our MXBean. + register(); } /** * Implemented from the AutoCloseable interface. */ @Override - public void close() throws ExecutionException, InterruptedException { + public void close() { + LOG.info("Closing..."); + + // Unregister our MXBean. + unregister(); + // When we close this service we need to shutdown our executor! executor.shutdown(); - if (dataProvider != null) { - WriteTransaction tx = dataProvider.newWriteOnlyTransaction(); - tx.delete(LogicalDatastoreType.OPERATIONAL,TOASTER_IID); - Futures.addCallback( tx.submit(), new FutureCallback() { + if (dataTreeChangeListenerRegistration != null) { + dataTreeChangeListenerRegistration.close(); + } + + if (dataBroker != null) { + WriteTransaction tx = dataBroker.newWriteOnlyTransaction(); + tx.delete(OPERATIONAL,TOASTER_IID); + Futures.addCallback(tx.submit(), new FutureCallback() { @Override - public void onSuccess( final Void result ) { - LOG.debug( "Delete Toaster commit result: " + result ); + public void onSuccess(final Void result) { + LOG.debug("Successfully deleted the operational Toaster"); } @Override - public void onFailure( final Throwable t ) { - LOG.error( "Delete of Toaster failed", t ); + public void onFailure(final Throwable failure) { + LOG.error("Delete of the operational Toaster failed", failure); } - } ); + }); } } - private Toaster buildToaster( final ToasterStatus status ) { - + private Toaster buildToaster(final ToasterStatus status) { // note - we are simulating a device whose manufacture and model are // fixed (embedded) into the hardware. // This is why the manufacture and model number are hardcoded. - return new ToasterBuilder().setToasterManufacturer( TOASTER_MANUFACTURER ) - .setToasterModelNumber( TOASTER_MODEL_NUMBER ) - .setToasterStatus( status ) - .build(); + return new ToasterBuilder().setToasterManufacturer(toasterAppConfig.getManufacturer()) + .setToasterModelNumber(toasterAppConfig.getModelNumber()).setToasterStatus(status).build(); } /** - * Implemented from the DataChangeListener interface. + * Implemented from the DataTreeChangeListener interface. */ @Override - public void onDataChanged( final AsyncDataChangeEvent, DataObject> change ) { - DataObject dataObject = change.getUpdatedSubtree(); - if( dataObject instanceof Toaster ) - { - Toaster toaster = (Toaster) dataObject; - Long darkness = toaster.getDarknessFactor(); - if( darkness != null ) - { - darknessFactor.set( darkness ); + public void onDataTreeChanged(Collection> changes) { + for (DataTreeModification change: changes) { + DataObjectModification rootNode = change.getRootNode(); + if (rootNode.getModificationType() == WRITE) { + Toaster oldToaster = rootNode.getDataBefore(); + Toaster newToaster = rootNode.getDataAfter(); + LOG.info("onDataTreeChanged - Toaster config with path {} was added or replaced: " + + "old Toaster: {}, new Toaster: {}", change.getRootPath().getRootIdentifier(), + oldToaster, newToaster); + + Long darkness = newToaster.getDarknessFactor(); + if (darkness != null) { + darknessFactor.set(darkness); + } + } else if (rootNode.getModificationType() == DELETE) { + LOG.info("onDataTreeChanged - Toaster config with path {} was deleted: old Toaster: {}", + change.getRootPath().getRootIdentifier(), rootNode.getDataBefore()); } } } /** - * RPC call implemented from the ToasterService interface that cancels the current - * toast, if any. + * RPC call implemented from the ToasterService interface that cancels the current toast, if any. */ @Override public Future> cancelToast() { - - Future current = currentMakeToastTask.getAndSet( null ); - if( current != null ) { - current.cancel( true ); + Future current = currentMakeToastTask.getAndSet(null); + if (current != null) { + current.cancel(true); } - // Always return success from the cancel toast call. - return Futures.immediateFuture( RpcResultBuilder. success().build() ); + // Always return success from the cancel toast call + return Futures.immediateFuture(RpcResultBuilder.success().build()); } /** @@ -169,112 +206,98 @@ public class OpendaylightToaster implements ToasterService, ToasterProviderRunti final SettableFuture> futureResult = SettableFuture.create(); - checkStatusAndMakeToast( input, futureResult, 2 ); + checkStatusAndMakeToast(input, futureResult, toasterAppConfig.getMaxMakeToastTries()); return futureResult; } private RpcError makeToasterOutOfBreadError() { - return RpcResultBuilder.newError( ErrorType.APPLICATION, "resource-denied", - "Toaster is out of bread", "out-of-stock", null, null ); + return RpcResultBuilder.newError(APPLICATION, "resource-denied", "Toaster is out of bread", "out-of-stock", + null, null); } private RpcError makeToasterInUseError() { - return RpcResultBuilder.newWarning( ErrorType.APPLICATION, "in-use", - "Toaster is busy", null, null, null ); + return RpcResultBuilder.newWarning(APPLICATION, "in-use", "Toaster is busy", null, null, null); } - private void checkStatusAndMakeToast( final MakeToastInput input, - final SettableFuture> futureResult, - final int tries ) { - + private void checkStatusAndMakeToast(final MakeToastInput input, final SettableFuture> futureResult, + final int tries) { // Read the ToasterStatus and, if currently Up, try to write the status to Down. // If that succeeds, then we essentially have an exclusive lock and can proceed // to make toast. - - final ReadWriteTransaction tx = dataProvider.newReadWriteTransaction(); - ListenableFuture> readFuture = - tx.read( LogicalDatastoreType.OPERATIONAL, TOASTER_IID ); + final ReadWriteTransaction tx = dataBroker.newReadWriteTransaction(); + ListenableFuture> readFuture = tx.read(OPERATIONAL, TOASTER_IID); final ListenableFuture commitFuture = - Futures.transform( readFuture, new AsyncFunction,Void>() { - - @Override - public ListenableFuture apply( - final Optional toasterData ) throws Exception { - - ToasterStatus toasterStatus = ToasterStatus.Up; - if( toasterData.isPresent() ) { - toasterStatus = toasterData.get().getToasterStatus(); - } - - LOG.debug( "Read toaster status: {}", toasterStatus ); - - if( toasterStatus == ToasterStatus.Up ) { - - if( outOfBread() ) { - LOG.debug( "Toaster is out of bread" ); + Futures.transform(readFuture, (AsyncFunction, Void>) toasterData -> { + ToasterStatus toasterStatus = ToasterStatus.Up; + if (toasterData.isPresent()) { + toasterStatus = toasterData.get().getToasterStatus(); + } - return Futures.immediateFailedCheckedFuture( - new TransactionCommitFailedException( "", makeToasterOutOfBreadError() ) ); - } + LOG.debug("Read toaster status: {}", toasterStatus); - LOG.debug( "Setting Toaster status to Down" ); + if (toasterStatus == ToasterStatus.Up) { - // We're not currently making toast - try to update the status to Down - // to indicate we're going to make toast. This acts as a lock to prevent - // concurrent toasting. - tx.put( LogicalDatastoreType.OPERATIONAL, TOASTER_IID, - buildToaster( ToasterStatus.Down ) ); - return tx.submit(); + if (outOfBread()) { + LOG.debug("Toaster is out of bread"); + return Futures.immediateFailedCheckedFuture( + new TransactionCommitFailedException("", makeToasterOutOfBreadError())); } - LOG.debug( "Oops - already making toast!" ); + LOG.debug("Setting Toaster status to Down"); - // Return an error since we are already making toast. This will get - // propagated to the commitFuture below which will interpret the null - // TransactionStatus in the RpcResult as an error condition. - return Futures.immediateFailedCheckedFuture( - new TransactionCommitFailedException( "", makeToasterInUseError() ) ); + // We're not currently making toast - try to update the status to Down + // to indicate we're going to make toast. This acts as a lock to prevent + // concurrent toasting. + tx.put(OPERATIONAL, TOASTER_IID, buildToaster(ToasterStatus.Down)); + return tx.submit(); } - } ); - Futures.addCallback( commitFuture, new FutureCallback() { + LOG.debug("Oops - already making toast!"); + + // Return an error since we are already making toast. This will get + // propagated to the commitFuture below which will interpret the null + // TransactionStatus in the RpcResult as an error condition. + return Futures.immediateFailedCheckedFuture( + new TransactionCommitFailedException("", makeToasterInUseError())); + }); + + Futures.addCallback(commitFuture, new FutureCallback() { @Override - public void onSuccess( final Void result ) { + public void onSuccess(final Void result) { // OK to make toast - currentMakeToastTask.set( executor.submit( new MakeToastTask( input, futureResult ) ) ); + currentMakeToastTask.set(executor.submit(new MakeToastTask(input, futureResult))); } @Override - public void onFailure( final Throwable ex ) { - if( ex instanceof OptimisticLockFailedException ) { + public void onFailure(final Throwable ex) { + if (ex instanceof OptimisticLockFailedException) { // Another thread is likely trying to make toast simultaneously and updated the // status before us. Try reading the status again - if another make toast is // now in progress, we should get ToasterStatus.Down and fail. - if( ( tries - 1 ) > 0 ) { - LOG.debug( "Got OptimisticLockFailedException - trying again" ); - - checkStatusAndMakeToast( input, futureResult, tries - 1 ); + if (tries - 1 > 0) { + LOG.debug("Got OptimisticLockFailedException - trying again"); + checkStatusAndMakeToast(input, futureResult, tries - 1); + } else { + futureResult.set(RpcResultBuilder.failed() + .withError(ErrorType.APPLICATION, ex.getMessage()).build()); } - else { - futureResult.set( RpcResultBuilder. failed() - .withError( ErrorType.APPLICATION, ex.getMessage() ).build() ); - } - - } else { - - LOG.debug( "Failed to commit Toaster status", ex ); + } else if (ex instanceof TransactionCommitFailedException) { + LOG.debug("Failed to commit Toaster status", ex); // Probably already making toast. - futureResult.set( RpcResultBuilder. failed() - .withRpcErrors( ((TransactionCommitFailedException)ex).getErrorList() ) - .build() ); + futureResult.set(RpcResultBuilder.failed() + .withRpcErrors(((TransactionCommitFailedException)ex).getErrorList()).build()); + } else { + LOG.debug("Unexpected error committing Toaster status", ex); + futureResult.set(RpcResultBuilder.failed().withError(ErrorType.APPLICATION, + "Unexpected error committing Toaster status", ex).build()); } } - } ); + }); } /** @@ -284,17 +307,17 @@ public class OpendaylightToaster implements ToasterService, ToasterProviderRunti */ @Override public Future> restockToaster(final RestockToasterInput input) { - LOG.info( "restockToaster: " + input ); + LOG.info("restockToaster: " + input); - amountOfBreadInStock.set( input.getAmountOfBreadToStock() ); + amountOfBreadInStock.set(input.getAmountOfBreadToStock()); - if( amountOfBreadInStock.get() > 0 ) { + if (amountOfBreadInStock.get() > 0) { ToasterRestocked reStockedNotification = new ToasterRestockedBuilder() - .setAmountOfBread( input.getAmountOfBreadToStock() ).build(); - notificationProvider.publish( reStockedNotification ); + .setAmountOfBread(input.getAmountOfBreadToStock()).build(); + notificationProvider.offerNotification(reStockedNotification); } - return Futures.immediateFuture( RpcResultBuilder. success().build() ); + return Futures.immediateFuture(RpcResultBuilder.success().build()); } /** @@ -302,8 +325,8 @@ public class OpendaylightToaster implements ToasterService, ToasterProviderRunti */ @Override public void clearToastsMade() { - LOG.info( "clearToastsMade" ); - toastsMade.set( 0 ); + LOG.info("clearToastsMade"); + toastsMade.set(0); } /** @@ -314,36 +337,35 @@ public class OpendaylightToaster implements ToasterService, ToasterProviderRunti return toastsMade.get(); } - private void setToasterStatusUp( final Function resultCallback ) { - - WriteTransaction tx = dataProvider.newWriteOnlyTransaction(); - tx.put( LogicalDatastoreType.OPERATIONAL,TOASTER_IID, buildToaster( ToasterStatus.Up ) ); + private void setToasterStatusUp(final Function resultCallback) { + WriteTransaction tx = dataBroker.newWriteOnlyTransaction(); + tx.put(OPERATIONAL,TOASTER_IID, buildToaster(ToasterStatus.Up)); - Futures.addCallback( tx.submit(), new FutureCallback() { + Futures.addCallback(tx.submit(), new FutureCallback() { @Override - public void onSuccess( final Void result ) { - notifyCallback( true ); + public void onSuccess(final Void result) { + LOG.info("Successfully set ToasterStatus to Up"); + notifyCallback(true); } @Override - public void onFailure( final Throwable t ) { + public void onFailure(final Throwable failure) { // We shouldn't get an OptimisticLockFailedException (or any ex) as no // other component should be updating the operational state. - LOG.error( "Failed to update toaster status", t ); + LOG.error("Failed to update toaster status", failure); - notifyCallback( false ); + notifyCallback(false); } - void notifyCallback( final boolean result ) { - if( resultCallback != null ) { - resultCallback.apply( result ); + void notifyCallback(final boolean result) { + if (resultCallback != null) { + resultCallback.apply(result); } } - } ); + }); } - private boolean outOfBread() - { + private boolean outOfBread() { return amountOfBreadInStock.get() == 0; } @@ -352,51 +374,40 @@ public class OpendaylightToaster implements ToasterService, ToasterProviderRunti final MakeToastInput toastRequest; final SettableFuture> futureResult; - public MakeToastTask( final MakeToastInput toastRequest, - final SettableFuture> futureResult ) { + MakeToastTask(final MakeToastInput toastRequest, final SettableFuture> futureResult) { this.toastRequest = toastRequest; this.futureResult = futureResult; } @Override public Void call() { - try - { + try { // make toast just sleeps for n seconds per doneness level. - long darknessFactor = OpendaylightToaster.this.darknessFactor.get(); - Thread.sleep(darknessFactor * toastRequest.getToasterDoneness()); + Thread.sleep(OpendaylightToaster.this.darknessFactor.get() * toastRequest.getToasterDoneness()); - } - catch( InterruptedException e ) { - LOG.info( "Interrupted while making the toast" ); + } catch (InterruptedException e) { + LOG.info("Interrupted while making the toast"); } toastsMade.incrementAndGet(); amountOfBreadInStock.getAndDecrement(); - if( outOfBread() ) { - LOG.info( "Toaster is out of bread!" ); + if (outOfBread()) { + LOG.info("Toaster is out of bread!"); - notificationProvider.publish( new ToasterOutOfBreadBuilder().build() ); + notificationProvider.offerNotification(new ToasterOutOfBreadBuilder().build()); } // Set the Toaster status back to up - this essentially releases the toasting lock. // We can't clear the current toast task nor set the Future result until the // update has been committed so we pass a callback to be notified on completion. - setToasterStatusUp( new Function() { - @Override - public Void apply( final Boolean result ) { - - currentMakeToastTask.set( null ); - - LOG.debug("Toast done"); - - futureResult.set( RpcResultBuilder.success().build() ); - - return null; - } - } ); + setToasterStatusUp(result -> { + currentMakeToastTask.set(null); + LOG.debug("Toast done"); + futureResult.set(RpcResultBuilder.success().build()); + return null; + }); return null; }