javathreads.de

Blog rund um Java und Web Entwicklung

von Markus Kühle

RSS Feed abonnieren

RSS Feed

Eine EJB als JMX MBean für JBoss AS erstellen

Die Java Management Extensions (JMX) sind eine sehr gute Wahl um Aufgaben zentraler Natur zu steuern, eine Anwendung von außen zu beeinflussen oder zu überwachen. So könnten zum Beispiel das Logverhalten verändert oder administrative Anwendungsfunktionen ausgeführt werden ohne den Betrieb der Anwendung zu stören.

Um JMX zu nutzen werden sogenannte MBeans (Managed Beans) erstellt welche über einen Adapter, wie zum Beispiel einen HTTP Adapter, über den Web Browser zugänglich gemacht werden. Mit Java 5 kommt auch noch die Möglichkeit auf die JConsole zu verwenden um auf MBeans zuzugreifen. Mehr zu den Grundlagen der Java Management Extension auch in der online Ausgabe Java ist auch eine Insel – Kapitel 23.

Der JBoss AS (Application Server) steuert seine Konfigurationen über einen eigenen JMX Bus und bietet dazu eine Menge an MBeans an – siehe dazu auch aus dem JBoss AS Guide – Kapitel 2 – The JBoss JMX Microkernel. Weil die JMX Unterstützung eine Kernkomponente für den JBoss ist bietet er einfache Möglichkeiten an diese Infrastruktur für die eigenen Zwecke zu verwenden. Wie man diese am einfachsten verwenden und selbst eine JMX MBean schreiben kann soll im folgenden gezeigt werden.

Dieser Artikel ist in die folgenden Abschnitten unterteilt:

• Verschiedene Arten der JBoss MBean Services
• JBoss Service POJO
• JMX Konsole – Management Interface mit XML beschreiben

Möchte man eine JMX Bean für die eigene Anwendung, welche auf dem JBoss AS (Application Server) läuft, schreiben so bietet JBoss mehrere Möglichkeiten an. Folgende drei Möglichkeiten bestehen eine MBean für die JMX Konsole zu implementieren und zu registrieren:

• JBoss Standard MBean
• JBoss XMBean
• JBoss Servie POJO

Obwohl ich nur auf die dritte und letzte Möglichkeit eingehen möchte, werden vorab die beiden anderen Varianten kurz erwähnt, so dass man diese einordnen kann.

Für die erste Variante implementiert man einen JBoss MBean Service (auch Standard MBean genannt). Dazu erstellt man ein Interface welches sich von org.jboss.system.ServiceMBean sowie eine Klasse die dieses Interfaces implementiert. Diese MBean Service Klasse ist selbst von der Klasse org.jboss.system.ServiceMBeanSupport abgeleitet ist. Diese Klasse wird nun in der Datei jboss-service.xml als MBean konfiguriert und so dem JBoss AS bekannt gemacht.
Ein kleines “Hello World Service” Tutorial für das Erstellen eines solchen JBoss MBean Services findet sich im JBoss Wiki.

Die zweite Variante basiert auf der eben vorgestellten, nur dass die MBean über das JBoss XMBean Framework seine Metadaten beschreibt. An dieser Stelle kommt die Möglichkeit einfache POJOs als MBeans zu verwenden ins Spiel und es ist nicht mehr notwendig das oben beschriebene Interface ServiceMBean zu implementieren oder andere Regeln in der MBean Klasse einzuhalten. Allerdings wird für diese sogenannte XMBean Deployment Descriptor in Form eines XML Dokuments benötigt. Aus diesem Grund heißt diese MBean XMBean.
In diesem Deplyoment Descriptor können sämtliche Attribute, Methoden und deren Parameter beschrieben werden. Ein weiter Vorteil war die Möglichkeit Interceptor-Methoden zu implementieren. Diese konnte man zum Beispiel für Sicherheitsüberprüfungen bei Methodenaufrufe verwenden. Eine schöne ausführliche Beschreibung der XMBean findet sich auf dem Blog von organig thoughts.

Die hier eben kurz erwähnten Wege eine JBoss MBean bzw. XMBean (beides sind JMX MBean) zu erstellen können auch noch einmal in der offiziellen JBoss Server Configuration Guide im Kapitel 3.4.3 mit dem Titel “Writing JBoss MBean Services” nachgelesen werden.

Die dritte Variante ist die in diesem Artikel eigentlich fokussierte Variante mit dem Namen JBoss Service POJOs.

Die einfachste Variante eine JBoss MBean für die JMX Konsole zu erstellen ergibt sich durch die JBoss eigene @org.jboss.annotation.ejb.Service Annotation. Diese Annotation @Service definiert im JBoss einen Service der als Singleton, also nur mit einer Instanz (Singleton), verfügbar ist. So ergibt sich der erste Schritt daraus, einen solchen Service zu erstellen.

import org.jboss.annotation.ejb.Service;

@Service(objectName="MyApplication:service=MyService")
public class MyServiceMBean {

}

Noch einmal: die Besonderheit an dieser Service Bean besteht darin, dass auf dem Server nur eine Instanz davon besteht. Im Gegensatz zu EJB Services ist ein MBean Service nicht gepoolt, behält seinen Status (stateful) und hat application-scope. Letztlich ist dies aber eine normale Session Bean, von der lediglich nur eine Instanz besteht. Man arbeitet somit in dem Context der Anwendung und kann auf alle konfigurierten Resourcen, wie z.b. den EntityManager oder andere EJBs, zugreifen.

Um diese Service EJB nun noch JMX fähig zu machen und sie an einem MBean Server anmelden zu können, muss nun noch ein Management Interface erstellt und der Service Bean durch die @org.jboss.annotation.ejb.Management Annotation bekannt gemacht werden.

Hier das Management Interface, welche die Getter und Setter für das Attribut “lastWrittenText” sowie die Service-Methode printOut() deklariert, die später über die JMX Konsole aufgerufen werden können.

public interface MyManagementInterface {

  public String getLastWrittenText();
  public void setLastWrittenText(String lastWrittenText);

  void printOut(String text);
}

Die erstellte Service MBean “MyServiceMBean” muss dieses Interface nun noch implementieren und zudem das gleiche Interface durch die @Management Annotation bekannt machen. Erst durch diese @Management Annotation wird der JBoss aus den beschriebenen Attributen und Methoden eine Service MBean erstellen und registrieren. Im folgenden der vollständige Source Code für den POJO Service “MyServiceMBean“:

import org.jboss.annotation.ejb.Management;
import org.jboss.annotation.ejb.Service;

@Service(objectName="MyApplication:service=MyService")
@Management(MyManagementInterface.class)
public class MyServiceMBean implements MyManagementInterface {

  private String lastWrittenText;

  public void printOut(String text) {
    System.out.println("Given text: " + text);
    lastWrittenText = text;
  }

  public String getLastWrittenText() {
    return lastWrittenText;
  }

  public void setLastWrittenText(String lastWrittenText) {
    this.lastWrittenText = lastWrittenText;
  }
}

In dem Code ist zu sehen, das bei der @Service Annotation noch ein Objektname zu finden ist. Dieser dort definierte Name erscheint nach dem Starten des JBoss und dem erfolgreichem deployen der Anwendung in der JMX Konsole (Aufzurufen durch http://localhost:8080/jmx-console/). Im folgenden Screenshot findet man die definierten Namen wieder:

Selektiert man diesen Service gelangt man in die Service View, in der man alle Attribute und Methoden des Services sehen und aufrufen kann. In diesem Beispiel soll die Methode printOut(String) aufgerufen werden:

Nach der Eingabe des Methodenparameters “test string” und dem anschließenden Klicken des Buttons “invoke” erscheint auch, wie erwartet, der übergebene Text in der Server Konsole:

Leider hat man durch die Verwendung der Annotationen keine Möglichkeit die Service Bean, Attribute, Methoden oder Paramter zu beschreiben, wie es bei der ursprünglichen XMBean Variante noch als großer Vorteil angepriesen wurde.
Die gute Nachricht ist, dass auch hier eine Möglichkeit besteht diese Beschreibungen zu liefern. Der Nachteil an der Sache ist, man muss wieder auf eine XML Beschreibung zurückgreifen. Und zwar kommt wieder der XML Deployment Descriptor der XMBeans ins Spiel. Man kann genau diesen in der @Service Annotation angeben.

@Service(objectName="MyApplication:service=MyService",
		 xmbean="resource:META-INF/myService-xmbean.xml")
public class MyServiceMBean  implements MyManagementInterface {
  ...
}

Wichtig ist, dass die @Management Annotation entfernt werden muss weil nun wieder der XMBeans Deployment Descriptor die Beschreibung der MBean übernimmt. In diesem Beispiel heißt der Deployment Descriptor myService-xmbean.xml und liegt im META-INF Ordner, direkt neben der persistence.xml Datei. Wenn die Datei nicht gefunden wird schmeißt der JBoss AS während des Startens Exceptions, so dass der Fehler schnell bemerkt wird.

Der XMBeans Deployment Descriptor myService-xmbean.xml sieht für die oben gelistete POJO Service Klasse wie folgt aus:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mbean PUBLIC "-//JBoss//DTD JBOSS XMBEAN 1.0//EN"
  "http://www.jboss.org/j2ee/dtd/jboss_xmbean_1_0.dtd">


  javathreads.de - MyService MBean Beschreibung

  de.webthreads.tippit.mgmt.MyServiceMBean

  
  
    Der zuletzt ausgegebene Text wird hier gehalten.
    LastWrittenText
    java.lang.String
  

  
  
    Methode um einen Text auf der Konsole auszugeben.
    printOut

      Der Text der ausgegeben werden soll.
      text
      java.lang.String
    
    void
  

In der XML Datei sind die Beschreibungen für das Attribut sowie der Methode zu sehen. Die DTD des mbean Elements sieht wie folgt aus:

Schaut man sich jetzt die JMX Konsole an sind die Beschreibungen nun auch vorhanden, wie man im folgenden Screenshot sehen kann:

Ich habe in diesem Screenshot mal die Abhängkigkeit zur XMBean hervorgehoben. Vergleicht man diese Zeile mit dem Screenshot der JMX MBean View der MBean, die mit der @Management erstellt wurde, so sieht man dort die Zeile: MBean Java Class: de.javathreads.jbosstest.mgmt.MyManagementInterface

Auch so kann man also erkennen welcher Weg gegangen wurde um eine MBean für die JMX Konsole zu erstellen.

Insgesamt war das Erstellen einer solchen Service MBean im JBoss so einfach, dass ich es hier kurz dokumentieren musste =). Der Weg dahin hat doch etwas länger gedauert aber dadurch bin ich über einige interessante Seiten gestolpert, wie zum Beispiel das JBoss Wiki – JMX FAQ oder das wirklich gute Tutorial von JBoss Trailblazer. Nach dem lesen und googeln habe ich es ausprobiert und es hat tatsächlich (fast) auf Anhieb funktioniert.
Und jetzt während ich diesen Artikel fast zu Ende geschrieben habe entdecke ich noch eine Blitzanleitung auf dem Blog von Christian Ullenboom (Author von Java ist auch eine Insel) mit einer Schnelleinführung..

Und gerade weil das Erstellen eines solchen JMX MBean Service eigentlich so einfach ist sollten diese Erkenntnisse hier festgehalten werden.

Lesezeichen erstellen

 Artikel per E-Mail empfehlen

Wenn du Fragen oder Anregungen zum Post hast, dann hinterlasse doch einen Kommentar oder wenn du weiterhin Artikel von Javathreads lesen möchtest, dann abonniere den RSS Feed und sehe direkt in deinem Feed Reader die nächsten Artikel.

@Local
public interface MyServiceMBeanLocal {
  void doSomething();
}

@Service
public class MyServiceMBean implements MyServiceMBeanLocal {
  public void soSomething(){
    // implement me
  }
}

@Stateless
public class OtherSessionBean implements OtherSessionBeanLocal {
  @EJB
  private MyServiceMBeanLocal myServiceMBean;
}

Powered by Wordpress | WP Premium theme by WP Remix
Copyright 2007. javathreads.de. All rights reserved

• 
• Home
• Über