org.apache.cassandra.utils.progress.jmx.JMXNotificationProgressListener Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cassandra-all Show documentation
Show all versions of cassandra-all Show documentation
The Apache Cassandra Project develops a highly scalable second-generation distributed database, bringing together Dynamo's fully distributed design and Bigtable's ColumnFamily-based data model.
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.cassandra.utils.progress.jmx;
import java.util.Map;
import javax.management.Notification;
import javax.management.NotificationListener;
import javax.management.remote.JMXConnectionNotification;
import org.apache.cassandra.utils.progress.ProgressEvent;
import org.apache.cassandra.utils.progress.ProgressEventType;
import org.apache.cassandra.utils.progress.ProgressListener;
/**
* JMXNotificationProgressListener uses JMX Notification API to convert JMX Notification message to progress event
* and notifies its {@link ProgressListener}s.
*
* This is to be implemented in client tools side.
*/
public abstract class JMXNotificationProgressListener implements ProgressListener, NotificationListener
{
/**
* @param tag tag name to be checked
* @return true if given tag for ProgressEvent is a target to consume. If this returns false, then
* {@link #progress} is not called for that event.
*/
public abstract boolean isInterestedIn(String tag);
/**
* Called when receiving {@link JMXConnectionNotification#NOTIFS_LOST} message.
*/
public void handleNotificationLost(long timestamp, String message) {}
/**
* Called when JMX connection is closed.
* Specifically when {@link JMXConnectionNotification#CLOSED} message is received.
*/
public void handleConnectionClosed(long timestamp, String message) {}
/**
* Called when JMX connection is failed.
* Specifically when {@link JMXConnectionNotification#FAILED} message is received.
*/
public void handleConnectionFailed(long timestamp, String message) {}
@SuppressWarnings("unchecked")
@Override
public void handleNotification(Notification notification, Object handback)
{
switch (notification.getType())
{
case "progress":
String tag = (String) notification.getSource();
if (this.isInterestedIn(tag))
{
Map progress = (Map) notification.getUserData();
String message = notification.getMessage();
ProgressEvent event = new ProgressEvent(ProgressEventType.values()[progress.get("type")],
progress.get("progressCount"),
progress.get("total"),
message);
this.progress(tag, event);
}
break;
case JMXConnectionNotification.NOTIFS_LOST:
handleNotificationLost(notification.getTimeStamp(), notification.getMessage());
break;
case JMXConnectionNotification.FAILED:
handleConnectionFailed(notification.getTimeStamp(), notification.getMessage());
break;
case JMXConnectionNotification.CLOSED:
handleConnectionClosed(notification.getTimeStamp(), notification.getMessage());
break;
}
}
}