1 /*
   2  * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
   3  * 
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * The contents of this file are subject to the terms of either the Universal Permissive License
   7  * v 1.0 as shown at http://oss.oracle.com/licenses/upl
   8  *
   9  * or the following license:
  10  *
  11  * Redistribution and use in source and binary forms, with or without modification, are permitted
  12  * provided that the following conditions are met:
  13  * 
  14  * 1. Redistributions of source code must retain the above copyright notice, this list of conditions
  15  * and the following disclaimer.
  16  * 
  17  * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
  18  * conditions and the following disclaimer in the documentation and/or other materials provided with
  19  * the distribution.
  20  * 
  21  * 3. Neither the name of the copyright holder nor the names of its contributors may be used to
  22  * endorse or promote products derived from this software without specific prior written permission.
  23  * 
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
  25  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  26  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  27  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  30  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
  31  * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33 package org.openjdk.jmc.rjmx.test.triggers;
  34 
  35 import org.w3c.dom.Element;
  36 
  37 import org.openjdk.jmc.rjmx.IConnectionHandle;
  38 import org.openjdk.jmc.rjmx.triggers.ITriggerAction;
  39 import org.openjdk.jmc.rjmx.triggers.TriggerEvent;
  40 
  41 /**
  42  * Simple action that just calls the NotificationActionCallbackReceiver with the event. This class
  43  * primarily exists to facilitate unit testing of the notification framework.
  44  */
  45 public class NotificationActionCallback implements ITriggerAction {
  46         /**
  47          * Action name.
  48          */
  49         public static final String NAME = "Callback action";
  50 
  51         /**
  52          * Description. Won't be used for this class.
  53          */
  54         public static final String DESCRIPTION = "Blablablablablablabla";
  55 
  56         private final NotificationActionCallbackReceiver m_receiver;
  57 
  58         /**
  59          * Notification event callback interface.
  60          */
  61         public interface NotificationActionCallbackReceiver {
  62                 /**
  63                  * The callback method.
  64                  *
  65                  * @param e
  66                  *            the event.
  67                  */
  68                 void onNotificationAction(TriggerEvent e);
  69         }
  70 
  71         /**
  72          * Constructor.
  73          *
  74          * @param receiver
  75          *            the callback implementation to be called when the action fires.
  76          */
  77         public NotificationActionCallback(NotificationActionCallbackReceiver receiver) {
  78                 m_receiver = receiver;
  79         }
  80 
  81         /**
  82          * @see ITriggerAction#handleNotificationEvent(TriggerEvent)
  83          */
  84         @Override
  85         public void handleNotificationEvent(TriggerEvent e) {
  86                 m_receiver.onNotificationAction(e);
  87         }
  88 
  89         /**
  90          * @see AbstractNotificationAction#getName()
  91          */
  92         @Override
  93         public String getName() {
  94                 return NAME;
  95         }
  96 
  97         /**
  98          * @see AbstractNotificationAction#getDescription()
  99          */
 100         @Override
 101         public String getDescription() {
 102                 return DESCRIPTION;
 103         }
 104 
 105         /**
 106          * @see java.lang.Object#toString()
 107          */
 108         @Override
 109         public String toString() {
 110                 return getName();
 111         }
 112 
 113         @Override
 114         public void initializeFromXml(Element node) throws Exception {
 115                 throw new UnsupportedOperationException();
 116         }
 117 
 118         @Override
 119         public void exportToXml(Element parentNode) {
 120                 throw new UnsupportedOperationException();
 121         }
 122 
 123         @Override
 124         public boolean supportsAction(IConnectionHandle connection) {
 125                 return true;
 126         }
 127 
 128         @Override
 129         public boolean isReady() {
 130                 return true;
 131         }
 132 }