Registrierte Attribute und registrierte Tests des Diagnoseproviders
Jeder Diagnoseprovider (DP) stellt eine Liste mit Attributen für den Speicherauszug des Status, mit Attributen für den Speicherauszug der Konfiguration, mit Selbsttests und mit Selbsttestattributen bereit. Die Tests sind Operationen, die der DP ausführen kann. Die Attribute sind Einzelinformationen, die aus einem Speicherauszug der Konfiguration, einem Speicherauszug des Status oder aus einem bestimmten Selbstdiagnosetest zusammengetragen werden können.
Jedes Attribut kann als mit einem Kennsatz versehene Einzelinformation betrachtet werden. Jedes Attribut ist außerdem entweder registiert oder nicht registriert. Ein registriertes Attribut ist ein Attribut, das releaseübergreifend in WebSphere Application Server verfügbar ist. Ein nicht registriertes Attribut ist in seiner aktuellen Form in künftigen Releases des Produkts möglicherweise nicht verfügbar (es gibt keine entsprechende Zusage).
Bei Ausführung eines Speicherauszugs der Konfiguration, eines Speicherauszugs des Status oder eines Selbstdiagnosetests kann ein Administrator oder ein automatisches Tool entweder nur registrierte Werte oder alle Werte anfordern. Beachten Sie, dass die Option zur Filterung der Ergebnisse nur über die JMX-MBean-Schnittstelle (Java™ Management Extension) des Diagnoseproviders verfügbar ist, das über das Programm oder über das Tool wsadmin aufgerufen werden kann.
Die XML-Datei DiagnosticProviderRegistration
<attribute>
<id><Regulärer Ausdruck für den Attributnamen></id>
<descriptionKey><MsgKey in einem ResourceBundle für die Lokalisierung des Kennsatzes></descriptionKey>
<registered>true</registered>
</attribute>
- ID:
- Der Name des Attributs. Dieser Name kann durch Platzhalterzeichen ausgedrückt werden,
die mit der Syntax für einen regulären Ausdruck übereinstimmen. Die registrierte Attribut-ID wird an
folgenden Stellen verwendet:
- Im Diagnoseprovider in den Methoden für Speicherauszug der Konfiguration und Speicherauszug des Status, um festzustellen, welche Attribute zurückgegeben werden sollen.
- In der Administrationskonsole, um den Attributen, die von einer Anforderung an den Diagnoseprovider nach einem Speicherauszug der Konfiguaration, einem Speicherauszug des Status oder einer Selbstdiagnoseoperation zurückgegeben wurden, Beschreibungsschlüssel zuzuordnen.
- descriptionKey:
- Dies ist ein Schlüssel in einem Ressourcenpaket (resourceBundle), der zur Lokalisierung verwendet wird.
- registered:
- Dies ist ein Boolescher Wert, der angibt, ob dieses Attribut releaseübergreifend in der Software verfügbar sein wird. Ist "registered" gleich true, dann ist dieses Attribut auch im nächsten Release verfügbar. Ist "registered" gleich false, kann nicht garantiert werden, dass dieses Attribut im nächsten Release existieren wird. Bei Verarbeitung nicht registrierter Attribute sollte die Automation mit Vorsicht angewendet werden.
<test>
<id><Regulärer Ausdruck für den Namen des Tests</id>
<descriptionKey><MsgKey in einem ResourceBundle für die Lokalisierung des Kennsatzes></descriptionKey>
<attribute><Ein oder mehrere Attribute, die von diesem Test ausgegeben werden></attribute>
</test>
- ID:
- Ähnlich der ID für das Attribut, in diesem Fall beschreibt sie jedoch den Test, der ausgeführt werden soll, anstatt das Attribut, das zurückgegeben werden soll.
- descriptionKey:
- Dies ist ein Schlüssel in einem Ressourcenpaket (resourceBundle), der zur Lokalisierung verwendet wird.
Methodenschnittstellen
public DiagnosticEvent [] configDump(String aAttributeId, boolean aRegisteredOnly);
public DiagnosticEvent [] stateDump(String aAttributeId, boolean aRegisteredOnly);
Diese Methoden rufen den Speicherauszug der Konfiguration oder des Status in der Komponente auf und geben einen regulärern Ausdruck als Filter für die Attribute an, die zurückgegeben werden sollen. Darüber hinaus wird die Ausgabe dahingehend gefiltert, dass entweder alle passenden Attribute oder nur die registrierten Attribute zurückgegeben werden. Auf diese Weise kann der Administrator oder kann die automatisierte Software, von dem oder der die Methode ausgeführt wird, eine Teilmenge aller Felder angeben. (Dies ist besonders wichtig, falls viele Attribute präsentiert werden oder falls die Menge der verfügbaren Daten durch die Spezifikation für Statuserfassung erhöht wird.) Folgende Helper-Methoden stehen zum Filtern der Ausgabe zur Verfügung.
public static AttributeInfo [] queryMatchingDPInfoAttributes(String aAttributeId,
AttributeInfo [] inAttrs, String [] namesToCheck, boolean aRegisteredOnly) {
Ein einzelnes
Attribut, das zurückgegeben werden könnte, filtern: public static AttributeInfo queryMatchingDPInfoAttributes(String aAttributeId,
AttributeInfo [] inAttrs, String nameToCheck, boolean aRegisteredOnly) {
Eine
Menge an aufgefüllten Attributinformationen so bearbeiten, dass nicht benötigte
Elemente entfernt werden: public static void filterEventPayload(String aAttributeId, HashMap payLoad) {
Einzelheiten zu diesen Nachrichten finden Sie in der API-Dokumentation für die Klasse DiagnosticProviderHelper. Das grundlegende Konzept sieht so aus, dass sobald die Komponente weiß, welche Attribute zurückgegeben werden könnten, die Helper-Methode auf der Basis der Logik des regulären Ausdrucks und des Booleschen Werts für die Registrierung feststellt, welche dieser Attribute tatsächlich zurückgegeben werden sollen.
public DiagnosticEvent[] selfDiagnostic(String aTestId, boolean aRegisteredOnly)
Der Unterschied besteht darin, dass der erste Parameter ein Filter in Form eines
regulären Ausdrucks ist, der festlegt, welcher Test ausgeführt werden soll.