Add live TLS certificate probing and improve restart error handling.

Configure CertificateCheckUrl per container for curl-like TLS checks, classify Sonic permission errors, and extend setup wizard for container management.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
2026-08-03 13:16:21 +02:00
co-authored by Cursor
parent d20e0df618
commit 58b7826162
1430 changed files with 358394 additions and 71 deletions
@@ -427,6 +427,7 @@ BEGIN
[SonicConnectionId] [int] NOT NULL,
[ContainerName] [nvarchar](250) NOT NULL,
[ContainerDisplayName] [nvarchar](250) NULL,
[CertificateCheckUrl] [nvarchar](500) NULL,
[RestartTimeoutSeconds] [int] NOT NULL,
[IsActive] [bit] NOT NULL,
[CreationDateTime] [datetime2](3) NOT NULL,
@@ -0,0 +1,18 @@
/*
DATABASE: [EsbZertifikatManager]
OBJECTNAME: SonicContainer.CertificateCheckUrl
ACTION: ALTER
IDX: 005
DATE: 2026-07-31
USER: CUR
COMMENT: URL/Host:Port fuer TLS-Zertifikatspruefung (curl-aehnlich) am Container.
*/
USE [EsbZertifikatManager];
GO
IF COL_LENGTH(N'dbo.SonicContainer', N'CertificateCheckUrl') IS NULL
BEGIN
ALTER TABLE [dbo].[SonicContainer]
ADD [CertificateCheckUrl] [nvarchar](500) NULL;
END;
GO
@@ -46,6 +46,16 @@ Wenn der alte Platzhalter noch in SQL liegt:
Zusätzlich: in `appsettings.json` ist `"Demo": { "Enabled": true, ... }` –
die App zeigt den Demo-Pfad auch ohne SQL-Update in der Zielliste (Kopieren testen).
## TLS-Prüf-URL am Container (bestehende DB)
Für Live-Zertifikatsprüfung (curl-ähnlich) die Spalte nachziehen:
```text
05_AddCertificateCheckUrl.sql
```
Danach in Einstellungen → Container die Prüf-URL setzen, z. B. `https://server:8443`.
## Always Encrypted
| Objekt | Name |
@@ -0,0 +1,437 @@
# Dateiübersicht nach Ordnerstruktur
Was **jede einzelne Datei** macht – inkl. Sonic Management API.
Projektroot der App: `ZA.CoreService.ESBCertificateManager/`
---
## 0. Gesamtbild (wer ruft wen)
```text
Program.cs
└─ Form1.cs (UI)
├─ Zertifikat lesen → CertificateInfo
├─ Ziele ← SonicContainerDiscovery (KnownContainers / Live)
└─ Neustart
└─ DeploymentOrchestrator
└─ RestartExecutor
└─ SonicManagementClient
└─ SonicMfApiExecutor
└─ java + Tools/SonicMfContainerTool
└─ Sonic JARs (externe API)
└─ Domain Manager tcp://…:13070
```
Konfiguration: `appsettings.json` → `AppSettingsLoader` → `AppSettings` / `SonicConnection`.
---
## 1. Projektroot (`ZA.CoreService.ESBCertificateManager/`)
### `Program.cs`
Einstiegspunkt der WinForms-App.
`ApplicationConfiguration.Initialize()` + `Application.Run(new Form1())`.
Keine Business-Logik.
### `Form1.cs`
**Gesamte Benutzeroberfläche** (Dark-Design, Sidebar, Zertifikatskarte, Grid, Buttons).
Wichtige Aufgaben:
| Bereich | Was passiert |
|---------|----------------|
| Zertifikat | Dateidialog → `X509Certificate2` → Subject/Issuer/Fingerprint/Gültigkeit anzeigen |
| Ziele | Grid aus `KnownContainers`; Button „Container laden“ → Live-Discovery |
| Prüfung | `ValidateRestartOnly` (ContainerName + SonicConnectionName) |
| Neustart | Bestätigung → `DeploymentOrchestrator.RestartOnlyAsync` → Ergebnisdialog |
| Status | Statuszeile, Fortschritt im Grid, SonicHome/Java-Anzeige |
Deploy-Button ist vorhanden im Layout, aber **ausgeblendet/deaktiviert**.
### `Form1.Designer.cs`
WinForms-Designer-Stub. `InitializeComponent()` ist praktisch leer – das Layout wird in `Form1.cs` per Code gebaut.
### `Form1.resx`
Ressourcen-Datei zum Formular (Standard WinForms). Kaum eigene Inhalte.
### `appsettings.json`
**Laufzeitkonfiguration** – die „Online“-Quelle für Sonic:
- `LogDirectory` – wohin Logs geschrieben werden
- `SonicConnections[]` – Domain, URL, User/Pass, Java, Lib-Pfad, **KnownContainers**
Beispiel-Verbindung `DE-Test` → Domain `proalpha-test`, Container `ct-ZADBService`.
### `ZA.CoreService.ESBCertificateManager.csproj`
Projektdatei: .NET 8 WinForms, NuGet (Configuration), welche Dateien nach `bin` kopiert werden (`appsettings`, `Tools`, `Assets`, `Docs`).
### `ZA.CoreService.ESBCertificateManager.csproj.user`
Lokale Visual-Studio-Benutzereinstellungen (Debugger usw.). Nicht fachlich relevant.
---
## 2. Ordner `Configuration/`
### `AppSettingsLoader.cs`
Liest `appsettings.json` über `Microsoft.Extensions.Configuration` und bindet sie an `AppSettings`.
Sucht zuerst im Output-Verzeichnis (`AppContext.BaseDirectory`), sonst im Arbeitsverzeichnis.
---
## 3. Ordner `Models/` (Datenstrukturen)
### `AppSettings.cs`
Root-Settings-Objekt:
- `LogDirectory`
- `List<SonicConnection> SonicConnections`
### `SonicConnection.cs`
Eine Sonic-/SMC-Verbindung:
| Property | Bedeutung |
|----------|-----------|
| `Name` | Alias, z. B. `DE-Test` |
| `DomainName` | z. B. `proalpha-test` |
| `ConnectionUrl` | `tcp://host:port` wie SMC |
| `Username` / `Password` | SMC-Login |
| `SonicHome` / `JavaHome` / `JavaPath` | Pfade |
| `MfClientLibPath` | Ordner mit Client-JARs |
| `KnownContainers` | Containerliste für die UI |
| `TimeoutSeconds` / `PostRestartDelaySeconds` | Timeouts |
| `ManagementModeDisplay` | Anzeigetext „MfApi …“ |
Enthält noch ältere Hilfsfelder/Enums (WinRM etc.) aus der Historie – der aktive Client nutzt nur den MfApi-Pfad.
### `DeploymentTarget.cs`
Ein **Ziel** im Grid (ein Container zum Neustarten):
- `Id`, `Name`, `Environment`, `IsActive`
- `ContainerName` – z. B. `ct-ZADBService`
- `SonicConnectionName` – Verweis auf `SonicConnection.Name`
- `RestartType` – für Neustart typischerweise `SonicContainer`
- Weitere Felder (TargetDirectory, Tls*, Xapi*) können noch im Model stehen, werden für den aktuellen Neustart-Pfad nicht mehr aktiv genutzt
### `CertificateInfo.cs`
Ergebnis der lokalen Zertifikatsprüfung:
- Subject, Issuer
- FingerprintSha256
- ValidFrom / ValidUntil
- IsCurrentlyValid
### `DeploymentRunResult.cs`
Ergebnisstrukturen nach einem Lauf:
- `DeploymentRunResult` – Gesamtlauf (Liste Zielergebnisse, Zeiten, OverallSuccess)
- `TargetStepResult` – ein Ziel (Success, StatusText, Detail, …)
- `ValidationIssue` / `PreflightValidationResult` – Vorabprüfung
- `TargetProgressUpdate` – Fortschritt für die UI
---
## 4. Ordner `Services/` (Geschäftslogik)
### `DeploymentOrchestrator.cs`
Orchestriert **nur Neustart** (kein Deploy/TLS):
1. `ValidateRestartOnly` → Preflight
2. `RestartOnlyAsync` → für jedes Ziel `RestartExecutor`
3. Schreibt Log über `RunLogger`
4. Meldet Progress an die UI
### `RestartExecutor.cs`
Mappt ein `DeploymentTarget` auf die passende `SonicConnection` und ruft
`SonicManagementClient.RestartContainerAsync(containerName)` auf.
### `PreflightValidator.cs`
Prüft vor dem Neustart:
- mindestens ein Ziel ausgewählt
- `ContainerName` gesetzt
- `SonicConnectionName` gesetzt
### `SonicManagementClient.cs`
**Dünne Fassade** zur MfApi (kein WinRM/HTTP/XApi mehr):
| Methode | Zweck |
|---------|--------|
| `CheckConnectionAsync` | Ping / Soft-Fallback KnownContainers+TCP |
| `GetContainersAsync` | Liste von Containern (API oder KnownContainers) |
| `RestartContainerAsync` | Neustart + Wartezeit `PostRestartDelaySeconds` |
### `SonicMfApiExecutor.cs`
**Brücke C# → Java.** Das ist der technische Kern „unsere Seite der API“:
1. Java 8+ finden (`JavaPath` / Suche)
2. Classpath aus allen JARs unter `MfClientLibPath` / `SonicHome\lib` bauen
3. `Tools\SonicMfContainerTool.class` laden (Version prüfen)
4. Prozess starten: `java -cp … SonicMfContainerTool ping|list|restart …`
5. Passwort über Env `ESB_SONIC_PASSWORD`
6. Erfolg bei Neustart nur wenn Output `OK:RestartInvoked` enthält
Öffentliche Methoden:
- `TestConnectionAsync` → Tool-Befehl `ping`
- `ListContainersAsync` → `list`
- `RestartAsync` → `restart`
- `ResolveRuntimePaths` → für Statuszeile in der UI
### `SonicContainerDiscovery.cs`
Baut die Zielliste:
- `BuildTargetsFromConfig()` – aus `KnownContainers` in appsettings (Start der App)
- `DiscoverAsync()` – live per `SonicManagementClient` listen + mit KnownContainers mergen
### `RunLogger.cs`
Schreibt Textdateien unter `LogDirectory` (ein Log pro Lauf). Redaktiert ggf. secrets-ähnliche Strings.
### `PathResolver.cs`
Löst relative Pfade gegen `AppContext.BaseDirectory` auf (z. B. für Logs).
---
## 5. Ordner `Tools/` (Java + Sonic-API)
Hier liegt der **eigentliche Aufruf der Sonic Management Application API**.
### `SonicMfContainerTool.java`
Kleines Java-Hilfsprogramm (Reflection, kompilierbar ohne Sonic-JARs auf dem Compile-Classpath).
**Befehle:**
| Befehl | Bedeutung |
|--------|-----------|
| `ping` | Connect + Agenten zählen |
| `list` | Containernamen der Domain ausgeben |
| `restart` | Lifecycle auf einem Container |
**Connect (API-Login):**
```text
Hashtable: ConnectionURLs, DefaultUser, DefaultPassword
→ new JMSConnectorAddress(env)
→ new JMSConnectorClient().connect(address, timeout)
```
Klassen aus Sonic-JARs:
- `com.sonicsw.mf.jmx.client.JMSConnectorAddress`
- `com.sonicsw.mf.jmx.client.JMSConnectorClient`
**Neustart – Ziel:**
```text
ObjectName = {Domain}.{Container}:ID=AGENT
Beispiel: proalpha-test.ct-ZADBService:ID=AGENT
```
**Neustart – Wege (nacheinander):**
1. **MBean.invoke** `"stop"` / `"restart"` / `"shutdown"` ← bevorzugt remote
2. **IAgentProxy** über `MFProxyFactory.createAgentProxy` (oft *unbounded*-Fehler)
3. **DomainManager**-Operationen wie `restartContainer` / `stopContainer`
Erfolg:
```text
OK:RestartInvoked method=…
INFO:ToolVersion=…
```
### `SonicMfContainerTool.class` / `SonicMfContainerTool$Args.class`
Vorkompilierter Java-8-Bytecode (major 52), den die App zur Laufzeit nutzt (ohne `javac` auf dem Zielrechner).
### `SonicMfContainerTool.jar`
Optional verpackte Variante des Tools (Classpath-Alternative).
### `verify-mfapi-classpath.bat`
Hilfsskript: prüft manuell, ob `JMSConnectorAddress` mit den JARs unter `C:\DEV\MQ10.0\lib` ladbar ist.
---
## 6. Ordner `Docs/` (Dokumentation)
### `Komplette-Erklaerung.md`
Schritt-für-Schritt: Zertifikat, Preflight, C#-Kette, Java-API, Fehlerbilder, Präsentationsskript.
### `Neustart-und-Management-API.md`
Kompaktere API-/Neustart-Erklärung inkl. „Was ist unnötig in der großen Sonic-API?“.
### `Dateiuebersicht-nach-Ordner.md`
Diese Datei – Katalog aller Projektdateien.
---
## 7. Ordner `Assets/`
### `logo.png`
UI-/Branding-Grafik.
### `TestCertificates/esb-test-cert.cer`
Beispiel-Zertifikat zum lokalen Test der Dateierkennung (kein Sonic-Deploy).
---
## 8. Ordner `Demo/`
### `Demo/Central/esb-cert.cer`
Weiteres Beispielzertifikat. Nicht Teil der Online-Neustart-Logik.
---
## 9. Sibling-Ordner `doc-10.0.10/` (neben der App, im Repo)
Produkt-Dokumentation Aurea CX Messenger / Sonic (nicht App-Code).
### `CXMessenger_2017_R3.htm`
Index der offiziellen Doku. Wichtiger Link:
- **Management Application API Reference** → `Docs2017/api/mgmt_api/`
Das ist die API-Familie, die SMC und unser Java-Tool nutzen.
### `Docs2017/api/analytics-offloader/…`
Javadoc-Stub für Analytics Offload – **nicht** der Neustart-Pfad.
### PDFs / vollständige `mgmt_api`
Im Index verlinkt; können im Checkout fehlen. Für Reviews idealerweise nachziehen.
---
## 10. Die Sonic Management Application API – detailliert
### 10.1 Was „API“ hier bedeutet
Es ist **keine REST-URL der WinForms-App**.
Es ist die **Java Management Application API** von Sonic/Aurea:
- Transport: JMS zum Domain Manager (`tcp://host:port`)
- Steuerung: JMX-ähnliche ObjectNames + Operationen
- Authentifizierung: SMC-User/Pass
Dieselbe Schicht wie der Restart in der Sonic Management Console.
### 10.2 Welche Sonic-Klassen wir wirklich brauchen
| Klasse | Aufgabe |
|--------|---------|
| `JMSConnectorAddress` | Verbindungsparameter kapseln |
| `JMSConnectorClient` | Verbinden / disconnect / invoke / queryNames |
| `MFProxyFactory` | `createAgentProxy` |
| `IAgentProxy` | typisierte Methoden stop/restart/… (remote oft eingeschränkt) |
| ObjectName `domain.container:ID=AGENT` | Ziel-Agent |
Benötigte JARs typischerweise unter `C:\DEV\MQ10.0\lib`:
- `mgmt_client.jar`
- `mfcontext.jar`
- `sonic_Client.jar`
(+ weitere Abhängigkeiten im selben Ordner)
### 10.3 Warum die Sonic-API „viele unnötige Funktionen“ hat
Die Produkt-API deckt ab:
- Messaging (Queues, Topics, Durable Subs)
- Broker-Admin
- ESB
- Metrics / Notifications
- Config / Directory
**Für unseren Use-Case reichen 3 Schritte:** Connect → Agent finden → Stop/Restart.
Der Rest der JARs/Javadoc ist Produktumfang, nicht App-Feature.
### 10.4 „Unbounded client connector“
Remote-Clients (SMC, unser Tool) sind oft **unbounded**.
Dann schlägt `IAgentProxy.restart()` fehl mit:
```text
Operation unsupported for unbounded client connector
```
Deshalb bevorzugt das Tool **MBean.invoke("stop")**.
Operativ entspricht das oft SMC-Restart: Stop + Auto-Relaunch durch Launch Daemon.
### 10.5 Sequenz eines Neustarts (API-Ebene)
```text
1. C#: RestartExecutor → SonicManagementClient → SonicMfApiExecutor
2. C#: startet java -cp Tools;lib\*.jar SonicMfContainerTool restart …
3. Java: JMSConnectorClient.connect(url, user, pass)
4. Java: ObjectName = proalpha-test.ct-ZADBService:ID=AGENT
5. Java: connector.invoke(on, "stop", …) // oder Fallback
6. Java: OK:RestartInvoked
7. C#: PostRestartDelaySeconds warten
8. UI: Erfolg/Fehler + Log
```
---
## 11. Zertifikatsprüfung – welche Dateien
| Datei | Rolle |
|-------|--------|
| `Form1.cs` | Dateiauswahl, PFX-Passwort, Anzeige |
| `Models/CertificateInfo.cs` | Ergebnisobjekt |
| `Assets/...` / `Demo/...` | optionale Testdateien |
Ablauf:
1. Datei wählen (`.cer/.crt/.pem/.pfx`)
2. Als `X509Certificate2` laden
3. Subject/Issuer/Fingerprint/Gültigkeit berechnen
4. Anzeigen – **lokal verifiziert**
Nicht enthalten: Kopieren auf ESB, TLS-Probe gegen Live-Host, CA-Kettenprüfung.
---
## 12. Was absichtlich fehlt (gelöscht / deaktiviert)
| Früher | Status |
|--------|--------|
| `Data/targets.sample.json` + JSON-Repository | entfernt – Ziele aus KnownContainers |
| SQL-Repos / Schema | entfernt |
| WinRM / LocalCmd / stopcontainer.bat-Executor | entfernt |
| CertificateDeployer / TlsCertificateProbe | entfernt |
| XApi-Import | entfernt |
| Deploy-Button | UI ausgeblendet |
---
## 13. Schnell-Tabelle „Datei → Ein Satz“
| Datei | Ein Satz |
|-------|----------|
| `Program.cs` | Startet die App |
| `Form1.cs` | UI + Zertifikat + Neustart-Klick |
| `Form1.Designer.cs` | Leerer Designer-Stub |
| `Form1.resx` | Formular-Ressourcen |
| `appsettings.json` | Sonic-Verbindung + KnownContainers + Java/Libs |
| `*.csproj` | Build/Copy-Regeln |
| `Configuration/AppSettingsLoader.cs` | JSON → Settings-Objekt |
| `Models/AppSettings.cs` | Settings-Root |
| `Models/SonicConnection.cs` | Eine SMC-/Domain-Verbindung |
| `Models/DeploymentTarget.cs` | Ein Container-Ziel im Grid |
| `Models/CertificateInfo.cs` | Lokales Zertifikats-Ergebnis |
| `Models/DeploymentRunResult.cs` | Lauf-/Validierungs-DTOs |
| `Services/DeploymentOrchestrator.cs` | Neustart über alle Ziele |
| `Services/RestartExecutor.cs` | Ziel → SonicClient |
| `Services/PreflightValidator.cs` | Pflichtfelder prüfen |
| `Services/SonicManagementClient.cs` | Fassade ping/list/restart |
| `Services/SonicMfApiExecutor.cs` | Java-Prozess + Classpath |
| `Services/SonicContainerDiscovery.cs` | KnownContainers + Live-Liste |
| `Services/RunLogger.cs` | Datei-Logs |
| `Services/PathResolver.cs` | Relative Pfade |
| `Tools/SonicMfContainerTool.java` | Sonic Management API Aufrufe |
| `Tools/*.class` / `.jar` | Vorkompiliertes Tool |
| `Tools/verify-mfapi-classpath.bat` | Classpath-Selbsttest |
| `Docs/*.md` | Erklärungen |
| `Assets/*` | Logo / Testzertifikat |
| `Demo/*` | Demo-Zertifikat |
| `doc-10.0.10/*` | Offizielle Sonic/CX-Messenger-Doku |
---
*Ende der Dateiübersicht. Für Ablauf-Details siehe `Komplette-Erklaerung.md`.*
@@ -0,0 +1,507 @@
# MfApi-Restart – vollständige Erklärung
Stand: Tool-Version `2026-07-24d-restart-only`
Zweck dieses Dokuments: erklären, **wie die Sonic Management Application API (MfApi) in dieser App genutzt wird**, Schicht für Schicht – von Button-Klick bis MBean-Aufruf.
---
## 1. Was ist „die API“ hier?
Es gibt **keine eigene REST-API** der WinForms-App.
Gemeint ist die **Sonic / Aurea MF Management Application API** (wie in der Sonic Management Console, SMC):
| Begriff | Bedeutung |
|---------|-----------|
| **MfApi** | Management Framework API über JMS/JMX-Client |
| **Domain Manager** | zentrale Verwaltung der Sonic-Domain |
| **Container / Agent** | laufende ESB-Instanz, z. B. `ct-ZADBService` |
| **SMC** | Sonic Management Console (UI mit denselben Credentials/URL) |
| **MBean** | verwaltbares Objekt im Domain Manager (`ObjectName`) |
Die App startet lokal einen **Java-Prozess**, der die offiziellen Sonic-Client-JARs lädt und denselben Neustart-Intent ausführt wie **Restart** in der SMC.
### Warum Java und nicht reines .NET?
Die Sonic-Client-Bibliotheken (`mgmt_client.jar`, `mfcontext.jar`, `sonic_Client.jar`, …) sind **Java**.
C# orchestriert nur: Konfiguration lesen → `java.exe` starten → stdout auswerten.
---
## 2. Was die App bewusst *nicht* mehr macht
Nach dem Slimming ist die API-Schicht **nur Restart**:
| Entfernt | Früher |
|----------|--------|
| `ping` | Verbindungstest über Agent-Query |
| `list` | Live-Containerliste aus dem Domain Manager |
| IAgentProxy-Fallback | oft „Operation unsupported for unbounded client connector“ |
| DomainManager-Scan | `restartContainer` / Manager-MBeans |
| WinRM / `stopcontainer.bat` | lokaler Script-Pfad |
| HTTP-REST-Pfade | ungenutzt |
Container kommen ausschließlich aus **`appsettings.json` → `KnownContainers`**.
---
## 3. Architektur-Überblick
```text
┌─────────────────────────────────────────────────────────────────┐
│ WinForms UI (Form1) │
│ Button „ESB neu starten“ │
└────────────────────────────┬────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────┐
│ DeploymentOrchestrator │
│ Preflight → Schleife über Ziele → Logging / Progress │
└────────────────────────────┬────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────┐
│ RestartExecutor │
│ Ziel → SonicConnection (Name-Match) │
└────────────────────────────┬────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────┐
│ SonicManagementClient │
│ Restart + PostRestartDelay │
└────────────────────────────┬────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────┐
│ SonicMfApiExecutor (.NET) │
│ Java finden, Classpath bauen, Process starten, Output prüfen │
└────────────────────────────┬────────────────────────────────────┘
│ Process: java -cp … SonicMfContainerTool restart …
▼
┌─────────────────────────────────────────────────────────────────┐
│ SonicMfContainerTool (Java) │
│ connect → MBean.invoke(stop|restart) → OK:RestartInvoked │
└────────────────────────────┬────────────────────────────────────┘
│ tcp://…:13070 (JMS Management)
▼
┌─────────────────────────────────────────────────────────────────┐
│ Sonic Domain Manager / Broker │
│ ObjectName: proalpha-test.ct-ZADBService:ID=AGENT │
│ Launch Daemon startet Container nach stop ggf. neu │
└─────────────────────────────────────────────────────────────────┘
```
---
## 4. Konfiguration (`appsettings.json`)
Beispiel (aktuell):
```json
{
"LogDirectory": "Logs",
"SonicConnections": [
{
"Name": "DE-Test",
"DomainName": "proalpha-test",
"ConnectionUrl": "tcp://dekun-painwbdet:13070",
"Username": "Administrator",
"Password": "Administrator",
"SonicHome": "C:\\DEV\\MQ10.0",
"JavaHome": "C:\\Program Files (x86)\\Java\\jre1.8.0_501",
"JavaPath": "C:\\Program Files (x86)\\Java\\jre1.8.0_501\\bin\\java.exe",
"MfClientLibPath": "C:\\DEV\\MQ10.0\\lib",
"KnownContainers": [ "ct-ZADBService" ],
"TimeoutSeconds": 120,
"PostRestartDelaySeconds": 20
}
]
}
```
### Felder erklärt
| Feld | Rolle |
|------|--------|
| **Name** | Alias der Verbindung. `DeploymentTarget.SonicConnectionName` muss dazu passen (hier `DE-Test`). |
| **DomainName** | Sonic-Domain (`proalpha-test`). Teil des JMX-`ObjectName`. |
| **ConnectionUrl** | Dieselbe TCP-URL wie in der SMC (`tcp://host:port`). |
| **Username / Password** | SMC-Login (nicht Windows/WinRM). Passwort geht als Env `ESB_SONIC_PASSWORD` an Java. |
| **SonicHome** | Installationsroot; Fallback für `lib\*.jar`, wenn `MfClientLibPath` leer/unbrauchbar. |
| **JavaPath** | Bevorzugter Pfad zu `java.exe` (**Java 8+**, Class major ≥ 52). |
| **JavaHome** | Alternativ `JavaHome\bin\java.exe`. |
| **MfClientLibPath** | Ordner mit Client-JARs (`mgmt_client.jar`, `mfcontext.jar`, …). |
| **KnownContainers** | Liste der Container-**Kurznamen** für die Grid-Ziele. |
| **TimeoutSeconds** | Timeout für Java-Prozess und Tool-Connect (5–600 s, Clamp in Code). |
| **PostRestartDelaySeconds** | Wartezeit **nach** erfolgreichem `OK:RestartInvoked` (0–120 s), bevor UI „fertig“ meldet. |
### Wichtige Namensunterscheidung
| Name | Beispiel | Ist |
|------|----------|-----|
| Verbindungs-Alias | `DE-Test` | Eintrag in `SonicConnections[].Name` |
| Domain | `proalpha-test` | Sonic-Domain |
| Container | `ct-ZADBService` | Agent / Container in SMC |
Häufiger Fehler: Alias `DE-Test` als Containername verwenden. Der ObjectName wäre dann falsch.
Korrekt:
```text
proalpha-test.ct-ZADBService:ID=AGENT
```
---
## 5. Ziele (DeploymentTarget)
Beim Start baut `SonicContainerDiscovery.BuildTargetsFromConfig()` aus jeder Connection und jedem `KnownContainers`-Eintrag ein Ziel:
| Property | Quelle / Wert |
|----------|----------------|
| `Name` | `"DE-Test / ct-ZADBService"` |
| `Environment` | `DomainName` |
| `ContainerName` | `ct-ZADBService` |
| `SonicConnectionName` | `DE-Test` |
| `RestartType` | `SonicContainer` |
Es gibt **keinen Live-Query** mehr („Container laden“ wurde entfernt).
---
## 6. Aufrufkette – jede Methode
### 6.1 UI – `Form1`
| Schritt | Methode / Ereignis | Aufgabe |
|---------|-------------------|---------|
| 1 | `btnRestartOnly.Click` | Startet `RunRestartOnlyAsync()` |
| 2 | `GetSelectedTargets()` | Angehakte Grid-Zeilen |
| 3 | `_orchestrator.ValidateRestartOnly(...)` | Vorabprüfung |
| 4 | MessageBox-Bestätigung | Nutzer bestätigt Neustart |
| 5 | `_orchestrator.RestartOnlyAsync(...)` | eigentlicher Lauf |
| 6 | Grid / Statuszeile | Ergebnis anzeigen (kein Erfolgs-Popup) |
### 6.2 `PreflightValidator.ValidateRestartOnly`
Prüft grob:
- mindestens ein Ziel gewählt
- `ContainerName` gesetzt
- `SonicConnectionName` gesetzt
Fehler → Abbruch **vor** Java.
### 6.3 `DeploymentOrchestrator`
| Methode | Aufgabe |
|---------|---------|
| `ValidateRestartOnly` | reicht an Preflight durch |
| `RestartOnlyAsync` | Log öffnen, alle gewählten Ziele nacheinander |
| `RestartTargetOnlyAsync` | Progress „Neustart…“ → Executor → `TargetStepResult` |
Kein Deploy, kein TLS, kein SQL.
### 6.4 `RestartExecutor.ExecuteAsync`
1. `ContainerName` prüfen
2. `SonicConnection` per `Name == target.SonicConnectionName` finden
3. `new SonicManagementClient(connection)`
4. `RestartContainerAsync(target.ContainerName)`
### 6.5 `SonicManagementClient.RestartContainerAsync`
1. `_mfApi.RestartAsync(containerName)`
2. Bei Erfolg: `Task.Delay(PostRestartDelaySeconds)`
3. Status/Detail-String für UI/Log zurückgeben
Die Verzögerung gibt dem Launch Daemon Zeit, den Container wieder hochzufahren. Sie ist **kein** aktiver SMC-Status-Poll.
### 6.6 `SonicMfApiExecutor` – die C#-Brücke
#### `PrepareTool()`
1. **Java** über `ResolveJavaExe()`:
- `JavaPath`
- `JavaHome\bin\java.exe`
- `JAVA_HOME` / `JRE_HOME`
- `java.exe` aus PATH
2. **Classpath** über `ResolveSonicClasspath()`:
- alle `*.jar` aus `MfClientLibPath`, sonst `SonicHome\lib` / `SonicHome`
- bevorzugte Reihenfolge: `mgmt_client.jar`, `mfcontext.jar`, `sonic_Client.jar`, `sonic_Crypto.jar`, `mf_common.jar`, dann Rest
3. **Tool-Verzeichnis** mit `SonicMfContainerTool.class` (`Tools\` neben der EXE)
Ergebnis-Classpath grob:
```text
<App>\Tools;<MfClientLibPath>\mgmt_client.jar;...;<weitere jars>
```
#### `RestartAsync(containerName)`
Startet:
```text
java -cp "<Tools>;<jars>" SonicMfContainerTool restart
--domain proalpha-test
--url tcp://dekun-painwbdet:13070
--user Administrator
--container ct-ZADBService
--timeout 120
```
- Argumente über `ProcessStartInfo.ArgumentList` (keine manuellen Quotes → sonst Classpath-Bugs)
- Passwort: Umgebungsvariable `ESB_SONIC_PASSWORD`
- stdout/stderr lesen, auf Timeout killen
#### Erfolgskriterium in C#
Alles muss gelten:
1. `ExitCode == 0`
2. Ausgabe enthält `OK:RestartInvoked`
3. Ausgabe enthält **kein** `ERROR:`
Sonst Fehlertext (+ Classpath-Hinweis bei `ClassNotFoundException` / `JMSConnectorAddress`).
---
## 7. Java-Tool – der eigentliche API-Call
Datei: `Tools/SonicMfContainerTool.java`
Bytecode: `Tools/SonicMfContainerTool.class` (Java 8 / major 52)
Version-Stamp: `TOOL_VERSION = "2026-07-24d-restart-only"` (erste INFO-Zeile)
### 7.1 `main`
1. `INFO:ToolVersion=…` ausgeben
2. Args parsen – nur Befehl `restart` erlaubt
3. Pflicht: `--domain`, `--url`, `--user`, `--container`
4. Passwort: `--password` oder Env `ESB_SONIC_PASSWORD`
5. `connect(...)`
6. `restart(...)`
7. `disconnect` im `finally`
### 7.2 `connect` – Einloggen wie SMC
```text
Hashtable env:
ConnectionURLs = tcp://…
DefaultUser = Administrator
DefaultPassword = …
JMSConnectorAddress(env)
JMSConnectorClient()
optional: setTimeout / setRequestTimeout
client.connect(address [, timeout])
```
Klassen (aus den JARs, per Reflection):
- `com.sonicsw.mf.jmx.client.JMSConnectorAddress`
- `com.sonicsw.mf.jmx.client.JMSConnectorClient`
Reflection statt direkter Compile-Abhängigkeit: das Tool kompiliert ohne Sonic-JARs auf dem Build-Rechner; zur Laufzeit müssen die JARs im Classpath liegen.
### 7.3 `restart` – ObjectName und Lifecycle
1. Kurzname bilden (`proalpha-test.ct-ZADBService` → `ct-ZADBService`)
2. ObjectName:
```text
<DomainName>.<ContainerKurzname>:ID=AGENT
→ proalpha-test.ct-ZADBService:ID=AGENT
```
3. Operationen der Reihe nach:
| Versuch | Operation | Bedeutung |
|---------|-----------|-----------|
| 1 | `stop` | Agent stoppen (SMC macht oft faktisch Stop; Daemon startet neu) |
| 2 | `restart` | falls vorhanden und erlaubt |
4. Aufruf:
```text
connector.invoke(objectName, op, new Object[0], new String[0])
```
Das ist der JMX/`MBeanServerConnection.invoke`-Weg über den Sonic-Management-Connector.
### 7.4 Side-Effect bei `stop`
Wenn `stop` eine Exception wirft, deren Message auf Verbindungsabbruch hindeutet (`disconnect`, `closed`, `not connected`, `connection lost`), wertet das Tool das als **Erfolg**:
```text
OK:RestartInvoked method=MBean.stop(side-effect) …
```
Grund: der Agent geht runter und reißt oft die Management-Session – das ist erwartbar, kein „echter“ Fehlschlag.
### 7.5 Erfolgszeile
```text
OK:RestartInvoked method=MBean.stop container=ct-ZADBService domain=proalpha-test tool=2026-07-24d-restart-only
```
C# sucht genau nach `OK:RestartInvoked`.
### 7.6 Ausgabe-Konventionen
| Präfix | Bedeutung |
|---------|-----------|
| `INFO:` | Fortschritt / ObjectName / Trying … |
| `WARN:` | fehlgeschlagener Versuch, Weiterversuch |
| `ERROR:` | fatal, ExitCode ≠ 0 |
| `OK:RestartInvoked` | Erfolg |
---
## 8. Sequenz (zeitlich)
```mermaid
sequenceDiagram
participant UI as Form1
participant Orch as DeploymentOrchestrator
participant RE as RestartExecutor
participant MC as SonicManagementClient
participant EX as SonicMfApiExecutor
participant JV as SonicMfContainerTool
participant DM as Sonic Domain Manager
UI->>Orch: RestartOnlyAsync(selected)
Orch->>RE: ExecuteAsync(target)
RE->>MC: RestartContainerAsync(ct-ZADBService)
MC->>EX: RestartAsync(...)
EX->>EX: PrepareTool (java + jars + class)
EX->>JV: Process start restart …
JV->>DM: JMSConnectorClient.connect
JV->>DM: invoke(…:ID=AGENT, "stop")
DM-->>JV: ok / disconnect side-effect
JV-->>EX: OK:RestartInvoked
EX-->>MC: Success=true
MC->>MC: Delay PostRestartDelaySeconds
MC-->>UI: Status + Detail
```
---
## 9. Dateien und Verantwortlichkeiten
| Datei | Rolle |
|-------|--------|
| `Form1.cs` | UI, Auswahl, Bestätigung, Status |
| `Services/DeploymentOrchestrator.cs` | Lauf orchestrieren, Log |
| `Services/PreflightValidator.cs` | Vorabprüfung |
| `Services/RestartExecutor.cs` | Ziel → Connection |
| `Services/SonicManagementClient.cs` | Restart + Delay |
| `Services/SonicMfApiExecutor.cs` | Java-Prozess, Classpath, Erfolgsauswertung |
| `Services/SonicContainerDiscovery.cs` | KnownContainers → Grid-Ziele |
| `Models/SonicConnection.cs` | Konfigurationsmodell |
| `Models/DeploymentTarget.cs` | Zielzeile |
| `Tools/SonicMfContainerTool.java` | API-Client (Quellcode) |
| `Tools/SonicMfContainerTool.class` | ausgeliefert / Java-8-Bytecode |
| `appsettings.json` | Verbindungen + Containerliste |
---
## 10. Laufzeit-Voraussetzungen
1. **Java 8+** erreichbar (`JavaPath` empfohlen)
2. **`MfClientLibPath`** zeigt auf Ordner mit Sonic-Client-JARs
3. **`Tools\SonicMfContainerTool.class`** liegt neben der gebauten App
4. Netzwerk zu `ConnectionUrl` (Port z. B. 13070)
5. Gültige SMC-Credentials
6. Containername stimmt mit SMC überein (`ct-ZADBService`)
7. Domain Manager / Launch Daemon müssen Container nach Stop wieder starten können
### Tool neu kompilieren
```text
javac --release 8 -encoding UTF-8 Tools\SonicMfContainerTool.java
```
(oder `-source 1.8 -target 1.8`)
Danach App neu bauen, damit `.class` nach `bin\…\Tools\` kopiert wird (csproj Content-Copy).
---
## 11. Typische Fehler und Ursache
| Symptom | Ursache | Maßnahme |
|---------|---------|----------|
| `ClassNotFoundException: JMSConnectorAddress` | Classpath ohne MF-JARs / falsche Quotes | `MfClientLibPath` prüfen; `ArgumentList` nicht manuell quoten |
| `UnsupportedClassVersionError` | Runtime zu alt oder `.class` zu neu | Java 8+ Runtime; Tool mit `--release 8` bauen |
| `Java nicht gefunden` | `JavaPath` falsch | appsettings korrigieren |
| `Tools\SonicMfContainerTool.class nicht gefunden` | Build/Copy fehlt | Projekt neu bauen |
| `Neustart fehlgeschlagen` + Attempts | MBean `stop`/`restart` abgelehnt | ObjectName/Rechte/Containerstatus in SMC prüfen |
| Timeout | Domain Manager hängt / Netz | `TimeoutSeconds`, Firewall, Broker |
| Falscher Container | Alias statt Kurzname | `KnownContainers`: `ct-ZADBService` |
| Kein `ToolVersion=` in Output | alte/falsche `.class` | Tools neu kompilieren, Output-Ordner prüfen |
---
## 12. Verhältnis zur SMC
| SMC | Diese App |
|-----|-----------|
| Login mit User/Pass auf Domain-URL | dieselben Werte in appsettings |
| Container im Baum wählen | `KnownContainers` + Grid |
| Rechtsklick → Restart | `MBean.invoke("stop"|"restart")` auf `…:ID=AGENT` |
| UI zeigt Online/Offline | App wartet nur `PostRestartDelaySeconds`, pollt Status nicht |
Operativ oft: **Stop am Agent-MBean**; der **Launch Daemon** bringt den Container wieder hoch – analog zu vielen SMC-Restart-Verhalten bei remote „unbounded“ Clients.
Früher getestet: `IAgentProxy.restart()` schlägt remote häufig mit
`Operation unsupported for unbounded client connector` fehl – deshalb der direkte MBean-Weg.
---
## 13. Sicherheitshinweise
- Passwort steht in `appsettings.json` (Klartext) und kurzzeitig in der Prozess-Umgebung `ESB_SONIC_PASSWORD`.
- Nicht in öffentliche Repos committen bzw. Secrets auslagern.
- Logs (`LogDirectory`) können Tool-Output enthalten – ggf. sensible Zeilen beachten.
---
## 14. Manueller Test (ohne UI)
Mit denselben Werten wie in appsettings:
```text
set ESB_SONIC_PASSWORD=Administrator
java -cp "Tools;C:\DEV\MQ10.0\lib\*" SonicMfContainerTool restart ^
--domain proalpha-test ^
--url tcp://dekun-painwbdet:13070 ^
--user Administrator ^
--container ct-ZADBService ^
--timeout 120
```
Erwartet u. a.:
```text
INFO:ToolVersion=2026-07-24d-restart-only
INFO:ObjectName=proalpha-test.ct-ZADBService:ID=AGENT
INFO:Trying MBean.invoke(stop)
OK:RestartInvoked method=MBean.stop container=ct-ZADBService domain=proalpha-test tool=2026-07-24d-restart-only
```
(Unter Windows Classpath ggf. mit `;` und expliziten JAR-Namen statt `*`, je nach Shell.)
---
## 15. Kurzfassung
1. UI wählt Ziel aus `KnownContainers`.
2. C# findet die passenden Sonic-Verbindungsdaten.
3. C# startet Java mit MF-Client-JARs + `SonicMfContainerTool`.
4. Java verbindet sich wie die SMC an den Domain Manager.
5. Java ruft auf dem Agent-MBean `stop` (sonst `restart`) auf.
6. Bei `OK:RestartInvoked` wartet C# noch `PostRestartDelaySeconds` und meldet Erfolg.
**Der einzige echte Sonic-API-Call der App ist:**
`JMSConnectorClient.invoke(<domain>.<container>:ID=AGENT, "stop"|"restart", …)`.
+91 -11
View File
@@ -1651,7 +1651,8 @@ namespace ZA.CoreService.ESBCertificateManager
private async Task ProbeTargetCertificatesAsync(
IReadOnlySet<int>? preferLoadedCertificateForTargetIds = null)
{
CertificateProbeService probe = new();
CertificateProbeService fileProbe = new();
TlsEndpointProbeService tlsProbe = new();
string? password = _loadedCertificatePassword;
Func<string?>? passwordPrompt = password is null
? null
@@ -1664,8 +1665,37 @@ namespace ZA.CoreService.ESBCertificateManager
continue;
}
// Bevorzugt Live-TLS-Probe (curl-ähnlich), wenn URL am Container gesetzt.
if (!string.IsNullOrWhiteSpace(target.TlsHost)
&& target.TlsPort is int tlsPort)
{
string checkUrl =
string.IsNullOrWhiteSpace(target.TlsServerName)
? $"{target.TlsHost}:{tlsPort}"
: $"https://{target.TlsServerName}:{tlsPort}";
CertificateProbeResult tlsResult = await Task.Run(
() => tlsProbe.Probe(checkUrl));
if (IsDisposed || !dgvTargets.Columns.Contains("Expiry"))
{
return;
}
if (tlsResult.Success && tlsResult.Certificate is not null)
{
row.Cells["Expiry"].Value =
"TLS · "
+ FormatCertificateExpiryCell(tlsResult.Certificate);
continue;
}
row.Cells["Expiry"].Value = "TLS · nicht erreichbar";
continue;
}
CertificateProbeResult result = await Task.Run(
() => probe.Probe(target.FullTargetPath, passwordPrompt));
() => fileProbe.Probe(target.FullTargetPath, passwordPrompt));
if (IsDisposed || !dgvTargets.Columns.Contains("Expiry"))
{
@@ -1697,6 +1727,13 @@ namespace ZA.CoreService.ESBCertificateManager
continue;
}
if (result.AccessDenied)
{
row.Cells["Expiry"].Value =
CertificateProbeResult.AccessDeniedShortText;
continue;
}
row.Cells["Expiry"].Value = result.Success
? "Datei fehlt"
: "nicht erreichbar";
@@ -1940,13 +1977,27 @@ namespace ZA.CoreService.ESBCertificateManager
runResult.TargetResults
.Where(result => !result.Success)
.Select(result =>
$"{result.TargetName}: {result.StatusText}"
$"{result.TargetName}"
+ Environment.NewLine
+ (result.Detail ?? string.Empty)));
+ SonicErrorClassifier.FormatRestartFailure(
result.StatusText,
result.Detail)));
bool permissionIssue =
SonicErrorClassifier.LooksLikeMissingPermission(details);
if (permissionIssue)
{
SetStatus(
"Neustart nicht möglich – fehlende Benutzerrechte.",
isError: true);
}
CopyableErrorDialog.Show(
this,
"Neustart fehlgeschlagen (MfApi)",
permissionIssue
? "Keine Rechte für den Neustart"
: "Neustart fehlgeschlagen (MfApi)",
string.IsNullOrWhiteSpace(details)
? "Neustart fehlgeschlagen (keine Details)."
: details);
@@ -1958,11 +2009,26 @@ namespace ZA.CoreService.ESBCertificateManager
}
catch (Exception ex)
{
SetStatus($"Neustart fehlgeschlagen: {ex.Message}", isError: true);
string formatted =
SonicErrorClassifier.FormatRestartFailure(
"Neustart fehlgeschlagen",
ex.ToString());
bool permissionIssue =
SonicErrorClassifier.LooksLikeMissingPermission(formatted);
SetStatus(
permissionIssue
? "Neustart nicht möglich – fehlende Benutzerrechte."
: $"Neustart fehlgeschlagen: {ex.Message}",
isError: true);
CopyableErrorDialog.Show(
this,
"Neustart fehlgeschlagen (MfApi)",
ex.ToString());
permissionIssue
? "Keine Rechte für den Neustart"
: "Neustart fehlgeschlagen (MfApi)",
formatted);
}
finally
{
@@ -2078,13 +2144,27 @@ namespace ZA.CoreService.ESBCertificateManager
runResult.TargetResults
.Where(result => !result.Success)
.Select(result =>
$"{result.TargetName}: {result.StatusText}"
$"{result.TargetName}"
+ Environment.NewLine
+ (result.Detail ?? string.Empty)));
+ SonicErrorClassifier.FormatRestartFailure(
result.StatusText,
result.Detail)));
bool permissionIssue =
SonicErrorClassifier.LooksLikeMissingPermission(details);
if (permissionIssue)
{
SetStatus(
"Austausch/Neustart nicht möglich – fehlende Benutzerrechte.",
isError: true);
}
CopyableErrorDialog.Show(
this,
"Austausch fehlgeschlagen",
permissionIssue
? "Keine Rechte für den Neustart"
: "Austausch fehlgeschlagen",
details);
await ProbeTargetCertificatesAsync(exchangedTargetIds);
@@ -26,6 +26,11 @@ public sealed class ContainerOption
public string? ContainerDisplayName { get; init; }
/// <summary>
/// Endpoint für TLS-Zertifikatsprüfung, z. B. https://host:8443 oder host:8443.
/// </summary>
public string? CertificateCheckUrl { get; init; }
public required string CompanyCode { get; init; }
public required string ConnectionName { get; init; }
@@ -34,7 +34,20 @@ public sealed class CertificateProbeService
+ string.Join(", ", SupportedExtensions));
}
if (!File.Exists(normalized))
PathReachability reachability = AssessPathReachability(normalized);
if (reachability == PathReachability.AccessDenied)
{
return CertificateProbeResult.ForAccessDenied(normalized);
}
if (reachability == PathReachability.Unreachable)
{
return CertificateProbeResult.Failed(
"Pfad nicht erreichbar.");
}
if (reachability == PathReachability.FileMissing)
{
return CertificateProbeResult.Missing(
normalized,
@@ -72,6 +85,14 @@ public sealed class CertificateProbeService
"Das Kennwort ist falsch oder die Datei ist beschädigt.");
}
}
catch (UnauthorizedAccessException)
{
return CertificateProbeResult.ForAccessDenied(normalized);
}
catch (IOException ex) when (IsAccessOrLogonFailure(ex))
{
return CertificateProbeResult.ForAccessDenied(normalized);
}
catch (Exception ex)
{
return CertificateProbeResult.Failed(
@@ -151,6 +172,154 @@ public sealed class CertificateProbeService
|| extension.Equals(".p12", StringComparison.OrdinalIgnoreCase);
}
private enum PathReachability
{
FileExists,
FileMissing,
AccessDenied,
Unreachable
}
/// <summary>
/// Unterscheidet „Datei fehlt“ von „Share/Pfad ohne Admin-Konto nicht erreichbar“.
/// File.Exists liefert bei fehlenden Credentials oft nur false.
/// </summary>
private static PathReachability AssessPathReachability(string filePath)
{
try
{
if (File.Exists(filePath))
{
return PathReachability.FileExists;
}
}
catch (UnauthorizedAccessException)
{
return PathReachability.AccessDenied;
}
catch (IOException ex) when (IsAccessOrLogonFailure(ex))
{
return PathReachability.AccessDenied;
}
catch (IOException)
{
return PathReachability.Unreachable;
}
string? directory = Path.GetDirectoryName(filePath);
if (string.IsNullOrWhiteSpace(directory))
{
return PathReachability.Unreachable;
}
return AssessDirectoryReachability(directory);
}
private static PathReachability AssessDirectoryReachability(string directory)
{
string current = directory.TrimEnd('\\', '/');
while (!string.IsNullOrWhiteSpace(current))
{
try
{
if (Directory.Exists(current))
{
// Exists kann bei UNC ohne Rechte „lügen“ – Auflisten erzwingen.
_ = Directory.EnumerateFileSystemEntries(current)
.Any();
return PathReachability.FileMissing;
}
if (current.StartsWith(@"\\", StringComparison.Ordinal))
{
// Exists=false: echter Zugriffsfehler oder Ordner fehlt.
_ = Directory.GetFileSystemEntries(current);
return PathReachability.FileMissing;
}
// Lokaler Ordner fehlt → für Erst-Deployment als „Datei fehlt“ werten.
return PathReachability.FileMissing;
}
catch (UnauthorizedAccessException)
{
return PathReachability.AccessDenied;
}
catch (IOException ex) when (IsAccessOrLogonFailure(ex))
{
return PathReachability.AccessDenied;
}
catch (DirectoryNotFoundException)
{
string? parent = GetParentPath(current);
if (parent is null || parent == current)
{
return current.StartsWith(@"\\", StringComparison.Ordinal)
? PathReachability.Unreachable
: PathReachability.FileMissing;
}
current = parent;
continue;
}
catch (IOException)
{
return PathReachability.Unreachable;
}
}
return PathReachability.Unreachable;
}
private static string? GetParentPath(string path)
{
string trimmed = path.TrimEnd('\\', '/');
if (trimmed.StartsWith(@"\\", StringComparison.Ordinal))
{
// \\server\share → Stop; darunter weiter nach oben.
string withoutPrefix = trimmed[2..];
int slash = withoutPrefix.IndexOfAny(['\\', '/']);
if (slash < 0)
{
return null;
}
int second = withoutPrefix.IndexOfAny(['\\', '/'], slash + 1);
if (second < 0)
{
// Bereits Share-Root \\server\share
return null;
}
}
string? parent = Path.GetDirectoryName(trimmed);
return string.IsNullOrWhiteSpace(parent) ? null : parent;
}
private static bool IsAccessOrLogonFailure(IOException ex)
{
// HRESULT-Lower-Word = Win32-Fehlercode
int win32 = ex.HResult & 0xFFFF;
return win32 is
5 or // ERROR_ACCESS_DENIED
53 or // ERROR_BAD_NETPATH
67 or // ERROR_BAD_NET_NAME
86 or // ERROR_INVALID_PASSWORD
1326 or // ERROR_LOGON_FAILURE
59 or // ERROR_UNEXP_NET_ERR
64 or // ERROR_NETNAME_DELETED
1219 or // ERROR_SESSION_CREDENTIAL_CONFLICT
1240 or // ERROR_LOGIN_WKSTA_RESTRICTION
1245 or // ERROR_ACCOUNT_RESTRICTION
1396; // ERROR_WRONG_TARGET_NAME
}
private static string? NormalizePath(string? path)
{
if (string.IsNullOrWhiteSpace(path))
@@ -233,10 +402,14 @@ public sealed class CertificateProbeService
public sealed class CertificateProbeResult
{
public const string AccessDeniedShortText = "Admin nötig";
public bool Success { get; init; }
public bool FileExists { get; init; }
public bool AccessDenied { get; init; }
public string Path { get; init; } = string.Empty;
public string Message { get; init; } = string.Empty;
@@ -289,6 +462,19 @@ public sealed class CertificateProbeResult
};
}
public static CertificateProbeResult ForAccessDenied(string path)
{
return new CertificateProbeResult
{
Success = false,
FileExists = false,
AccessDenied = true,
Path = path,
Message =
"Kein Zugriff auf den Pfad – Admin-Konto nötig."
};
}
public static CertificateProbeResult PasswordRequired(string path)
{
return new CertificateProbeResult
@@ -43,6 +43,7 @@ public sealed class DeploymentTargetRepository
container.[SonicContainerId],
container.[ContainerName],
container.[ContainerDisplayName],
container.[CertificateCheckUrl],
container.[RestartTimeoutSeconds],
connection.[ConnectionName],
@@ -119,6 +120,9 @@ public sealed class DeploymentTargetRepository
int containerDisplayNameOrdinal =
reader.GetOrdinal("ContainerDisplayName");
int certificateCheckUrlOrdinal =
reader.GetOrdinal("CertificateCheckUrl");
int restartTimeoutOrdinal =
reader.GetOrdinal("RestartTimeoutSeconds");
@@ -144,6 +148,11 @@ public sealed class DeploymentTargetRepository
reader,
containerDisplayNameOrdinal);
string? certificateCheckUrl =
ReadNullableString(
reader,
certificateCheckUrlOrdinal);
string companyCode =
reader.GetString(companyCodeOrdinal);
@@ -152,6 +161,22 @@ public sealed class DeploymentTargetRepository
? containerName
: containerDisplayName;
string tlsHost = string.Empty;
int? tlsPort = null;
string tlsServerName = string.Empty;
if (TlsEndpointProbeService.TryParseEndpoint(
certificateCheckUrl,
out string host,
out int port,
out string serverName,
out _))
{
tlsHost = host;
tlsPort = port;
tlsServerName = serverName;
}
targets.Add(new DeploymentTarget
{
Id = reader.GetInt32(targetIdOrdinal),
@@ -188,11 +213,11 @@ public sealed class DeploymentTargetRepository
RestartTimeoutSeconds =
reader.GetInt32(restartTimeoutOrdinal),
TlsHost = string.Empty,
TlsHost = tlsHost,
TlsPort = null,
TlsPort = tlsPort,
TlsServerName = string.Empty,
TlsServerName = tlsServerName,
ExpectedFingerprint = null,
@@ -0,0 +1,75 @@
namespace ZA.CoreService.ESBCertificateManager.Services;
/// <summary>
/// Erkennt typische Sonic-/MfApi-Fehlermeldungen und liefert
/// verständliche Hinweise für die UI.
/// </summary>
public static class SonicErrorClassifier
{
private static readonly string[] PermissionMarkers =
[
"ManagePermissionDenied",
"ConfigurePermissionDenied",
"ManagementPermissionDenied",
"PermissionDenied",
"MFSecurityException",
"SecurityException",
"Access is denied",
"Access denied",
"not authorized",
"nicht autorisiert",
"permission denied",
"keine Berechtigung",
"Insufficient privileges",
"Unauthorized"
];
public static bool LooksLikeMissingPermission(string? text)
{
if (string.IsNullOrWhiteSpace(text))
{
return false;
}
foreach (string marker in PermissionMarkers)
{
if (text.Contains(marker, StringComparison.OrdinalIgnoreCase))
{
return true;
}
}
return false;
}
public static string PermissionDeniedUserMessage =>
"Keine Rechte für den Neustart.\n\n"
+ "Der hinterlegte Sonic-Benutzer darf diesen Container "
+ "nicht neu starten (Manage-/Restart-Recht fehlt).\n\n"
+ "Bitte in der Sonic Management Console die Rechte prüfen "
+ "oder ein Profil mit ausreichenden Rechten verwenden.";
public static string FormatRestartFailure(
string? status,
string? detail)
{
string combined = string.Join(
Environment.NewLine,
new[] { status, detail }
.Where(value => !string.IsNullOrWhiteSpace(value)));
if (LooksLikeMissingPermission(combined))
{
return PermissionDeniedUserMessage
+ Environment.NewLine
+ Environment.NewLine
+ "--- Technische Details ---"
+ Environment.NewLine
+ combined;
}
return string.IsNullOrWhiteSpace(combined)
? "Neustart fehlgeschlagen (keine Details)."
: combined;
}
}
@@ -34,9 +34,21 @@ public sealed class SonicManagementClient : IDisposable
$"Domain={_connection.DomainName}; URL={_connection.ConnectionUrl}\n{output}");
}
return (false, "Neustart fehlgeschlagen (MfApi)",
$"Container '{containerName}', Domain '{_connection.DomainName}', URL {_connection.ConnectionUrl}\n" +
$"Fehler: {error}\n\n{output}");
string technical =
$"Container '{containerName}', Domain '{_connection.DomainName}', URL {_connection.ConnectionUrl}\n"
+ $"Fehler: {error}\n\n{output}";
if (SonicErrorClassifier.LooksLikeMissingPermission(technical))
{
return (
false,
"Keine Rechte für den Neustart",
SonicErrorClassifier.FormatRestartFailure(
"Keine Rechte für den Neustart",
technical));
}
return (false, "Neustart fehlgeschlagen (MfApi)", technical);
}
public void Dispose()
@@ -380,6 +380,228 @@ public sealed class SonicSetupRepository
}
}
public async Task UpdateCredentialAsync(
int sonicCredentialId,
int sonicConnectionId,
string credentialName,
string userName,
string secret,
bool isDefault,
CancellationToken cancellationToken = default)
{
if (sonicCredentialId <= 0)
{
throw new ArgumentOutOfRangeException(
nameof(sonicCredentialId));
}
if (sonicConnectionId <= 0)
{
throw new ArgumentOutOfRangeException(
nameof(sonicConnectionId));
}
if (string.IsNullOrWhiteSpace(credentialName))
{
throw new ArgumentException(
"Der Profilname fehlt.",
nameof(credentialName));
}
if (string.IsNullOrWhiteSpace(userName))
{
throw new ArgumentException(
"Der Sonic-Benutzername fehlt.",
nameof(userName));
}
if (string.IsNullOrEmpty(secret))
{
throw new ArgumentException(
"Das Sonic-Kennwort fehlt.",
nameof(secret));
}
string normalizedCredentialName =
credentialName.Trim();
string normalizedUserName =
userName.Trim();
if (normalizedCredentialName.Length > 150)
{
throw new ArgumentException(
"Der Profilname darf maximal 150 Zeichen enthalten.",
nameof(credentialName));
}
if (normalizedUserName.Length > 256)
{
throw new ArgumentException(
"Der Benutzername darf maximal 256 Zeichen enthalten.",
nameof(userName));
}
if (secret.Length > 512)
{
throw new ArgumentException(
"Das Kennwort darf maximal 512 Zeichen enthalten.",
nameof(secret));
}
await using SqlConnection connection =
new(_connectionString);
await connection.OpenAsync(cancellationToken);
await using SqlTransaction transaction =
(SqlTransaction)
await connection.BeginTransactionAsync(
cancellationToken);
try
{
if (isDefault)
{
const string clearDefaultSql = """
UPDATE [dbo].[SonicCredential]
SET
[IsDefault] = 0,
[ModifiedDateTime] = SYSUTCDATETIME(),
[ModifiedBy] = SUSER_SNAME()
WHERE [SonicConnectionId] =
@SonicConnectionId
AND [IsDefault] = 1
AND [SonicCredentialId] <>
@SonicCredentialId;
""";
await using SqlCommand clearDefaultCommand =
new(
clearDefaultSql,
connection,
transaction);
clearDefaultCommand.Parameters.Add(
new SqlParameter(
"@SonicConnectionId",
SqlDbType.Int)
{
Value = sonicConnectionId
});
clearDefaultCommand.Parameters.Add(
new SqlParameter(
"@SonicCredentialId",
SqlDbType.Int)
{
Value = sonicCredentialId
});
await clearDefaultCommand.ExecuteNonQueryAsync(
cancellationToken);
}
const string updateSql = """
UPDATE [dbo].[SonicCredential]
SET
[CredentialName] = @CredentialName,
[CredentialUserName] = @CredentialUserName,
[CredentialSecret] = @CredentialSecret,
[IsDefault] = @IsDefault,
[ModifiedDateTime] = SYSUTCDATETIME(),
[ModifiedBy] = SUSER_SNAME()
WHERE [SonicCredentialId] = @SonicCredentialId
AND [SonicConnectionId] = @SonicConnectionId
AND [IsActive] = 1;
""";
await using SqlCommand updateCommand =
new(
updateSql,
connection,
transaction);
updateCommand.Parameters.Add(
new SqlParameter(
"@SonicCredentialId",
SqlDbType.Int)
{
Value = sonicCredentialId
});
updateCommand.Parameters.Add(
new SqlParameter(
"@SonicConnectionId",
SqlDbType.Int)
{
Value = sonicConnectionId
});
updateCommand.Parameters.Add(
new SqlParameter(
"@CredentialName",
SqlDbType.NVarChar,
150)
{
Value = normalizedCredentialName
});
updateCommand.Parameters.Add(
new SqlParameter(
"@CredentialUserName",
SqlDbType.NVarChar,
256)
{
Value = normalizedUserName
});
updateCommand.Parameters.Add(
new SqlParameter(
"@CredentialSecret",
SqlDbType.NVarChar,
512)
{
Value = secret
});
updateCommand.Parameters.Add(
new SqlParameter(
"@IsDefault",
SqlDbType.Bit)
{
Value = isDefault
});
int affected =
await updateCommand.ExecuteNonQueryAsync(
cancellationToken);
if (affected == 0)
{
throw new InvalidOperationException(
$"Benutzerprofil Id {sonicCredentialId} "
+ "wurde nicht gefunden oder ist inaktiv.");
}
await transaction.CommitAsync(cancellationToken);
}
catch
{
try
{
await transaction.RollbackAsync(
CancellationToken.None);
}
catch
{
// Die ursprüngliche Exception soll erhalten bleiben.
}
throw;
}
}
public async Task<IReadOnlyList<SonicCredentialProfile>>
GetCredentialsAsync(
int sonicConnectionId,
@@ -663,6 +885,7 @@ public sealed class SonicSetupRepository
container.[CompanyId],
container.[ContainerName],
container.[ContainerDisplayName],
container.[CertificateCheckUrl],
container.[RestartTimeoutSeconds],
company.[CompanyCode],
connection.[ConnectionName]
@@ -729,6 +952,9 @@ public sealed class SonicSetupRepository
int displayOrdinal =
reader.GetOrdinal("ContainerDisplayName");
int checkUrlOrdinal =
reader.GetOrdinal("CertificateCheckUrl");
containers.Add(
new ContainerOption
{
@@ -753,6 +979,11 @@ public sealed class SonicSetupRepository
? null
: reader.GetString(displayOrdinal),
CertificateCheckUrl =
reader.IsDBNull(checkUrlOrdinal)
? null
: reader.GetString(checkUrlOrdinal),
RestartTimeoutSeconds =
reader.GetInt32(
reader.GetOrdinal("RestartTimeoutSeconds")),
@@ -1057,6 +1288,7 @@ public sealed class SonicSetupRepository
string containerName,
string? containerDisplayName,
int restartTimeoutSeconds,
string? certificateCheckUrl = null,
CancellationToken cancellationToken = default)
{
if (companyId <= 0)
@@ -1093,6 +1325,9 @@ public sealed class SonicSetupRepository
"Timeout muss zwischen 10 und 3600 Sekunden liegen.");
}
string? checkUrl =
TlsEndpointProbeService.NormalizeCheckUrl(certificateCheckUrl);
const string sql = """
INSERT INTO [dbo].[SonicContainer]
(
@@ -1100,6 +1335,7 @@ public sealed class SonicSetupRepository
[SonicConnectionId],
[ContainerName],
[ContainerDisplayName],
[CertificateCheckUrl],
[RestartTimeoutSeconds],
[IsActive],
[CreationDateTime],
@@ -1112,6 +1348,7 @@ public sealed class SonicSetupRepository
@SonicConnectionId,
@ContainerName,
@ContainerDisplayName,
@CertificateCheckUrl,
@RestartTimeoutSeconds,
1,
SYSUTCDATETIME(),
@@ -1159,6 +1396,17 @@ public sealed class SonicSetupRepository
: display
});
command.Parameters.Add(
new SqlParameter(
"@CertificateCheckUrl",
SqlDbType.NVarChar,
500)
{
Value = checkUrl is null
? DBNull.Value
: checkUrl
});
command.Parameters.Add(
new SqlParameter(
"@RestartTimeoutSeconds",
@@ -1457,6 +1705,7 @@ public sealed class SonicSetupRepository
string containerName,
string? containerDisplayName,
int restartTimeoutSeconds,
string? certificateCheckUrl = null,
CancellationToken cancellationToken = default)
{
if (sonicContainerId <= 0)
@@ -1499,6 +1748,9 @@ public sealed class SonicSetupRepository
"Timeout muss zwischen 10 und 3600 Sekunden liegen.");
}
string? checkUrl =
TlsEndpointProbeService.NormalizeCheckUrl(certificateCheckUrl);
const string sql = """
UPDATE [dbo].[SonicContainer]
SET
@@ -1506,6 +1758,7 @@ public sealed class SonicSetupRepository
[SonicConnectionId] = @SonicConnectionId,
[ContainerName] = @ContainerName,
[ContainerDisplayName] = @ContainerDisplayName,
[CertificateCheckUrl] = @CertificateCheckUrl,
[RestartTimeoutSeconds] = @RestartTimeoutSeconds,
[ModifiedDateTime] = SYSUTCDATETIME(),
[ModifiedBy] = SUSER_SNAME()
@@ -1559,6 +1812,17 @@ public sealed class SonicSetupRepository
: display
});
command.Parameters.Add(
new SqlParameter(
"@CertificateCheckUrl",
SqlDbType.NVarChar,
500)
{
Value = checkUrl is null
? DBNull.Value
: checkUrl
});
command.Parameters.Add(
new SqlParameter(
"@RestartTimeoutSeconds",
@@ -0,0 +1,235 @@
using System.Net.Security;
using System.Net.Sockets;
using System.Security.Cryptography;
using System.Security.Cryptography.X509Certificates;
using System.Text.RegularExpressions;
using ZA.CoreService.ESBCertificateManager.Models;
namespace ZA.CoreService.ESBCertificateManager.Services;
/// <summary>
/// Liest das präsentierte TLS-Zertifikat eines Endpoints
/// (entspricht grob <c>curl -v https://host:port</c>).
/// </summary>
public sealed class TlsEndpointProbeService
{
private static readonly Regex HostPortRegex = new(
@"^(?<host>[^:/]+)(:(?<port>\d{1,5}))?$",
RegexOptions.Compiled | RegexOptions.CultureInvariant);
public CertificateProbeResult Probe(
string? checkUrl,
int timeoutMilliseconds = 8000)
{
if (!TryParseEndpoint(
checkUrl,
out string host,
out int port,
out string serverName,
out string? parseError))
{
return CertificateProbeResult.Failed(
parseError ?? "Ungültige Prüf-URL.");
}
try
{
using CancellationTokenSource cts = new(timeoutMilliseconds);
using TcpClient client = new();
using (cts.Token.Register(
() =>
{
try
{
client.Close();
}
catch
{
// Timeout beendet die Verbindung.
}
}))
{
client.Connect(host, port);
}
using SslStream ssl = new(
client.GetStream(),
leaveInnerStreamOpen: false,
userCertificateValidationCallback:
static (_, _, _, _) => true);
ssl.AuthenticateAsClient(serverName);
if (ssl.RemoteCertificate is null)
{
return CertificateProbeResult.Failed(
$"Kein Zertifikat von {host}:{port} erhalten.");
}
using X509Certificate2 certificate = new(ssl.RemoteCertificate);
CertificateInfo info = ToCertificateInfo(certificate);
return CertificateProbeResult.Found(
$"{host}:{port}",
info);
}
catch (Exception ex)
{
return CertificateProbeResult.Failed(
$"TLS-Prüfung {host}:{port} fehlgeschlagen: {ex.Message}");
}
}
public static bool TryParseEndpoint(
string? value,
out string host,
out int port,
out string serverName,
out string? error)
{
host = string.Empty;
port = 443;
serverName = string.Empty;
error = null;
if (string.IsNullOrWhiteSpace(value))
{
error = "Keine Prüf-URL hinterlegt.";
return false;
}
string trimmed = value.Trim();
if (Uri.TryCreate(trimmed, UriKind.Absolute, out Uri? uri)
&& (uri.Scheme.Equals("https", StringComparison.OrdinalIgnoreCase)
|| uri.Scheme.Equals("http", StringComparison.OrdinalIgnoreCase)
|| uri.Scheme.Equals("ssl", StringComparison.OrdinalIgnoreCase)
|| uri.Scheme.Equals("tcp", StringComparison.OrdinalIgnoreCase)))
{
if (string.IsNullOrWhiteSpace(uri.Host))
{
error = "Host in der Prüf-URL fehlt.";
return false;
}
host = uri.Host;
serverName = uri.Host;
port = uri.IsDefaultPort
? (uri.Scheme.Equals("http", StringComparison.OrdinalIgnoreCase)
? 80
: 443)
: uri.Port;
if (port is < 1 or > 65535)
{
error = "Port muss zwischen 1 und 65535 liegen.";
return false;
}
return true;
}
Match match = HostPortRegex.Match(trimmed);
if (!match.Success)
{
error =
"Prüf-URL ungültig. Beispiele:\n"
+ "https://server:8443\n"
+ "server:8443\n"
+ "server";
return false;
}
host = match.Groups["host"].Value;
serverName = host;
if (match.Groups["port"].Success)
{
if (!int.TryParse(match.Groups["port"].Value, out port)
|| port is < 1 or > 65535)
{
error = "Port muss zwischen 1 und 65535 liegen.";
return false;
}
}
return !string.IsNullOrWhiteSpace(host);
}
public static string? NormalizeCheckUrl(string? value)
{
if (string.IsNullOrWhiteSpace(value))
{
return null;
}
string trimmed = value.Trim();
if (!TryParseEndpoint(
trimmed,
out _,
out _,
out _,
out string? error))
{
throw new ArgumentException(
error ?? "Ungültige Prüf-URL.",
nameof(value));
}
if (trimmed.Length > 500)
{
throw new ArgumentException(
"Die Prüf-URL darf maximal 500 Zeichen enthalten.",
nameof(value));
}
return trimmed;
}
private static CertificateInfo ToCertificateInfo(
X509Certificate2 certificate)
{
string subject = certificate.GetNameInfo(
X509NameType.SimpleName,
forIssuer: false);
string issuer = certificate.GetNameInfo(
X509NameType.SimpleName,
forIssuer: true);
if (string.IsNullOrWhiteSpace(subject))
{
subject = certificate.Subject;
}
if (string.IsNullOrWhiteSpace(issuer))
{
issuer = certificate.Issuer;
}
string fingerprint = certificate.GetCertHashString(
HashAlgorithmName.SHA256);
fingerprint = string.Join(
":",
Enumerable.Range(0, fingerprint.Length / 2)
.Select(index => fingerprint.Substring(index * 2, 2)));
DateTimeOffset validFrom = new(certificate.NotBefore);
DateTimeOffset validUntil = new(certificate.NotAfter);
DateTimeOffset now = DateTimeOffset.Now;
return new CertificateInfo
{
Subject = subject,
Issuer = issuer,
FingerprintSha256 = fingerprint,
ValidFrom = validFrom,
ValidUntil = validUntil,
IsCurrentlyValid = now >= validFrom && now <= validUntil
};
}
}
@@ -1,4 +1,5 @@
using ZA.CoreService.ESBCertificateManager.Models;
using ZA.CoreService.ESBCertificateManager.Services;
namespace ZA.CoreService.ESBCertificateManager.Setup;
@@ -11,8 +12,10 @@ public sealed class AddContainerForm : Form
private readonly ComboBox _cmbSystem;
private readonly TextBox _txtName;
private readonly TextBox _txtDisplay;
private readonly TextBox _txtCheckUrl;
private readonly TextBox _txtTimeout;
private readonly Button _btnSave;
private readonly Button _btnProbeUrl;
private bool _running;
public int? CreatedSonicContainerId { get; private set; }
@@ -36,7 +39,7 @@ public sealed class AddContainerForm : Form
MaximizeBox = false;
MinimizeBox = false;
ShowInTaskbar = false;
ClientSize = new Size(540, 470);
ClientSize = new Size(540, 560);
BackColor = SettingsUi.Background;
ForeColor = SettingsUi.Text;
Font = new Font("Segoe UI", 10f);
@@ -55,7 +58,7 @@ public sealed class AddContainerForm : Form
Label subtitle = new()
{
Text =
"Container einer Company und einem Sonic-System zuordnen.",
"Container zuordnen und optional TLS-Prüf-URL hinterlegen.",
Location = new Point(30, 58),
AutoSize = true,
ForeColor = SettingsUi.Muted
@@ -63,13 +66,14 @@ public sealed class AddContainerForm : Form
Panel card = SettingsUi.CreateCard();
card.Location = new Point(28, 95);
card.Size = new Size(484, 290);
card.Size = new Size(484, 370);
card.Paint += SettingsUi.PaintCardBorder;
_cmbCompany = SettingsUi.CreateComboBox();
_cmbSystem = SettingsUi.CreateComboBox();
_txtName = SettingsUi.CreateTextBox();
_txtDisplay = SettingsUi.CreateTextBox();
_txtCheckUrl = SettingsUi.CreateTextBox();
_txtTimeout = SettingsUi.CreateTextBox();
_txtTimeout.Text = "180";
@@ -77,6 +81,7 @@ public sealed class AddContainerForm : Form
{
_txtName.Text = _existing.ContainerName;
_txtDisplay.Text = _existing.ContainerDisplayName ?? string.Empty;
_txtCheckUrl.Text = _existing.CertificateCheckUrl ?? string.Empty;
_txtTimeout.Text = _existing.RestartTimeoutSeconds.ToString();
}
@@ -85,15 +90,39 @@ public sealed class AddContainerForm : Form
AddField(card, "Container-Name", _txtName, 18, 138, 440);
AddField(card, "Anzeigename (optional)", _txtDisplay, 18, 198, 280);
AddField(card, "Timeout (s)", _txtTimeout, 318, 198, 140);
AddField(
card,
"Zertifikat prüfen (URL / Host:Port)",
_txtCheckUrl,
18,
258,
440);
Label urlHint = new()
{
Text = "z. B. https://server:8443 oder server:8443",
Location = new Point(18, 312),
AutoSize = true,
ForeColor = SettingsUi.Muted,
Font = new Font("Segoe UI", 8.5f)
};
_btnProbeUrl = SettingsUi.CreateGhostButton("URL prüfen");
_btnProbeUrl.Location = new Point(318, 318);
_btnProbeUrl.Size = new Size(140, 30);
_btnProbeUrl.Click += (_, _) => ProbeUrl();
card.Controls.Add(urlHint);
card.Controls.Add(_btnProbeUrl);
_btnSave = SettingsUi.CreatePrimaryButton(
IsEditMode ? "Änderungen speichern" : "Container anlegen");
_btnSave.Location = new Point(292, 405);
_btnSave.Location = new Point(292, 490);
_btnSave.Size = new Size(220, 40);
_btnSave.Click += async (_, _) => await SaveAsync();
Button cancel = SettingsUi.CreateGhostButton("Abbrechen");
cancel.Location = new Point(170, 405);
cancel.Location = new Point(170, 490);
cancel.Size = new Size(110, 40);
cancel.Click += (_, _) =>
{
@@ -110,6 +139,53 @@ public sealed class AddContainerForm : Form
Shown += async (_, _) => await LoadLookupsAsync();
}
private void ProbeUrl()
{
string url = _txtCheckUrl.Text.Trim();
if (string.IsNullOrWhiteSpace(url))
{
MessageBox.Show(
this,
"Bitte zuerst eine Prüf-URL eintragen.",
"URL prüfen",
MessageBoxButtons.OK,
MessageBoxIcon.Information);
return;
}
TlsEndpointProbeService probe = new();
CertificateProbeResult result = probe.Probe(url);
if (result.Success && result.Certificate is not null)
{
string expiry = result.Certificate.ValidUntil
.ToLocalTime()
.ToString("dd.MM.yyyy HH:mm");
MessageBox.Show(
this,
$"TLS-Zertifikat erreichbar.\n\n"
+ $"Subject: {result.Certificate.Subject}\n"
+ $"Aussteller: {result.Certificate.Issuer}\n"
+ $"Gültig bis: {expiry}\n"
+ $"Status: {(result.Certificate.IsCurrentlyValid ? "gültig" : "abgelaufen")}",
"URL prüfen",
MessageBoxButtons.OK,
result.Certificate.IsCurrentlyValid
? MessageBoxIcon.Information
: MessageBoxIcon.Warning);
return;
}
MessageBox.Show(
this,
result.Message,
"URL prüfen",
MessageBoxButtons.OK,
MessageBoxIcon.Warning);
}
private async Task LoadLookupsAsync()
{
try
@@ -211,6 +287,29 @@ public sealed class AddContainerForm : Form
return;
}
string? checkUrl = _txtCheckUrl.Text.Trim();
if (string.IsNullOrWhiteSpace(checkUrl))
{
checkUrl = null;
}
else if (!TlsEndpointProbeService.TryParseEndpoint(
checkUrl,
out _,
out _,
out _,
out string? parseError))
{
MessageBox.Show(
this,
parseError ?? "Ungültige Prüf-URL.",
"Container",
MessageBoxButtons.OK,
MessageBoxIcon.Warning);
_txtCheckUrl.Focus();
return;
}
_running = true;
_btnSave.Enabled = false;
Cursor = Cursors.WaitCursor;
@@ -225,7 +324,8 @@ public sealed class AddContainerForm : Form
system.SonicConnectionId,
_txtName.Text,
_txtDisplay.Text,
timeout);
timeout,
checkUrl);
CreatedSonicContainerId = _existing.SonicContainerId;
}
@@ -237,7 +337,8 @@ public sealed class AddContainerForm : Form
system.SonicConnectionId,
_txtName.Text,
_txtDisplay.Text,
timeout);
timeout,
checkUrl);
}
DialogResult = DialogResult.OK;
@@ -8,6 +8,7 @@ public sealed class AddCredentialProfileForm : Form
{
private readonly SetupCoordinator _coordinator;
private readonly SonicSystemOption _system;
private readonly SonicCredentialProfile? _existing;
private readonly TextBox _txtProfileName;
private readonly TextBox _txtUserName;
@@ -16,6 +17,7 @@ public sealed class AddCredentialProfileForm : Form
private readonly CheckBox _chkDefault;
private readonly Button _btnSave;
private readonly Button _btnCancel;
private readonly Label _lblPasswordHint;
private bool _operationRunning;
@@ -25,9 +27,12 @@ public sealed class AddCredentialProfileForm : Form
private set;
}
public bool IsEditMode => _existing is not null;
public AddCredentialProfileForm(
SetupCoordinator coordinator,
SonicSystemOption system)
SonicSystemOption system,
SonicCredentialProfile? existing = null)
{
_coordinator =
coordinator
@@ -39,13 +44,17 @@ public sealed class AddCredentialProfileForm : Form
?? throw new ArgumentNullException(
nameof(system));
Text = "Benutzerprofil hinzufügen";
_existing = existing;
Text = IsEditMode
? "Benutzerprofil bearbeiten"
: "Benutzerprofil hinzufügen";
StartPosition =
FormStartPosition.CenterParent;
ClientSize =
new Size(560, 525);
new Size(560, 545);
FormBorderStyle =
FormBorderStyle.FixedDialog;
@@ -65,8 +74,9 @@ public sealed class AddCredentialProfileForm : Form
Label title = new()
{
Text =
$"Profil für {_system.ConnectionName}",
Text = IsEditMode
? $"Profil bearbeiten · {_system.ConnectionName}"
: $"Profil für {_system.ConnectionName}",
Location =
new Point(28, 22),
@@ -112,7 +122,7 @@ public sealed class AddCredentialProfileForm : Form
CreateTextBox(185);
_txtProfileName.Text =
"Administrator";
_existing?.CredentialName ?? "Administrator";
Label userLabel =
CreateLabel(
@@ -123,7 +133,7 @@ public sealed class AddCredentialProfileForm : Form
CreateTextBox(250);
_txtUserName.Text =
"Administrator";
_existing?.UserName ?? "Administrator";
Label passwordLabel =
CreateLabel(
@@ -136,13 +146,25 @@ public sealed class AddCredentialProfileForm : Form
_txtPassword.UseSystemPasswordChar =
true;
_lblPasswordHint = new Label
{
Text = IsEditMode
? "Leer lassen = bisheriges Kennwort behalten"
: string.Empty,
Location = new Point(30, 343),
AutoSize = true,
ForeColor = Color.FromArgb(169, 184, 200),
Font = new Font("Segoe UI", 8.5f)
};
Label repeatLabel =
CreateLabel(
"Kennwort wiederholen",
355);
365);
_txtPasswordRepeat =
CreateTextBox(380);
CreateTextBox(390);
_txtPasswordRepeat.UseSystemPasswordChar =
true;
@@ -153,10 +175,10 @@ public sealed class AddCredentialProfileForm : Form
"Als Standardprofil verwenden",
Location =
new Point(30, 425),
new Point(30, 435),
AutoSize = true,
Checked = true,
Checked = _existing?.IsDefault ?? true,
ForeColor =
Color.FromArgb(241, 245, 249)
@@ -167,7 +189,7 @@ public sealed class AddCredentialProfileForm : Form
Text = "Abbrechen",
Location =
new Point(125, 465),
new Point(125, 480),
Size =
new Size(110, 38),
@@ -189,11 +211,12 @@ public sealed class AddCredentialProfileForm : Form
_btnSave = new Button
{
Text =
"Verbindung prüfen und hinzufügen",
Text = IsEditMode
? "Prüfen und speichern"
: "Verbindung prüfen und hinzufügen",
Location =
new Point(245, 465),
new Point(245, 480),
Size =
new Size(280, 38),
@@ -228,6 +251,7 @@ public sealed class AddCredentialProfileForm : Form
Controls.Add(_txtUserName);
Controls.Add(passwordLabel);
Controls.Add(_txtPassword);
Controls.Add(_lblPasswordHint);
Controls.Add(repeatLabel);
Controls.Add(_txtPasswordRepeat);
Controls.Add(_chkDefault);
@@ -328,7 +352,7 @@ public sealed class AddCredentialProfileForm : Form
return;
}
if (string.IsNullOrEmpty(password))
if (!IsEditMode && string.IsNullOrEmpty(password))
{
ShowWarning("Kennwort fehlt.");
@@ -344,7 +368,8 @@ public sealed class AddCredentialProfileForm : Form
return;
}
if (!string.Equals(
if (!string.IsNullOrEmpty(password)
&& !string.Equals(
password,
passwordRepeat,
StringComparison.Ordinal))
@@ -372,13 +397,27 @@ public sealed class AddCredentialProfileForm : Form
try
{
CreatedProfile =
await _coordinator.AddCredentialAsync(
_system,
profileName,
userName,
password,
_chkDefault.Checked);
if (IsEditMode && _existing is not null)
{
CreatedProfile =
await _coordinator.UpdateCredentialAsync(
_system,
_existing,
profileName,
userName,
password,
_chkDefault.Checked);
}
else
{
CreatedProfile =
await _coordinator.TestAndAddCredentialAsync(
_system,
profileName,
userName,
password,
_chkDefault.Checked);
}
DialogResult = DialogResult.OK;
Close();
@@ -391,7 +430,11 @@ public sealed class AddCredentialProfileForm : Form
{
MessageBox.Show(
this,
"Profil konnte nicht angelegt werden.",
string.IsNullOrWhiteSpace(exception.Message)
? (IsEditMode
? "Profil konnte nicht aktualisiert werden."
: "Profil konnte nicht angelegt werden.")
: exception.Message,
"Benutzerprofil",
MessageBoxButtons.OK,
MessageBoxIcon.Error);
@@ -423,7 +466,9 @@ public sealed class AddCredentialProfileForm : Form
_btnSave.Text =
isRunning
? "Verbindung wird geprüft ..."
: "Verbindung prüfen und hinzufügen";
: IsEditMode
? "Prüfen und speichern"
: "Verbindung prüfen und hinzufügen";
}
private void ShowWarning(string message)
@@ -435,4 +480,4 @@ public sealed class AddCredentialProfileForm : Form
MessageBoxButtons.OK,
MessageBoxIcon.Warning);
}
}
}
@@ -207,7 +207,10 @@ public sealed class AddTargetPathForm : Form
if (!_lastProbe.Success)
{
_lblProbeResult.ForeColor = Color.FromArgb(220, 100, 100);
_lblProbeResult.Text = _lastProbe.Message;
_lblProbeResult.Text = _lastProbe.AccessDenied
? CertificateProbeResult.AccessDeniedShortText
+ " – Anmeldung am Freigabe-Pfad erforderlich."
: _lastProbe.Message;
return;
}
@@ -160,6 +160,78 @@ public sealed class SetupCoordinator
return createdProfile;
}
public async Task<SonicCredentialProfile> UpdateCredentialAsync(
SonicSystemOption system,
SonicCredentialProfile existing,
string credentialName,
string userName,
string secret,
bool isDefault,
CancellationToken cancellationToken = default)
{
ArgumentNullException.ThrowIfNull(system);
ArgumentNullException.ThrowIfNull(existing);
if (system.SonicConnectionId <= 0
|| existing.SonicCredentialId <= 0)
{
throw new ArgumentException(
"Das ausgewählte Profil oder System ist ungültig.");
}
string passwordToStore =
string.IsNullOrEmpty(secret)
? existing.Secret
: secret;
CredentialTestResult testResult =
await _credentialTester.TestAsync(
system,
userName,
passwordToStore,
system.ValidationContainerName,
cancellationToken);
if (!testResult.Success)
{
throw new InvalidOperationException(
"Das Benutzerprofil wurde nicht gespeichert."
+ Environment.NewLine
+ Environment.NewLine
+ testResult.Message);
}
await _repository.UpdateCredentialAsync(
existing.SonicCredentialId,
system.SonicConnectionId,
credentialName,
userName,
passwordToStore,
isDefault,
cancellationToken);
IReadOnlyList<SonicCredentialProfile> profiles =
await _repository.GetCredentialsAsync(
system.SonicConnectionId,
cancellationToken);
SonicCredentialProfile? updated =
profiles.FirstOrDefault(
profile =>
profile.SonicCredentialId
== existing.SonicCredentialId);
if (updated is null)
{
throw new InvalidOperationException(
"Das Benutzerprofil wurde gespeichert, "
+ "konnte anschließend aber nicht geladen werden.");
}
return updated;
}
public async Task<SetupCheckResult> CheckAsync(
CancellationToken cancellationToken = default)
{
@@ -396,6 +468,7 @@ public sealed class SetupCoordinator
string containerName,
string? containerDisplayName,
int restartTimeoutSeconds,
string? certificateCheckUrl = null,
CancellationToken cancellationToken = default)
{
int id = await _setupRepository.AddSonicContainerAsync(
@@ -404,6 +477,7 @@ public sealed class SetupCoordinator
containerName,
containerDisplayName,
restartTimeoutSeconds,
certificateCheckUrl,
cancellationToken);
await EnsureExistsAsync(
@@ -520,6 +594,7 @@ public sealed class SetupCoordinator
string containerName,
string? containerDisplayName,
int restartTimeoutSeconds,
string? certificateCheckUrl = null,
CancellationToken cancellationToken = default)
{
await _setupRepository.UpdateSonicContainerAsync(
@@ -529,6 +604,7 @@ public sealed class SetupCoordinator
containerName,
containerDisplayName,
restartTimeoutSeconds,
certificateCheckUrl,
cancellationToken);
await EnsureExistsAsync(
@@ -36,6 +36,7 @@ public sealed class SetupWizardForm : Form
private Button _btnSaveSelection = null!;
private Button _btnFinish = null!;
private Button _btnAddCredential = null!;
private Button _btnEditCredential = null!;
private IReadOnlyList<SonicSystemOption> _systems = [];
private IReadOnlyList<SonicCredentialProfile> _profiles = [];
@@ -385,11 +386,12 @@ public sealed class SetupWizardForm : Form
_lvContainers = SettingsUi.CreateListView();
_lvContainers.Dock = DockStyle.Fill;
_lvContainers.Columns.Add("Company", 80);
_lvContainers.Columns.Add("Container", 180);
_lvContainers.Columns.Add("Anzeige", 160);
_lvContainers.Columns.Add("System", 160);
_lvContainers.Columns.Add("Timeout", 90);
_lvContainers.Columns.Add("Company", 70);
_lvContainers.Columns.Add("Container", 150);
_lvContainers.Columns.Add("Anzeige", 120);
_lvContainers.Columns.Add("System", 120);
_lvContainers.Columns.Add("Prüf-URL", 180);
_lvContainers.Columns.Add("Timeout", 80);
_lvContainers.DoubleClick += async (_, _) => await EditSelectedContainerAsync();
FinishPanelLayout(_panelContainers, _lvContainers, toolbar);
@@ -484,6 +486,12 @@ public sealed class SetupWizardForm : Form
_btnAddCredential.Click += async (_, _) =>
await AddCredentialAsync();
_btnEditCredential = SettingsUi.CreateGhostButton("Profil bearbeiten");
_btnEditCredential.Location = new Point(550, 122);
_btnEditCredential.Size = new Size(160, 34);
_btnEditCredential.Click += async (_, _) =>
await EditCredentialAsync();
_lblSystemDetails = new Label
{
Location = new Point(24, 180),
@@ -502,6 +510,7 @@ public sealed class SetupWizardForm : Form
card.Controls.Add(credentialLabel);
card.Controls.Add(_cmbCredential);
card.Controls.Add(_btnAddCredential);
card.Controls.Add(_btnEditCredential);
card.Controls.Add(_lblSystemDetails);
card.Controls.Add(_btnSaveSelection);
@@ -625,6 +634,10 @@ public sealed class SetupWizardForm : Form
item.SubItems.Add(container.ContainerName);
item.SubItems.Add(container.ContainerDisplayName ?? "—");
item.SubItems.Add(container.ConnectionName);
item.SubItems.Add(
string.IsNullOrWhiteSpace(container.CertificateCheckUrl)
? "—"
: container.CertificateCheckUrl);
item.SubItems.Add(container.RestartTimeoutSeconds + " s");
item.Tag = container;
_lvContainers.Items.Add(item);
@@ -722,7 +735,12 @@ public sealed class SetupWizardForm : Form
return "Kennwort nötig";
}
return result.Success ? "fehlt" : "n/a";
if (result.AccessDenied)
{
return CertificateProbeResult.AccessDeniedShortText;
}
return result.Success ? "fehlt" : "nicht erreichbar";
}
private static string? PromptCertificatePassword(IWin32Window owner)
@@ -1228,19 +1246,9 @@ public sealed class SetupWizardForm : Form
}
await SystemChangedAsync();
SelectCredential(dialog.CreatedProfile.SonicCredentialId);
for (int index = 0; index < _cmbCredential.Items.Count; index++)
{
if (_cmbCredential.Items[index] is SonicCredentialProfile profile
&& profile.SonicCredentialId
== dialog.CreatedProfile.SonicCredentialId)
{
_cmbCredential.SelectedIndex = index;
break;
}
}
MessageBox.Show(
MessageBox.Show(
this,
"Profil geladen.",
"Benutzerprofil",
@@ -1248,6 +1256,53 @@ public sealed class SetupWizardForm : Form
MessageBoxIcon.Information);
}
private async Task EditCredentialAsync()
{
if (_cmbSystem.SelectedItem is not SonicSystemOption system)
{
ShowWarning("Bitte System wählen.");
return;
}
if (_cmbCredential.SelectedItem is not SonicCredentialProfile profile)
{
ShowWarning("Bitte Profil wählen.");
return;
}
using AddCredentialProfileForm dialog =
new(_coordinator, system, profile);
if (dialog.ShowDialog(this) != DialogResult.OK
|| dialog.CreatedProfile is null)
{
return;
}
await SystemChangedAsync();
SelectCredential(dialog.CreatedProfile.SonicCredentialId);
MessageBox.Show(
this,
"Profil aktualisiert.",
"Benutzerprofil",
MessageBoxButtons.OK,
MessageBoxIcon.Information);
}
private void SelectCredential(int sonicCredentialId)
{
for (int index = 0; index < _cmbCredential.Items.Count; index++)
{
if (_cmbCredential.Items[index] is SonicCredentialProfile profile
&& profile.SonicCredentialId == sonicCredentialId)
{
_cmbCredential.SelectedIndex = index;
break;
}
}
}
private async Task SystemChangedAsync()
{
if (_cmbSystem.SelectedItem is not SonicSystemOption system)
@@ -1275,9 +1330,12 @@ public sealed class SetupWizardForm : Form
Environment.NewLine
+ "Noch kein Benutzerprofil — bitte hinzufügen.";
_btnSaveSelection.Enabled = false;
_btnEditCredential.Enabled = false;
return;
}
_btnEditCredential.Enabled = true;
_btnSaveSelection.Enabled = true;
LocalSetupSelection? selection = _coordinator.LoadSelection();
@@ -0,0 +1,34 @@
# Management Application API (Javadoc)
Heruntergeladen von der öffentlichen Progress-Sonic-Dokumentation:
**Quelle:** https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/
**Lokal:** `doc-10.0.10/Docs2017/api/mgmt_api/index.html`
Version der Javadoc: Sonic **8.5.0** (2011). Klassen/Package-Namen stimmen mit den Client-JARs überein; bei MQ 10 kann die Signatur im Detail abweichen, das Connect-Muster ist dasselbe.
## Direkt die für uns relevanten Klassen
| Klasse | Lokale Datei |
|--------|----------------|
| `JMSConnectorAddress` | `mgmt_api/com/sonicsw/mf/jmx/client/JMSConnectorAddress.html` |
| `JMSConnectorClient` | `mgmt_api/com/sonicsw/mf/jmx/client/JMSConnectorClient.html` |
| `MFProxyFactory` | `mgmt_api/com/sonicsw/mf/mgmtapi/runtime/MFProxyFactory.html` |
| `IAgentProxy` | `mgmt_api/com/sonicsw/mf/mgmtapi/runtime/IAgentProxy.html` |
## Öffnen
Doppelklick auf:
```text
doc-10.0.10\Docs2017\api\mgmt_api\index.html
```
Oder im Index der CX-Messenger-Doku:
```text
doc-10.0.10\CXMessenger_2017_R3.htm
```
→ Link **Management Application API Reference** (zeigt jetzt auf diesen Ordner).
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,245 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:16 EDT 2011 -->
<TITLE>
AttributeNotFoundException (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config.AttributeNotFoundException class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="AttributeNotFoundException (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="AttributeNotFoundException.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252FAttributeNotFoundException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="AttributeNotFoundException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="AttributeNotFoundException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="AttributeNotFoundException.html#methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.MgmtException">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="AttributeNotFoundException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.ma.mgmtapi.config</FONT>
<BR>
Class AttributeNotFoundException</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">com.sonicsw.ma.mgmtapi.config.MgmtException</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.ma.mgmtapi.config.AttributeNotFoundException</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>AttributeNotFoundException</B><DT>extends <A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></DL>
</PRE>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#com.sonicsw.ma.mgmtapi.config.AttributeNotFoundException">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="AttributeNotFoundException.html#AttributeNotFoundException(java.lang.String)">AttributeNotFoundException</A></B>(java.lang.String&nbsp;text)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.MgmtException"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.sonicsw.ma.mgmtapi.config.<A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="MgmtException.html#getLinkedException()">getLinkedException</A>, <A HREF="MgmtException.html#setLinkedException(java.lang.Throwable)">setLinkedException</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="AttributeNotFoundException(java.lang.String)"><!-- --></A><H3>
AttributeNotFoundException</H3>
<PRE>
public <B>AttributeNotFoundException</B>(java.lang.String&nbsp;text)</PRE>
<DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="AttributeNotFoundException.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252FAttributeNotFoundException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="AttributeNotFoundException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="AttributeNotFoundException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="AttributeNotFoundException.html#methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.MgmtException">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="AttributeNotFoundException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,251 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:16 EDT 2011 -->
<TITLE>
IMgmtAttributeMetaData (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config.IMgmtAttributeMetaData interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IMgmtAttributeMetaData (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IMgmtAttributeMetaData.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="AttributeNotFoundException.html" title="class in com.sonicsw.ma.mgmtapi.config"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252FIMgmtAttributeMetaData.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMgmtAttributeMetaData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMgmtAttributeMetaData.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMgmtAttributeMetaData.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.ma.mgmtapi.config</FONT>
<BR>
Interface IMgmtAttributeMetaData</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="impl/MgmtAttributeMetaData.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtAttributeMetaData</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IMgmtAttributeMetaData</B></DL>
</PRE>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMgmtAttributeMetaData.html#isFromBean()">isFromBean</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMgmtAttributeMetaData.html#isFromTemplate()">isFromTemplate</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMgmtAttributeMetaData.html#isFromType()">isFromType</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="isFromBean()"><!-- --></A><H3>
isFromBean</H3>
<PRE>
boolean <B>isFromBean</B>()
throws <A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="isFromTemplate()"><!-- --></A><H3>
isFromTemplate</H3>
<PRE>
boolean <B>isFromTemplate</B>()
throws <A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="isFromType()"><!-- --></A><H3>
isFromType</H3>
<PRE>
boolean <B>isFromType</B>()
throws <A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IMgmtAttributeMetaData.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="AttributeNotFoundException.html" title="class in com.sonicsw.ma.mgmtapi.config"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252FIMgmtAttributeMetaData.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMgmtAttributeMetaData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMgmtAttributeMetaData.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMgmtAttributeMetaData.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,311 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:17 EDT 2011 -->
<TITLE>
IMgmtListBase (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config.IMgmtListBase interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IMgmtListBase (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IMgmtListBase.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMgmtBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMgmtMapBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252FIMgmtListBase.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMgmtListBase.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMgmtListBase.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMgmtListBase.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.ma.mgmtapi.config</FONT>
<BR>
Interface IMgmtListBase</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>, <A HREF="IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></DD>
</DL>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../mf/mgmtapi/config/gen/IAbstractCollectionsMonitorBean.IAbstractCollectionList.html" title="interface in com.sonicsw.mf.mgmtapi.config.gen">IAbstractCollectionsMonitorBean.IAbstractCollectionList</A>, <A HREF="../../../mf/mgmtapi/config/gen/IAbstractComponentCollectionBean.IAbstractMetricListType.html" title="interface in com.sonicsw.mf.mgmtapi.config.gen">IAbstractComponentCollectionBean.IAbstractMetricListType</A>, <A HREF="../../../mf/mgmtapi/config/gen/IAbstractComponentCollectionBean.IAbstractNotifList.html" title="interface in com.sonicsw.mf.mgmtapi.config.gen">IAbstractComponentCollectionBean.IAbstractNotifList</A>, <A HREF="../../../mf/mgmtapi/config/gen/IAbstractComponentCollectionBean.IAbstractNotifListType.html" title="interface in com.sonicsw.mf.mgmtapi.config.gen">IAbstractComponentCollectionBean.IAbstractNotifListType</A>, <A HREF="../../../mf/mgmtapi/config/ICollectionsMonitorBean.ICollectionList.html" title="interface in com.sonicsw.mf.mgmtapi.config">ICollectionsMonitorBean.ICollectionList</A>, <A HREF="../../../mf/mgmtapi/config/IComponentCollectionBean.IMetricListType.html" title="interface in com.sonicsw.mf.mgmtapi.config">IComponentCollectionBean.IMetricListType</A>, <A HREF="../../../mf/mgmtapi/config/IComponentCollectionBean.INotifList.html" title="interface in com.sonicsw.mf.mgmtapi.config">IComponentCollectionBean.INotifList</A>, <A HREF="../../../mf/mgmtapi/config/IComponentCollectionBean.INotifListType.html" title="interface in com.sonicsw.mf.mgmtapi.config">IComponentCollectionBean.INotifListType</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="impl/MgmtListBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtListBase</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IMgmtListBase</B><DT>extends <A HREF="IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></DL>
</PRE>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMgmtListBase.html#add(java.lang.Object)">add</A></B>(java.lang.Object&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMgmtListBase.html#delete(int)">delete</A></B>(int&nbsp;index)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMgmtListBase.html#getCount()">getCount</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMgmtListBase.html#insert(int, java.lang.Object)">insert</A></B>(int&nbsp;index,
java.lang.Object&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.IMgmtSubBeanBase"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.ma.mgmtapi.config.<A HREF="IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="IMgmtSubBeanBase.html#getBigDecimalAttribute(java.lang.String)">getBigDecimalAttribute</A>, <A HREF="IMgmtSubBeanBase.html#getBooleanAttribute(java.lang.String)">getBooleanAttribute</A>, <A HREF="IMgmtSubBeanBase.html#getByteArrayAttribute(java.lang.String)">getByteArrayAttribute</A>, <A HREF="IMgmtSubBeanBase.html#getIntegerAttribute(java.lang.String)">getIntegerAttribute</A>, <A HREF="IMgmtSubBeanBase.html#getLongAttribute(java.lang.String)">getLongAttribute</A>, <A HREF="IMgmtSubBeanBase.html#getReferenceAttribute(java.lang.String)">getReferenceAttribute</A>, <A HREF="IMgmtSubBeanBase.html#getStringAttribute(java.lang.String)">getStringAttribute</A>, <A HREF="IMgmtSubBeanBase.html#setBigDecimalAttribute(java.lang.String, java.math.BigDecimal)">setBigDecimalAttribute</A>, <A HREF="IMgmtSubBeanBase.html#setBooleanAttribute(java.lang.String, boolean)">setBooleanAttribute</A>, <A HREF="IMgmtSubBeanBase.html#setByteArrayAttribute(java.lang.String, byte[])">setByteArrayAttribute</A>, <A HREF="IMgmtSubBeanBase.html#setIntegerAttribute(java.lang.String, int)">setIntegerAttribute</A>, <A HREF="IMgmtSubBeanBase.html#setLongAttribute(java.lang.String, long)">setLongAttribute</A>, <A HREF="IMgmtSubBeanBase.html#setReferenceAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase)">setReferenceAttribute</A>, <A HREF="IMgmtSubBeanBase.html#setStringAttribute(java.lang.String, java.lang.String)">setStringAttribute</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.IMgmtBase"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.ma.mgmtapi.config.<A HREF="IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="IMgmtBase.html#getAttributeList()">getAttributeList</A>, <A HREF="IMgmtBase.html#getAttributeMap()">getAttributeMap</A>, <A HREF="IMgmtBase.html#getAttributeMetaData(java.lang.String)">getAttributeMetaData</A>, <A HREF="IMgmtBase.html#getConfigBean()">getConfigBean</A>, <A HREF="IMgmtBase.html#getConfigBeanName()">getConfigBeanName</A>, <A HREF="IMgmtBase.html#getConfigBeanNameTail()">getConfigBeanNameTail</A>, <A HREF="IMgmtBase.html#getConfigPath()">getConfigPath</A>, <A HREF="IMgmtBase.html#getConfigPath(java.lang.String)">getConfigPath</A>, <A HREF="IMgmtBase.html#getMgmtBeanFactory()">getMgmtBeanFactory</A>, <A HREF="IMgmtBase.html#getParent()">getParent</A>, <A HREF="IMgmtBase.html#removeAttribute(java.lang.String)">removeAttribute</A>, <A HREF="IMgmtBase.html#setAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBase)">setAttribute</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="add(java.lang.Object)"><!-- --></A><H3>
add</H3>
<PRE>
void <B>add</B>(java.lang.Object&nbsp;val)
throws <A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="delete(int)"><!-- --></A><H3>
delete</H3>
<PRE>
void <B>delete</B>(int&nbsp;index)
throws <A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getCount()"><!-- --></A><H3>
getCount</H3>
<PRE>
int <B>getCount</B>()
throws <A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="insert(int, java.lang.Object)"><!-- --></A><H3>
insert</H3>
<PRE>
void <B>insert</B>(int&nbsp;index,
java.lang.Object&nbsp;val)
throws <A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IMgmtListBase.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMgmtBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMgmtMapBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252FIMgmtListBase.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMgmtListBase.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMgmtListBase.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMgmtListBase.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,232 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:17 EDT 2011 -->
<TITLE>
MgmtBeanFactory (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config.MgmtBeanFactory class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="MgmtBeanFactory (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="MgmtBeanFactory.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252FMgmtBeanFactory.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MgmtBeanFactory.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtBeanFactory.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtBeanFactory.html#methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.impl.AbstractMgmtBeanFactory">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtBeanFactory.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.ma.mgmtapi.config</FONT>
<BR>
Class MgmtBeanFactory</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="impl/AbstractMgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">com.sonicsw.ma.mgmtapi.config.impl.AbstractMgmtBeanFactory</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.ma.mgmtapi.config.MgmtBeanFactory</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../mf/mgmtapi/config/gen/AbstractMFMgmtBeanFactory.html" title="class in com.sonicsw.mf.mgmtapi.config.gen">AbstractMFMgmtBeanFactory</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>MgmtBeanFactory</B><DT>extends <A HREF="impl/AbstractMgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">AbstractMgmtBeanFactory</A></DL>
</PRE>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MgmtBeanFactory.html#MgmtBeanFactory()">MgmtBeanFactory</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.impl.AbstractMgmtBeanFactory"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.sonicsw.ma.mgmtapi.config.impl.<A HREF="impl/AbstractMgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">AbstractMgmtBeanFactory</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="impl/AbstractMgmtBeanFactory.html#commit()">commit</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#connect(com.sonicsw.mf.common.IDirectoryFileSystemService)">connect</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#connect(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">connect</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#connect(com.sonicsw.mx.config.TxnConfigServerUtility)">connect</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#createBeanObject(com.sonicsw.mx.config.IConfigBean)">createBeanObject</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#createFolder(java.lang.String)">createFolder</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#createFolder(java.lang.String, java.util.Map)">createFolder</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#createUniqueName()">createUniqueName</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#deleteBean(com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase)">deleteBean</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#deleteBeans(com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase[])">deleteBeans</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#deleteFolder(java.lang.String)">deleteFolder</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#deleteFolderPath(java.lang.String)">deleteFolderPath</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#disconnect()">disconnect</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#doesConfigurationNameExist(java.lang.String, java.lang.String)">doesConfigurationNameExist</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#exportContainerBootConfiguration(com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase, java.lang.String)">exportContainerBootConfiguration</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#exportDSBootConfiguration(com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase)">exportDSBootConfiguration</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#flush()">flush</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#getBean(java.lang.String)">getBean</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#getConfigServer()">getConfigServer</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#getConfigServerUtility()">getConfigServerUtility</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#getConfigurationNames(java.lang.String)">getConfigurationNames</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#getConfigurations(java.lang.String)">getConfigurations</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#getDomain()">getDomain</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#getFolderNames(java.lang.String)">getFolderNames</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#getFolders(java.lang.String)">getFolders</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#list(java.lang.String)">list</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#listConfigElements(java.lang.String)">listConfigElements</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#listFolderElements(java.lang.String)">listFolderElements</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#listFolders(java.lang.String)">listFolders</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#loadBeansInDirectory(java.lang.String)">loadBeansInDirectory</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#lookupReference(java.lang.String, java.lang.String)">lookupReference</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#lookupValue(com.sonicsw.mx.config.IConfigBean, java.lang.Object)">lookupValue</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#lookupValue(java.lang.String, java.lang.String, java.lang.Object)">lookupValue</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#pathExists(java.lang.String)">pathExists</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#rollback()">rollback</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#saveBean(com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase)">saveBean</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#saveBeans(com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase[])">saveBeans</A>, <A HREF="impl/AbstractMgmtBeanFactory.html#setFolderMetaAttributes(java.lang.String, java.util.Map)">setFolderMetaAttributes</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="MgmtBeanFactory()"><!-- --></A><H3>
MgmtBeanFactory</H3>
<PRE>
public <B>MgmtBeanFactory</B>()</PRE>
<DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="MgmtBeanFactory.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252FMgmtBeanFactory.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MgmtBeanFactory.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtBeanFactory.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtBeanFactory.html#methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.impl.AbstractMgmtBeanFactory">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtBeanFactory.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,309 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:17 EDT 2011 -->
<TITLE>
MgmtException (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config.MgmtException class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="MgmtException (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="MgmtException.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="MgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252FMgmtException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MgmtException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtException.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtException.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.ma.mgmtapi.config</FONT>
<BR>
Class MgmtException</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.ma.mgmtapi.config.MgmtException</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="AttributeNotFoundException.html" title="class in com.sonicsw.ma.mgmtapi.config">AttributeNotFoundException</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>MgmtException</B><DT>extends java.lang.Exception</DL>
</PRE>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#com.sonicsw.ma.mgmtapi.config.MgmtException">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MgmtException.html#MgmtException(java.lang.String)">MgmtException</A></B>(java.lang.String&nbsp;text)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MgmtException.html#MgmtException(java.lang.String, java.lang.Throwable)">MgmtException</A></B>(java.lang.String&nbsp;text,
java.lang.Throwable&nbsp;linked)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Throwable</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtException.html#getLinkedException()">getLinkedException</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the cause of this throwable or <code>null</code> if the
cause is nonexistent or unknown.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtException.html#setLinkedException(java.lang.Throwable)">setLinkedException</A></B>(java.lang.Throwable&nbsp;e)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the cause of this throwable.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="MgmtException(java.lang.String)"><!-- --></A><H3>
MgmtException</H3>
<PRE>
public <B>MgmtException</B>(java.lang.String&nbsp;text)</PRE>
<DL>
</DL>
<HR>
<A NAME="MgmtException(java.lang.String, java.lang.Throwable)"><!-- --></A><H3>
MgmtException</H3>
<PRE>
public <B>MgmtException</B>(java.lang.String&nbsp;text,
java.lang.Throwable&nbsp;linked)</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getLinkedException()"><!-- --></A><H3>
getLinkedException</H3>
<PRE>
public java.lang.Throwable <B>getLinkedException</B>()</PRE>
<DL>
<DD>Returns the cause of this throwable or <code>null</code> if the
cause is nonexistent or unknown. (The cause is the exception that
caused this exception to get thrown.)
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setLinkedException(java.lang.Throwable)"><!-- --></A><H3>
setLinkedException</H3>
<PRE>
public void <B>setLinkedException</B>(java.lang.Throwable&nbsp;e)</PRE>
<DL>
<DD>Sets the cause of this throwable. (The cause is the exception that
caused this exception to get thrown.)
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="MgmtException.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="MgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252FMgmtException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MgmtException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtException.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtException.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,306 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:18 EDT 2011 -->
<TITLE>
MgmtAttributeMetaData (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config.impl.MgmtAttributeMetaData class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="MgmtAttributeMetaData (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="MgmtAttributeMetaData.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="AbstractMgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="MgmtBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fimpl%252FMgmtAttributeMetaData.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MgmtAttributeMetaData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtAttributeMetaData.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtAttributeMetaData.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtAttributeMetaData.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtAttributeMetaData.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.ma.mgmtapi.config.impl</FONT>
<BR>
Class MgmtAttributeMetaData</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.ma.mgmtapi.config.impl.MgmtAttributeMetaData</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtAttributeMetaData</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>MgmtAttributeMetaData</B><DT>extends java.lang.Object<DT>implements <A HREF="../IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtAttributeMetaData</A></DL>
</PRE>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MgmtAttributeMetaData.html#MgmtAttributeMetaData(com.sonicsw.mx.config.IAttributeMetaData)">MgmtAttributeMetaData</A></B>(com.sonicsw.mx.config.IAttributeMetaData&nbsp;data)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtAttributeMetaData.html#isFromBean()">isFromBean</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtAttributeMetaData.html#isFromTemplate()">isFromTemplate</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtAttributeMetaData.html#isFromType()">isFromType</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="MgmtAttributeMetaData(com.sonicsw.mx.config.IAttributeMetaData)"><!-- --></A><H3>
MgmtAttributeMetaData</H3>
<PRE>
public <B>MgmtAttributeMetaData</B>(com.sonicsw.mx.config.IAttributeMetaData&nbsp;data)</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="isFromBean()"><!-- --></A><H3>
isFromBean</H3>
<PRE>
public boolean <B>isFromBean</B>()
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtAttributeMetaData.html#isFromBean()">isFromBean</A></CODE> in interface <CODE><A HREF="../IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtAttributeMetaData</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="isFromTemplate()"><!-- --></A><H3>
isFromTemplate</H3>
<PRE>
public boolean <B>isFromTemplate</B>()
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtAttributeMetaData.html#isFromTemplate()">isFromTemplate</A></CODE> in interface <CODE><A HREF="../IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtAttributeMetaData</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="isFromType()"><!-- --></A><H3>
isFromType</H3>
<PRE>
public boolean <B>isFromType</B>()
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtAttributeMetaData.html#isFromType()">isFromType</A></CODE> in interface <CODE><A HREF="../IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtAttributeMetaData</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="MgmtAttributeMetaData.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="AbstractMgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="MgmtBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fimpl%252FMgmtAttributeMetaData.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MgmtAttributeMetaData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtAttributeMetaData.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtAttributeMetaData.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtAttributeMetaData.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtAttributeMetaData.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,370 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:18 EDT 2011 -->
<TITLE>
MgmtListBase (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config.impl.MgmtListBase class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="MgmtListBase (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="MgmtListBase.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="MgmtBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="MgmtMapBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fimpl%252FMgmtListBase.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MgmtListBase.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtListBase.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtListBase.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtListBase.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtListBase.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.ma.mgmtapi.config.impl</FONT>
<BR>
Class MgmtListBase</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="MgmtSubBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">com.sonicsw.ma.mgmtapi.config.impl.MgmtSubBeanBase</A>
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.ma.mgmtapi.config.impl.MgmtListBase</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>, <A HREF="../IMgmtListBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtListBase</A>, <A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>MgmtListBase</B><DT>extends <A HREF="MgmtSubBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtSubBeanBase</A><DT>implements <A HREF="../IMgmtListBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtListBase</A></DL>
</PRE>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MgmtListBase.html#MgmtListBase(com.sonicsw.ma.mgmtapi.config.IMgmtBase, java.lang.String, boolean)">MgmtListBase</A></B>(<A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>&nbsp;parent,
java.lang.String&nbsp;name,
boolean&nbsp;isNew)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtListBase.html#add(java.lang.Object)">add</A></B>(java.lang.Object&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtListBase.html#delete(int)">delete</A></B>(int&nbsp;index)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtListBase.html#getCount()">getCount</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtListBase.html#insert(int, java.lang.Object)">insert</A></B>(int&nbsp;index,
java.lang.Object&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.impl.MgmtSubBeanBase"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.sonicsw.ma.mgmtapi.config.impl.<A HREF="MgmtSubBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtSubBeanBase</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="MgmtSubBeanBase.html#getAttributeList()">getAttributeList</A>, <A HREF="MgmtSubBeanBase.html#getAttributeMap()">getAttributeMap</A>, <A HREF="MgmtSubBeanBase.html#getAttributeMetaData(java.lang.String)">getAttributeMetaData</A>, <A HREF="MgmtSubBeanBase.html#getBigDecimalAttribute(java.lang.String)">getBigDecimalAttribute</A>, <A HREF="MgmtSubBeanBase.html#getBooleanAttribute(java.lang.String)">getBooleanAttribute</A>, <A HREF="MgmtSubBeanBase.html#getByteArrayAttribute(java.lang.String)">getByteArrayAttribute</A>, <A HREF="MgmtSubBeanBase.html#getConfigBean()">getConfigBean</A>, <A HREF="MgmtSubBeanBase.html#getConfigBeanName()">getConfigBeanName</A>, <A HREF="MgmtSubBeanBase.html#getConfigBeanNameTail()">getConfigBeanNameTail</A>, <A HREF="MgmtSubBeanBase.html#getConfigPath()">getConfigPath</A>, <A HREF="MgmtSubBeanBase.html#getConfigPath(java.lang.String)">getConfigPath</A>, <A HREF="MgmtSubBeanBase.html#getIntegerAttribute(java.lang.String)">getIntegerAttribute</A>, <A HREF="MgmtSubBeanBase.html#getLongAttribute(java.lang.String)">getLongAttribute</A>, <A HREF="MgmtSubBeanBase.html#getMgmtBeanFactory()">getMgmtBeanFactory</A>, <A HREF="MgmtSubBeanBase.html#getParent()">getParent</A>, <A HREF="MgmtSubBeanBase.html#getReferenceAttribute(java.lang.String)">getReferenceAttribute</A>, <A HREF="MgmtSubBeanBase.html#getStringAttribute(java.lang.String)">getStringAttribute</A>, <A HREF="MgmtSubBeanBase.html#removeAttribute(java.lang.String)">removeAttribute</A>, <A HREF="MgmtSubBeanBase.html#setAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBase)">setAttribute</A>, <A HREF="MgmtSubBeanBase.html#setBigDecimalAttribute(java.lang.String, java.math.BigDecimal)">setBigDecimalAttribute</A>, <A HREF="MgmtSubBeanBase.html#setBooleanAttribute(java.lang.String, boolean)">setBooleanAttribute</A>, <A HREF="MgmtSubBeanBase.html#setByteArrayAttribute(java.lang.String, byte[])">setByteArrayAttribute</A>, <A HREF="MgmtSubBeanBase.html#setIntegerAttribute(java.lang.String, int)">setIntegerAttribute</A>, <A HREF="MgmtSubBeanBase.html#setLongAttribute(java.lang.String, long)">setLongAttribute</A>, <A HREF="MgmtSubBeanBase.html#setReferenceAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase)">setReferenceAttribute</A>, <A HREF="MgmtSubBeanBase.html#setStringAttribute(java.lang.String, java.lang.String)">setStringAttribute</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.IMgmtSubBeanBase"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.ma.mgmtapi.config.<A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../IMgmtSubBeanBase.html#getBigDecimalAttribute(java.lang.String)">getBigDecimalAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#getBooleanAttribute(java.lang.String)">getBooleanAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#getByteArrayAttribute(java.lang.String)">getByteArrayAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#getIntegerAttribute(java.lang.String)">getIntegerAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#getLongAttribute(java.lang.String)">getLongAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#getReferenceAttribute(java.lang.String)">getReferenceAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#getStringAttribute(java.lang.String)">getStringAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setBigDecimalAttribute(java.lang.String, java.math.BigDecimal)">setBigDecimalAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setBooleanAttribute(java.lang.String, boolean)">setBooleanAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setByteArrayAttribute(java.lang.String, byte[])">setByteArrayAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setIntegerAttribute(java.lang.String, int)">setIntegerAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setLongAttribute(java.lang.String, long)">setLongAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setReferenceAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase)">setReferenceAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setStringAttribute(java.lang.String, java.lang.String)">setStringAttribute</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.IMgmtBase"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.ma.mgmtapi.config.<A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../IMgmtBase.html#getAttributeList()">getAttributeList</A>, <A HREF="../IMgmtBase.html#getAttributeMap()">getAttributeMap</A>, <A HREF="../IMgmtBase.html#getAttributeMetaData(java.lang.String)">getAttributeMetaData</A>, <A HREF="../IMgmtBase.html#getConfigBean()">getConfigBean</A>, <A HREF="../IMgmtBase.html#getConfigBeanName()">getConfigBeanName</A>, <A HREF="../IMgmtBase.html#getConfigBeanNameTail()">getConfigBeanNameTail</A>, <A HREF="../IMgmtBase.html#getConfigPath()">getConfigPath</A>, <A HREF="../IMgmtBase.html#getConfigPath(java.lang.String)">getConfigPath</A>, <A HREF="../IMgmtBase.html#getMgmtBeanFactory()">getMgmtBeanFactory</A>, <A HREF="../IMgmtBase.html#getParent()">getParent</A>, <A HREF="../IMgmtBase.html#removeAttribute(java.lang.String)">removeAttribute</A>, <A HREF="../IMgmtBase.html#setAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBase)">setAttribute</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="MgmtListBase(com.sonicsw.ma.mgmtapi.config.IMgmtBase, java.lang.String, boolean)"><!-- --></A><H3>
MgmtListBase</H3>
<PRE>
public <B>MgmtListBase</B>(<A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>&nbsp;parent,
java.lang.String&nbsp;name,
boolean&nbsp;isNew)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="add(java.lang.Object)"><!-- --></A><H3>
add</H3>
<PRE>
public void <B>add</B>(java.lang.Object&nbsp;val)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtListBase.html#add(java.lang.Object)">add</A></CODE> in interface <CODE><A HREF="../IMgmtListBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtListBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="delete(int)"><!-- --></A><H3>
delete</H3>
<PRE>
public void <B>delete</B>(int&nbsp;index)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtListBase.html#delete(int)">delete</A></CODE> in interface <CODE><A HREF="../IMgmtListBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtListBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getCount()"><!-- --></A><H3>
getCount</H3>
<PRE>
public int <B>getCount</B>()
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtListBase.html#getCount()">getCount</A></CODE> in interface <CODE><A HREF="../IMgmtListBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtListBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="insert(int, java.lang.Object)"><!-- --></A><H3>
insert</H3>
<PRE>
public void <B>insert</B>(int&nbsp;index,
java.lang.Object&nbsp;val)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtListBase.html#insert(int, java.lang.Object)">insert</A></CODE> in interface <CODE><A HREF="../IMgmtListBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtListBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="MgmtListBase.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="MgmtBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="MgmtMapBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fimpl%252FMgmtListBase.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MgmtListBase.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtListBase.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtListBase.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtListBase.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtListBase.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,345 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:18 EDT 2011 -->
<TITLE>
MgmtMapBase (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config.impl.MgmtMapBase class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="MgmtMapBase (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="MgmtMapBase.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="MgmtListBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="MgmtSubBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fimpl%252FMgmtMapBase.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MgmtMapBase.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtMapBase.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtMapBase.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtMapBase.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtMapBase.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.ma.mgmtapi.config.impl</FONT>
<BR>
Class MgmtMapBase</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="MgmtSubBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">com.sonicsw.ma.mgmtapi.config.impl.MgmtSubBeanBase</A>
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.ma.mgmtapi.config.impl.MgmtMapBase</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>, <A HREF="../IMgmtMapBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtMapBase</A>, <A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>MgmtMapBase</B><DT>extends <A HREF="MgmtSubBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtSubBeanBase</A><DT>implements <A HREF="../IMgmtMapBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtMapBase</A></DL>
</PRE>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MgmtMapBase.html#MgmtMapBase(com.sonicsw.ma.mgmtapi.config.IMgmtBase, java.lang.String, boolean)">MgmtMapBase</A></B>(<A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>&nbsp;parent,
java.lang.String&nbsp;name,
boolean&nbsp;isNew)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtMapBase.html#add(java.lang.String, java.lang.Object)">add</A></B>(java.lang.String&nbsp;name,
java.lang.Object&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtMapBase.html#delete(java.lang.String)">delete</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtMapBase.html#getKeyNames()">getKeyNames</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.impl.MgmtSubBeanBase"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.sonicsw.ma.mgmtapi.config.impl.<A HREF="MgmtSubBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtSubBeanBase</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="MgmtSubBeanBase.html#getAttributeList()">getAttributeList</A>, <A HREF="MgmtSubBeanBase.html#getAttributeMap()">getAttributeMap</A>, <A HREF="MgmtSubBeanBase.html#getAttributeMetaData(java.lang.String)">getAttributeMetaData</A>, <A HREF="MgmtSubBeanBase.html#getBigDecimalAttribute(java.lang.String)">getBigDecimalAttribute</A>, <A HREF="MgmtSubBeanBase.html#getBooleanAttribute(java.lang.String)">getBooleanAttribute</A>, <A HREF="MgmtSubBeanBase.html#getByteArrayAttribute(java.lang.String)">getByteArrayAttribute</A>, <A HREF="MgmtSubBeanBase.html#getConfigBean()">getConfigBean</A>, <A HREF="MgmtSubBeanBase.html#getConfigBeanName()">getConfigBeanName</A>, <A HREF="MgmtSubBeanBase.html#getConfigBeanNameTail()">getConfigBeanNameTail</A>, <A HREF="MgmtSubBeanBase.html#getConfigPath()">getConfigPath</A>, <A HREF="MgmtSubBeanBase.html#getConfigPath(java.lang.String)">getConfigPath</A>, <A HREF="MgmtSubBeanBase.html#getIntegerAttribute(java.lang.String)">getIntegerAttribute</A>, <A HREF="MgmtSubBeanBase.html#getLongAttribute(java.lang.String)">getLongAttribute</A>, <A HREF="MgmtSubBeanBase.html#getMgmtBeanFactory()">getMgmtBeanFactory</A>, <A HREF="MgmtSubBeanBase.html#getParent()">getParent</A>, <A HREF="MgmtSubBeanBase.html#getReferenceAttribute(java.lang.String)">getReferenceAttribute</A>, <A HREF="MgmtSubBeanBase.html#getStringAttribute(java.lang.String)">getStringAttribute</A>, <A HREF="MgmtSubBeanBase.html#removeAttribute(java.lang.String)">removeAttribute</A>, <A HREF="MgmtSubBeanBase.html#setAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBase)">setAttribute</A>, <A HREF="MgmtSubBeanBase.html#setBigDecimalAttribute(java.lang.String, java.math.BigDecimal)">setBigDecimalAttribute</A>, <A HREF="MgmtSubBeanBase.html#setBooleanAttribute(java.lang.String, boolean)">setBooleanAttribute</A>, <A HREF="MgmtSubBeanBase.html#setByteArrayAttribute(java.lang.String, byte[])">setByteArrayAttribute</A>, <A HREF="MgmtSubBeanBase.html#setIntegerAttribute(java.lang.String, int)">setIntegerAttribute</A>, <A HREF="MgmtSubBeanBase.html#setLongAttribute(java.lang.String, long)">setLongAttribute</A>, <A HREF="MgmtSubBeanBase.html#setReferenceAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase)">setReferenceAttribute</A>, <A HREF="MgmtSubBeanBase.html#setStringAttribute(java.lang.String, java.lang.String)">setStringAttribute</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.IMgmtSubBeanBase"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.ma.mgmtapi.config.<A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../IMgmtSubBeanBase.html#getBigDecimalAttribute(java.lang.String)">getBigDecimalAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#getBooleanAttribute(java.lang.String)">getBooleanAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#getByteArrayAttribute(java.lang.String)">getByteArrayAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#getIntegerAttribute(java.lang.String)">getIntegerAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#getLongAttribute(java.lang.String)">getLongAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#getReferenceAttribute(java.lang.String)">getReferenceAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#getStringAttribute(java.lang.String)">getStringAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setBigDecimalAttribute(java.lang.String, java.math.BigDecimal)">setBigDecimalAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setBooleanAttribute(java.lang.String, boolean)">setBooleanAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setByteArrayAttribute(java.lang.String, byte[])">setByteArrayAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setIntegerAttribute(java.lang.String, int)">setIntegerAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setLongAttribute(java.lang.String, long)">setLongAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setReferenceAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase)">setReferenceAttribute</A>, <A HREF="../IMgmtSubBeanBase.html#setStringAttribute(java.lang.String, java.lang.String)">setStringAttribute</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.ma.mgmtapi.config.IMgmtBase"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.ma.mgmtapi.config.<A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../IMgmtBase.html#getAttributeList()">getAttributeList</A>, <A HREF="../IMgmtBase.html#getAttributeMap()">getAttributeMap</A>, <A HREF="../IMgmtBase.html#getAttributeMetaData(java.lang.String)">getAttributeMetaData</A>, <A HREF="../IMgmtBase.html#getConfigBean()">getConfigBean</A>, <A HREF="../IMgmtBase.html#getConfigBeanName()">getConfigBeanName</A>, <A HREF="../IMgmtBase.html#getConfigBeanNameTail()">getConfigBeanNameTail</A>, <A HREF="../IMgmtBase.html#getConfigPath()">getConfigPath</A>, <A HREF="../IMgmtBase.html#getConfigPath(java.lang.String)">getConfigPath</A>, <A HREF="../IMgmtBase.html#getMgmtBeanFactory()">getMgmtBeanFactory</A>, <A HREF="../IMgmtBase.html#getParent()">getParent</A>, <A HREF="../IMgmtBase.html#removeAttribute(java.lang.String)">removeAttribute</A>, <A HREF="../IMgmtBase.html#setAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBase)">setAttribute</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="MgmtMapBase(com.sonicsw.ma.mgmtapi.config.IMgmtBase, java.lang.String, boolean)"><!-- --></A><H3>
MgmtMapBase</H3>
<PRE>
public <B>MgmtMapBase</B>(<A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>&nbsp;parent,
java.lang.String&nbsp;name,
boolean&nbsp;isNew)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="add(java.lang.String, java.lang.Object)"><!-- --></A><H3>
add</H3>
<PRE>
public void <B>add</B>(java.lang.String&nbsp;name,
java.lang.Object&nbsp;val)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtMapBase.html#add(java.lang.String, java.lang.Object)">add</A></CODE> in interface <CODE><A HREF="../IMgmtMapBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtMapBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="delete(java.lang.String)"><!-- --></A><H3>
delete</H3>
<PRE>
public void <B>delete</B>(java.lang.String&nbsp;name)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtMapBase.html#delete(java.lang.String)">delete</A></CODE> in interface <CODE><A HREF="../IMgmtMapBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtMapBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getKeyNames()"><!-- --></A><H3>
getKeyNames</H3>
<PRE>
public java.util.List <B>getKeyNames</B>()
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtMapBase.html#getKeyNames()">getKeyNames</A></CODE> in interface <CODE><A HREF="../IMgmtMapBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtMapBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="MgmtMapBase.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="MgmtListBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="MgmtSubBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fimpl%252FMgmtMapBase.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MgmtMapBase.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtMapBase.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtMapBase.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtMapBase.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtMapBase.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,882 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:18 EDT 2011 -->
<TITLE>
MgmtSubBeanBase (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config.impl.MgmtSubBeanBase class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="MgmtSubBeanBase (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="MgmtSubBeanBase.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="MgmtMapBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fimpl%252FMgmtSubBeanBase.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MgmtSubBeanBase.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtSubBeanBase.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtSubBeanBase.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtSubBeanBase.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtSubBeanBase.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.ma.mgmtapi.config.impl</FONT>
<BR>
Class MgmtSubBeanBase</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.ma.mgmtapi.config.impl.MgmtSubBeanBase</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>, <A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="MgmtListBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtListBase</A>, <A HREF="MgmtMapBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtMapBase</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>MgmtSubBeanBase</B><DT>extends java.lang.Object<DT>implements <A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></DL>
</PRE>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#MgmtSubBeanBase(com.sonicsw.ma.mgmtapi.config.IMgmtBase, java.lang.String, boolean)">MgmtSubBeanBase</A></B>(<A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>&nbsp;parent,
java.lang.String&nbsp;name,
boolean&nbsp;isNew)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;com.sonicsw.mx.config.IAttributeList</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getAttributeList()">getAttributeList</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;com.sonicsw.mx.config.IAttributeMap</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getAttributeMap()">getAttributeMap</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtAttributeMetaData</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getAttributeMetaData(java.lang.String)">getAttributeMetaData</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.math.BigDecimal</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getBigDecimalAttribute(java.lang.String)">getBigDecimalAttribute</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getBooleanAttribute(java.lang.String)">getBooleanAttribute</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getByteArrayAttribute(java.lang.String)">getByteArrayAttribute</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;com.sonicsw.mx.config.IConfigBean</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getConfigBean()">getConfigBean</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getConfigBeanName()">getConfigBeanName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getConfigBeanNameTail()">getConfigBeanNameTail</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;com.sonicsw.mx.config.IConfigPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getConfigPath()">getConfigPath</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;com.sonicsw.mx.config.IConfigPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getConfigPath(java.lang.String)">getConfigPath</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getIntegerAttribute(java.lang.String)">getIntegerAttribute</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getLongAttribute(java.lang.String)">getLongAttribute</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../MgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtBeanFactory</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getMgmtBeanFactory()">getMgmtBeanFactory</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getParent()">getParent</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../IMgmtBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBeanBase</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getReferenceAttribute(java.lang.String)">getReferenceAttribute</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#getStringAttribute(java.lang.String)">getStringAttribute</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#removeAttribute(java.lang.String)">removeAttribute</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#setAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBase)">setAttribute</A></B>(java.lang.String&nbsp;name,
<A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#setBigDecimalAttribute(java.lang.String, java.math.BigDecimal)">setBigDecimalAttribute</A></B>(java.lang.String&nbsp;name,
java.math.BigDecimal&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#setBooleanAttribute(java.lang.String, boolean)">setBooleanAttribute</A></B>(java.lang.String&nbsp;name,
boolean&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#setByteArrayAttribute(java.lang.String, byte[])">setByteArrayAttribute</A></B>(java.lang.String&nbsp;name,
byte[]&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#setIntegerAttribute(java.lang.String, int)">setIntegerAttribute</A></B>(java.lang.String&nbsp;name,
int&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#setLongAttribute(java.lang.String, long)">setLongAttribute</A></B>(java.lang.String&nbsp;name,
long&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#setReferenceAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase)">setReferenceAttribute</A></B>(java.lang.String&nbsp;name,
<A HREF="../IMgmtBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBeanBase</A>&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="MgmtSubBeanBase.html#setStringAttribute(java.lang.String, java.lang.String)">setStringAttribute</A></B>(java.lang.String&nbsp;name,
java.lang.String&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="MgmtSubBeanBase(com.sonicsw.ma.mgmtapi.config.IMgmtBase, java.lang.String, boolean)"><!-- --></A><H3>
MgmtSubBeanBase</H3>
<PRE>
public <B>MgmtSubBeanBase</B>(<A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>&nbsp;parent,
java.lang.String&nbsp;name,
boolean&nbsp;isNew)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getAttributeList()"><!-- --></A><H3>
getAttributeList</H3>
<PRE>
public com.sonicsw.mx.config.IAttributeList <B>getAttributeList</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtBase.html#getAttributeList()">getAttributeList</A></CODE> in interface <CODE><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getAttributeMap()"><!-- --></A><H3>
getAttributeMap</H3>
<PRE>
public com.sonicsw.mx.config.IAttributeMap <B>getAttributeMap</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtBase.html#getAttributeMap()">getAttributeMap</A></CODE> in interface <CODE><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getAttributeMetaData(java.lang.String)"><!-- --></A><H3>
getAttributeMetaData</H3>
<PRE>
public <A HREF="../IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtAttributeMetaData</A> <B>getAttributeMetaData</B>(java.lang.String&nbsp;name)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtBase.html#getAttributeMetaData(java.lang.String)">getAttributeMetaData</A></CODE> in interface <CODE><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getBigDecimalAttribute(java.lang.String)"><!-- --></A><H3>
getBigDecimalAttribute</H3>
<PRE>
public java.math.BigDecimal <B>getBigDecimalAttribute</B>(java.lang.String&nbsp;name)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#getBigDecimalAttribute(java.lang.String)">getBigDecimalAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getBooleanAttribute(java.lang.String)"><!-- --></A><H3>
getBooleanAttribute</H3>
<PRE>
public boolean <B>getBooleanAttribute</B>(java.lang.String&nbsp;name)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#getBooleanAttribute(java.lang.String)">getBooleanAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getByteArrayAttribute(java.lang.String)"><!-- --></A><H3>
getByteArrayAttribute</H3>
<PRE>
public byte[] <B>getByteArrayAttribute</B>(java.lang.String&nbsp;name)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#getByteArrayAttribute(java.lang.String)">getByteArrayAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getConfigBean()"><!-- --></A><H3>
getConfigBean</H3>
<PRE>
public com.sonicsw.mx.config.IConfigBean <B>getConfigBean</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtBase.html#getConfigBean()">getConfigBean</A></CODE> in interface <CODE><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getConfigBeanName()"><!-- --></A><H3>
getConfigBeanName</H3>
<PRE>
public java.lang.String <B>getConfigBeanName</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtBase.html#getConfigBeanName()">getConfigBeanName</A></CODE> in interface <CODE><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getConfigBeanNameTail()"><!-- --></A><H3>
getConfigBeanNameTail</H3>
<PRE>
public java.lang.String <B>getConfigBeanNameTail</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtBase.html#getConfigBeanNameTail()">getConfigBeanNameTail</A></CODE> in interface <CODE><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getConfigPath()"><!-- --></A><H3>
getConfigPath</H3>
<PRE>
public com.sonicsw.mx.config.IConfigPath <B>getConfigPath</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtBase.html#getConfigPath()">getConfigPath</A></CODE> in interface <CODE><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getConfigPath(java.lang.String)"><!-- --></A><H3>
getConfigPath</H3>
<PRE>
public com.sonicsw.mx.config.IConfigPath <B>getConfigPath</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtBase.html#getConfigPath(java.lang.String)">getConfigPath</A></CODE> in interface <CODE><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getIntegerAttribute(java.lang.String)"><!-- --></A><H3>
getIntegerAttribute</H3>
<PRE>
public int <B>getIntegerAttribute</B>(java.lang.String&nbsp;name)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#getIntegerAttribute(java.lang.String)">getIntegerAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getLongAttribute(java.lang.String)"><!-- --></A><H3>
getLongAttribute</H3>
<PRE>
public long <B>getLongAttribute</B>(java.lang.String&nbsp;name)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#getLongAttribute(java.lang.String)">getLongAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getMgmtBeanFactory()"><!-- --></A><H3>
getMgmtBeanFactory</H3>
<PRE>
public <A HREF="../MgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtBeanFactory</A> <B>getMgmtBeanFactory</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtBase.html#getMgmtBeanFactory()">getMgmtBeanFactory</A></CODE> in interface <CODE><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getParent()"><!-- --></A><H3>
getParent</H3>
<PRE>
public <A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A> <B>getParent</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtBase.html#getParent()">getParent</A></CODE> in interface <CODE><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getReferenceAttribute(java.lang.String)"><!-- --></A><H3>
getReferenceAttribute</H3>
<PRE>
public <A HREF="../IMgmtBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBeanBase</A> <B>getReferenceAttribute</B>(java.lang.String&nbsp;name)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#getReferenceAttribute(java.lang.String)">getReferenceAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getStringAttribute(java.lang.String)"><!-- --></A><H3>
getStringAttribute</H3>
<PRE>
public java.lang.String <B>getStringAttribute</B>(java.lang.String&nbsp;name)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#getStringAttribute(java.lang.String)">getStringAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="removeAttribute(java.lang.String)"><!-- --></A><H3>
removeAttribute</H3>
<PRE>
public void <B>removeAttribute</B>(java.lang.String&nbsp;name)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtBase.html#removeAttribute(java.lang.String)">removeAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBase)"><!-- --></A><H3>
setAttribute</H3>
<PRE>
public void <B>setAttribute</B>(java.lang.String&nbsp;name,
<A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>&nbsp;val)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtBase.html#setAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBase)">setAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setBigDecimalAttribute(java.lang.String, java.math.BigDecimal)"><!-- --></A><H3>
setBigDecimalAttribute</H3>
<PRE>
public void <B>setBigDecimalAttribute</B>(java.lang.String&nbsp;name,
java.math.BigDecimal&nbsp;val)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#setBigDecimalAttribute(java.lang.String, java.math.BigDecimal)">setBigDecimalAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setBooleanAttribute(java.lang.String, boolean)"><!-- --></A><H3>
setBooleanAttribute</H3>
<PRE>
public void <B>setBooleanAttribute</B>(java.lang.String&nbsp;name,
boolean&nbsp;val)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#setBooleanAttribute(java.lang.String, boolean)">setBooleanAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setByteArrayAttribute(java.lang.String, byte[])"><!-- --></A><H3>
setByteArrayAttribute</H3>
<PRE>
public void <B>setByteArrayAttribute</B>(java.lang.String&nbsp;name,
byte[]&nbsp;val)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#setByteArrayAttribute(java.lang.String, byte[])">setByteArrayAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setIntegerAttribute(java.lang.String, int)"><!-- --></A><H3>
setIntegerAttribute</H3>
<PRE>
public void <B>setIntegerAttribute</B>(java.lang.String&nbsp;name,
int&nbsp;val)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#setIntegerAttribute(java.lang.String, int)">setIntegerAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setLongAttribute(java.lang.String, long)"><!-- --></A><H3>
setLongAttribute</H3>
<PRE>
public void <B>setLongAttribute</B>(java.lang.String&nbsp;name,
long&nbsp;val)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#setLongAttribute(java.lang.String, long)">setLongAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setReferenceAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase)"><!-- --></A><H3>
setReferenceAttribute</H3>
<PRE>
public void <B>setReferenceAttribute</B>(java.lang.String&nbsp;name,
<A HREF="../IMgmtBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBeanBase</A>&nbsp;val)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#setReferenceAttribute(java.lang.String, com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase)">setReferenceAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setStringAttribute(java.lang.String, java.lang.String)"><!-- --></A><H3>
setStringAttribute</H3>
<PRE>
public void <B>setStringAttribute</B>(java.lang.String&nbsp;name,
java.lang.String&nbsp;val)
throws <A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../IMgmtSubBeanBase.html#setStringAttribute(java.lang.String, java.lang.String)">setStringAttribute</A></CODE> in interface <CODE><A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="MgmtSubBeanBase.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="MgmtMapBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fimpl%252FMgmtSubBeanBase.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MgmtSubBeanBase.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtSubBeanBase.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtSubBeanBase.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MgmtSubBeanBase.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MgmtSubBeanBase.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,42 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.ma.mgmtapi.config.impl (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config.impl package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<FONT size="+1" CLASS="FrameTitleFont">
<A HREF="package-summary.html" target="classFrame">com.sonicsw.ma.mgmtapi.config.impl</A></FONT>
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
<TR>
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
Classes</FONT>&nbsp;
<FONT CLASS="FrameItemFont">
<BR>
<A HREF="AbstractMgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config.impl" target="classFrame">AbstractMgmtBeanFactory</A>
<BR>
<A HREF="MgmtAttributeMetaData.html" title="class in com.sonicsw.ma.mgmtapi.config.impl" target="classFrame">MgmtAttributeMetaData</A>
<BR>
<A HREF="MgmtBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl" target="classFrame">MgmtBeanBase</A>
<BR>
<A HREF="MgmtListBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl" target="classFrame">MgmtListBase</A>
<BR>
<A HREF="MgmtMapBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl" target="classFrame">MgmtMapBase</A>
<BR>
<A HREF="MgmtSubBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl" target="classFrame">MgmtSubBeanBase</A></FONT></TD>
</TR>
</TABLE>
</BODY>
</HTML>
@@ -0,0 +1,172 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.ma.mgmtapi.config.impl (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config.impl package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="com.sonicsw.ma.mgmtapi.config.impl (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="package-summary.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../mf/common/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fimpl%252Fpackage-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package com.sonicsw.ma.mgmtapi.config.impl
</H2>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="AbstractMgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">AbstractMgmtBeanFactory</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MgmtAttributeMetaData.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtAttributeMetaData</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MgmtBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtBeanBase</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MgmtListBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtListBase</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MgmtMapBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtMapBase</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MgmtSubBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl">MgmtSubBeanBase</A></B></TD>
<TD>&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="package-summary.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../mf/common/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fimpl%252Fpackage-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,154 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.ma.mgmtapi.config.impl Class Hierarchy (Management Application API)
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="com.sonicsw.ma.mgmtapi.config.impl Class Hierarchy (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="package-tree.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../package-tree.html"><B>PREV</B></A>&nbsp;
&nbsp;<A HREF="../../../../mf/common/package-tree.html"><B>NEXT</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fimpl%252Fpackage-tree.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<CENTER>
<H2>
Hierarchy For Package com.sonicsw.ma.mgmtapi.config.impl
</H2>
</CENTER>
<DL>
<DT><B>Package Hierarchies:</B><DD><A HREF="../../../../../../overview-tree.html">All Packages</A></DL>
<HR>
<H2>
Class Hierarchy
</H2>
<UL>
<LI TYPE="circle">java.lang.Object<UL>
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.impl.<A HREF="AbstractMgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>AbstractMgmtBeanFactory</B></A><LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.impl.<A HREF="MgmtAttributeMetaData.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>MgmtAttributeMetaData</B></A> (implements com.sonicsw.ma.mgmtapi.config.<A HREF="../IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtAttributeMetaData</A>)
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.impl.<A HREF="MgmtBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>MgmtBeanBase</B></A> (implements java.lang.Cloneable, com.sonicsw.ma.mgmtapi.config.<A HREF="../IMgmtBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBeanBase</A>)
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.impl.<A HREF="MgmtSubBeanBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>MgmtSubBeanBase</B></A> (implements com.sonicsw.ma.mgmtapi.config.<A HREF="../IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A>)
<UL>
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.impl.<A HREF="MgmtListBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>MgmtListBase</B></A> (implements com.sonicsw.ma.mgmtapi.config.<A HREF="../IMgmtListBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtListBase</A>)
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.impl.<A HREF="MgmtMapBase.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>MgmtMapBase</B></A> (implements com.sonicsw.ma.mgmtapi.config.<A HREF="../IMgmtMapBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtMapBase</A>)
</UL>
</UL>
</UL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="package-tree.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../package-tree.html"><B>PREV</B></A>&nbsp;
&nbsp;<A HREF="../../../../mf/common/package-tree.html"><B>NEXT</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fimpl%252Fpackage-tree.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,66 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.ma.mgmtapi.config (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<FONT size="+1" CLASS="FrameTitleFont">
<A HREF="package-summary.html" target="classFrame">com.sonicsw.ma.mgmtapi.config</A></FONT>
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
<TR>
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
Interfaces</FONT>&nbsp;
<FONT CLASS="FrameItemFont">
<BR>
<A HREF="IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config" target="classFrame"><I>IMgmtAttributeMetaData</I></A>
<BR>
<A HREF="IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config" target="classFrame"><I>IMgmtBase</I></A>
<BR>
<A HREF="IMgmtBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config" target="classFrame"><I>IMgmtBeanBase</I></A>
<BR>
<A HREF="IMgmtListBase.html" title="interface in com.sonicsw.ma.mgmtapi.config" target="classFrame"><I>IMgmtListBase</I></A>
<BR>
<A HREF="IMgmtMapBase.html" title="interface in com.sonicsw.ma.mgmtapi.config" target="classFrame"><I>IMgmtMapBase</I></A>
<BR>
<A HREF="IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config" target="classFrame"><I>IMgmtSubBeanBase</I></A></FONT></TD>
</TR>
</TABLE>
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
<TR>
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
Classes</FONT>&nbsp;
<FONT CLASS="FrameItemFont">
<BR>
<A HREF="MgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config" target="classFrame">MgmtBeanFactory</A></FONT></TD>
</TR>
</TABLE>
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
<TR>
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
Exceptions</FONT>&nbsp;
<FONT CLASS="FrameItemFont">
<BR>
<A HREF="AttributeNotFoundException.html" title="class in com.sonicsw.ma.mgmtapi.config" target="classFrame">AttributeNotFoundException</A>
<BR>
<A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config" target="classFrame">MgmtException</A></FONT></TD>
</TR>
</TABLE>
</BODY>
</HTML>
@@ -0,0 +1,204 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.ma.mgmtapi.config (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.ma.mgmtapi.config package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="com.sonicsw.ma.mgmtapi.config (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="package-summary.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV PACKAGE&nbsp;
&nbsp;<A HREF="impl/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fpackage-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package com.sonicsw.ma.mgmtapi.config
</H2>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtAttributeMetaData</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IMgmtBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBeanBase</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IMgmtListBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtListBase</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IMgmtMapBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtMapBase</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtSubBeanBase</A></B></TD>
<TD>&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtBeanFactory</A></B></TD>
<TD>&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Exception Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="AttributeNotFoundException.html" title="class in com.sonicsw.ma.mgmtapi.config">AttributeNotFoundException</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config">MgmtException</A></B></TD>
<TD>&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="package-summary.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV PACKAGE&nbsp;
&nbsp;<A HREF="impl/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fpackage-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,169 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.ma.mgmtapi.config Class Hierarchy (Management Application API)
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="com.sonicsw.ma.mgmtapi.config Class Hierarchy (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="package-tree.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV&nbsp;
&nbsp;<A HREF="impl/package-tree.html"><B>NEXT</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fpackage-tree.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<CENTER>
<H2>
Hierarchy For Package com.sonicsw.ma.mgmtapi.config
</H2>
</CENTER>
<DL>
<DT><B>Package Hierarchies:</B><DD><A HREF="../../../../../overview-tree.html">All Packages</A></DL>
<HR>
<H2>
Class Hierarchy
</H2>
<UL>
<LI TYPE="circle">java.lang.Object<UL>
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.impl.<A HREF="impl/AbstractMgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config.impl"><B>AbstractMgmtBeanFactory</B></A><UL>
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.<A HREF="MgmtBeanFactory.html" title="class in com.sonicsw.ma.mgmtapi.config"><B>MgmtBeanFactory</B></A></UL>
<LI TYPE="circle">java.lang.Throwable (implements java.io.Serializable)
<UL>
<LI TYPE="circle">java.lang.Exception<UL>
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.<A HREF="MgmtException.html" title="class in com.sonicsw.ma.mgmtapi.config"><B>MgmtException</B></A><UL>
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.<A HREF="AttributeNotFoundException.html" title="class in com.sonicsw.ma.mgmtapi.config"><B>AttributeNotFoundException</B></A></UL>
</UL>
</UL>
</UL>
</UL>
<H2>
Interface Hierarchy
</H2>
<UL>
<LI TYPE="circle">com.sonicsw.mx.config.IAnnotationExtension<UL>
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.<A HREF="IMgmtBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>IMgmtBeanBase</B></A> (also extends com.sonicsw.ma.mgmtapi.config.<A HREF="IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config">IMgmtBase</A>)
</UL>
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.<A HREF="IMgmtAttributeMetaData.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>IMgmtAttributeMetaData</B></A><LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.<A HREF="IMgmtBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>IMgmtBase</B></A><UL>
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.<A HREF="IMgmtBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>IMgmtBeanBase</B></A> (also extends com.sonicsw.mx.config.IAnnotationExtension)
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.<A HREF="IMgmtSubBeanBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>IMgmtSubBeanBase</B></A><UL>
<LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.<A HREF="IMgmtListBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>IMgmtListBase</B></A><LI TYPE="circle">com.sonicsw.ma.mgmtapi.config.<A HREF="IMgmtMapBase.html" title="interface in com.sonicsw.ma.mgmtapi.config"><B>IMgmtMapBase</B></A></UL>
</UL>
</UL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="package-tree.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV&nbsp;
&nbsp;<A HREF="impl/package-tree.html"><B>NEXT</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fma%252Fmgmtapi%252Fconfig%252Fpackage-tree.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,304 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:04 EDT 2011 -->
<TITLE>
MFException (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.MFException class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="MFException (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="MFException.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="MFRuntimeException.html" title="class in com.sonicsw.mf.common"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252FMFException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MFException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MFException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MFException.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MFException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MFException.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common</FONT>
<BR>
Class MFException</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.mf.common.MFException</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../mq/common/runtime/BrokerNotActiveException.html" title="class in com.sonicsw.mq.common.runtime">BrokerNotActiveException</A>, <A HREF="../../mq/common/runtime/CannotActivateException.html" title="class in com.sonicsw.mq.common.runtime">CannotActivateException</A>, <A HREF="../../mq/common/runtime/ConnectionTreeUpdateException.html" title="class in com.sonicsw.mq.common.runtime">ConnectionTreeUpdateException</A>, <A HREF="security/InvalidManagementPermissionException.html" title="class in com.sonicsw.mf.common.security">InvalidManagementPermissionException</A>, <A HREF="../../mq/common/runtime/MFDurableOperationException.html" title="class in com.sonicsw.mq.common.runtime">MFDurableOperationException</A>, <A HREF="runtime/NonRecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime">NonRecoverableStateChangeException</A>, <A HREF="runtime/RecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime">RecoverableStateChangeException</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>MFException</B><DT>extends java.lang.Exception<DT>implements java.io.Serializable</DL>
</PRE>
<P>
Checked management exception.
<p>
Classes that extend MFException should be placed in packages that will be available to management applications.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.sonicsw.mf.common.MFException">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MFException.html#MFException()">MFException</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new exception with <code>null</code> as its detail message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MFException.html#MFException(java.lang.String)">MFException</A></B>(java.lang.String&nbsp;message)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new exception with the specified detail message.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="MFException.html#getMessage()">getMessage</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the detail message string of this throwable.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="MFException()"><!-- --></A><H3>
MFException</H3>
<PRE>
public <B>MFException</B>()</PRE>
<DL>
<DD>Constructs a new exception with <code>null</code> as its detail message.
The cause is not initialized, and may subsequently be initialized by a
call to <A HREF="MFException.html#setLinkedException(java.lang.Exception)"><CODE>setLinkedException(java.lang.Exception)</CODE></A>.
<P>
</DL>
<HR>
<A NAME="MFException(java.lang.String)"><!-- --></A><H3>
MFException</H3>
<PRE>
public <B>MFException</B>(java.lang.String&nbsp;message)</PRE>
<DL>
<DD>Constructs a new exception with the specified detail message. The
cause is not initialized, and may subsequently be initialized by
a call to <A HREF="MFException.html#setLinkedException(java.lang.Exception)"><CODE>setLinkedException(java.lang.Exception)</CODE></A>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the detail message. The detail message is saved for
later retrieval by the <A HREF="MFException.html#getMessage()"><CODE>getMessage()</CODE></A> method.</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getMessage()"><!-- --></A><H3>
getMessage</H3>
<PRE>
public java.lang.String <B>getMessage</B>()</PRE>
<DL>
<DD>Returns the detail message string of this throwable.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>getMessage</CODE> in class <CODE>java.lang.Throwable</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the detail message string of this exception instance
(which may be <tt>null</tt>).</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="MFException.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="MFRuntimeException.html" title="class in com.sonicsw.mf.common"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252FMFException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MFException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MFException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MFException.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MFException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MFException.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,305 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:04 EDT 2011 -->
<TITLE>
MFRuntimeException (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.MFRuntimeException class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="MFRuntimeException (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="MFRuntimeException.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="MFException.html" title="class in com.sonicsw.mf.common"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="MFSecurityException.html" title="class in com.sonicsw.mf.common"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252FMFRuntimeException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MFRuntimeException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MFRuntimeException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MFRuntimeException.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MFRuntimeException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MFRuntimeException.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common</FONT>
<BR>
Class MFRuntimeException</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.RuntimeException
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.mf.common.MFRuntimeException</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="security/ManagementPermissionDeniedException.html" title="class in com.sonicsw.mf.common.security">ManagementPermissionDeniedException</A>, <A HREF="security/ManagementPermissionsCheckingNotEnabledException.html" title="class in com.sonicsw.mf.common.security">ManagementPermissionsCheckingNotEnabledException</A>, <A HREF="MFSecurityException.html" title="class in com.sonicsw.mf.common">MFSecurityException</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>MFRuntimeException</B><DT>extends java.lang.RuntimeException<DT>implements java.io.Serializable</DL>
</PRE>
<P>
Unchecked management exception.
<p>
Classes that extend MFRuntimeException should be placed in packages that will be available to management applications.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.sonicsw.mf.common.MFRuntimeException">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MFRuntimeException.html#MFRuntimeException()">MFRuntimeException</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new runtime exception with <code>null</code> as its detail message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MFRuntimeException.html#MFRuntimeException(java.lang.String)">MFRuntimeException</A></B>(java.lang.String&nbsp;message)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new runtime exception with the specified detail message.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="MFRuntimeException.html#getMessage()">getMessage</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the detail message string of this throwable.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="MFRuntimeException()"><!-- --></A><H3>
MFRuntimeException</H3>
<PRE>
public <B>MFRuntimeException</B>()</PRE>
<DL>
<DD>Constructs a new runtime exception with <code>null</code> as its detail message.
The cause is not initialized, and may subsequently be initialized by a
call to <A HREF="MFRuntimeException.html#setLinkedException(java.lang.Exception)"><CODE>setLinkedException(java.lang.Exception)</CODE></A>.
<P>
</DL>
<HR>
<A NAME="MFRuntimeException(java.lang.String)"><!-- --></A><H3>
MFRuntimeException</H3>
<PRE>
public <B>MFRuntimeException</B>(java.lang.String&nbsp;message)</PRE>
<DL>
<DD>Constructs a new runtime exception with the specified detail message. The
cause is not initialized, and may subsequently be initialized by
a call to <A HREF="MFRuntimeException.html#setLinkedException(java.lang.Exception)"><CODE>setLinkedException(java.lang.Exception)</CODE></A>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the detail message. The detail message is saved for
later retrieval by the <A HREF="MFRuntimeException.html#getMessage()"><CODE>getMessage()</CODE></A> method.</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getMessage()"><!-- --></A><H3>
getMessage</H3>
<PRE>
public java.lang.String <B>getMessage</B>()</PRE>
<DL>
<DD>Returns the detail message string of this throwable.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>getMessage</CODE> in class <CODE>java.lang.Throwable</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the detail message string of this exception instance
(which may be <tt>null</tt>).</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="MFRuntimeException.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="MFException.html" title="class in com.sonicsw.mf.common"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="MFSecurityException.html" title="class in com.sonicsw.mf.common"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252FMFRuntimeException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MFRuntimeException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MFRuntimeException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MFRuntimeException.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MFRuntimeException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MFRuntimeException.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,277 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:05 EDT 2011 -->
<TITLE>
MFSecurityException (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.MFSecurityException class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="MFSecurityException (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="MFSecurityException.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="MFRuntimeException.html" title="class in com.sonicsw.mf.common"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252FMFSecurityException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MFSecurityException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MFSecurityException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MFSecurityException.html#methods_inherited_from_class_com.sonicsw.mf.common.MFRuntimeException">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MFSecurityException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common</FONT>
<BR>
Class MFSecurityException</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.RuntimeException
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="MFRuntimeException.html" title="class in com.sonicsw.mf.common">com.sonicsw.mf.common.MFRuntimeException</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.mf.common.MFSecurityException</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>MFSecurityException</B><DT>extends <A HREF="MFRuntimeException.html" title="class in com.sonicsw.mf.common">MFRuntimeException</A></DL>
</PRE>
<P>
Unchecked management security exception.
<p>
General security exception
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.sonicsw.mf.common.MFSecurityException">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MFSecurityException.html#MFSecurityException()">MFSecurityException</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new security exception with <code>null</code> as its detail message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MFSecurityException.html#MFSecurityException(java.lang.String)">MFSecurityException</A></B>(java.lang.String&nbsp;message)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new security exception with the specified detail message.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.MFRuntimeException"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.sonicsw.mf.common.<A HREF="MFRuntimeException.html" title="class in com.sonicsw.mf.common">MFRuntimeException</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="MFRuntimeException.html#getMessage()">getMessage</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="MFSecurityException()"><!-- --></A><H3>
MFSecurityException</H3>
<PRE>
public <B>MFSecurityException</B>()</PRE>
<DL>
<DD>Constructs a new security exception with <code>null</code> as its detail message.
The cause is not initialized, and may subsequently be initialized by a
call to <A HREF="MFRuntimeException.html#setLinkedException(java.lang.Exception)"><CODE>MFRuntimeException.setLinkedException(java.lang.Exception)</CODE></A>.
<P>
</DL>
<HR>
<A NAME="MFSecurityException(java.lang.String)"><!-- --></A><H3>
MFSecurityException</H3>
<PRE>
public <B>MFSecurityException</B>(java.lang.String&nbsp;message)</PRE>
<DL>
<DD>Constructs a new security exception with the specified detail message. The
cause is not initialized, and may subsequently be initialized by
a call to <A HREF="MFRuntimeException.html#setLinkedException(java.lang.Exception)"><CODE>MFRuntimeException.setLinkedException(java.lang.Exception)</CODE></A>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the detail message. The detail message is saved for
later retrieval by the <A HREF="MFRuntimeException.html#getMessage()"><CODE>MFRuntimeException.getMessage()</CODE></A> method.</DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="MFSecurityException.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="MFRuntimeException.html" title="class in com.sonicsw.mf.common"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252FMFSecurityException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MFSecurityException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MFSecurityException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MFSecurityException.html#methods_inherited_from_class_com.sonicsw.mf.common.MFRuntimeException">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MFSecurityException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,385 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:18 EDT 2011 -->
<TITLE>
IAggregateMetric (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics.IAggregateMetric interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IAggregateMetric (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IAggregateMetric.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="IAggregateMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIAggregateMetric.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IAggregateMetric.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IAggregateMetric.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IAggregateMetric.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IAggregateMetric.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IAggregateMetric.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.metrics</FONT>
<BR>
Interface IAggregateMetric</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IAggregateMetric</B><DT>extends java.io.Serializable</DL>
</PRE>
<P>
An AggregatedMetric extends the basic metric by encapsulating the sources
of the metrics from which the aggregate metric value was derived.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics"><CODE>IMetric</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IAggregateMetric.html#AVERAGE_AGGREGATION_TYPE">AVERAGE_AGGREGATION_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IAggregateMetric.html#MAXIMUM_AGGREGATION_TYPE">MAXIMUM_AGGREGATION_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IAggregateMetric.html#MINIMUM_AGGREGATION_TYPE">MINIMUM_AGGREGATION_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IAggregateMetric.html#TOTAL_AGGREGATION_TYPE">TOTAL_AGGREGATION_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IAggregateMetric.html#getCurrencyTimestamp()">getCurrencyTimestamp</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the currency of the aggregated metric (an average of the currency time
of all the contributing metrics).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="IAggregateMetric.html#getMetricIdentity()">getMetricIdentity</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the metric identity of the metric.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IAggregateMetric.html#getSources()">getSources</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the source components that provided the metrics from which the
aggregate metric value was derived.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IAggregateMetric.html#getValues()">getValues</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the array aggregate metric values indexed by aggregation type.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="AVERAGE_AGGREGATION_TYPE"><!-- --></A><H3>
AVERAGE_AGGREGATION_TYPE</H3>
<PRE>
static final short <B>AVERAGE_AGGREGATION_TYPE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IAggregateMetric.AVERAGE_AGGREGATION_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MAXIMUM_AGGREGATION_TYPE"><!-- --></A><H3>
MAXIMUM_AGGREGATION_TYPE</H3>
<PRE>
static final short <B>MAXIMUM_AGGREGATION_TYPE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IAggregateMetric.MAXIMUM_AGGREGATION_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MINIMUM_AGGREGATION_TYPE"><!-- --></A><H3>
MINIMUM_AGGREGATION_TYPE</H3>
<PRE>
static final short <B>MINIMUM_AGGREGATION_TYPE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IAggregateMetric.MINIMUM_AGGREGATION_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="TOTAL_AGGREGATION_TYPE"><!-- --></A><H3>
TOTAL_AGGREGATION_TYPE</H3>
<PRE>
static final short <B>TOTAL_AGGREGATION_TYPE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IAggregateMetric.TOTAL_AGGREGATION_TYPE">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getCurrencyTimestamp()"><!-- --></A><H3>
getCurrencyTimestamp</H3>
<PRE>
long <B>getCurrencyTimestamp</B>()</PRE>
<DL>
<DD>Gets the currency of the aggregated metric (an average of the currency time
of all the contributing metrics).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMetricIdentity()"><!-- --></A><H3>
getMetricIdentity</H3>
<PRE>
<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A> <B>getMetricIdentity</B>()</PRE>
<DL>
<DD>Gets the metric identity of the metric.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSources()"><!-- --></A><H3>
getSources</H3>
<PRE>
java.lang.String[] <B>getSources</B>()</PRE>
<DL>
<DD>Gets the source components that provided the metrics from which the
aggregate metric value was derived.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getValues()"><!-- --></A><H3>
getValues</H3>
<PRE>
long[] <B>getValues</B>()</PRE>
<DL>
<DD>Gets the array aggregate metric values indexed by aggregation type.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="IAggregateMetric.html#TOTAL_AGGREGATION_TYPE"><CODE>TOTAL_AGGREGATION_TYPE</CODE></A>,
<A HREF="IAggregateMetric.html#AVERAGE_AGGREGATION_TYPE"><CODE>AVERAGE_AGGREGATION_TYPE</CODE></A>,
<A HREF="IAggregateMetric.html#MAXIMUM_AGGREGATION_TYPE"><CODE>MAXIMUM_AGGREGATION_TYPE</CODE></A>,
<A HREF="IAggregateMetric.html#MINIMUM_AGGREGATION_TYPE"><CODE>MINIMUM_AGGREGATION_TYPE</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IAggregateMetric.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="IAggregateMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIAggregateMetric.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IAggregateMetric.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IAggregateMetric.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IAggregateMetric.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IAggregateMetric.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IAggregateMetric.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,217 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:18 EDT 2011 -->
<TITLE>
IAggregateMetricsData (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics.IAggregateMetricsData interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IAggregateMetricsData (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IAggregateMetricsData.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IAggregateMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIAggregateMetricsData.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IAggregateMetricsData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IAggregateMetricsData.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IAggregateMetricsData.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.metrics</FONT>
<BR>
Interface IAggregateMetricsData</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IAggregateMetricsData</B><DT>extends java.io.Serializable</DL>
</PRE>
<P>
Classes that implement this interface encapsulate multiple metrics and their runtime
value at a particular collection time.
Management clients request aggregate metrics data from a CollectionsMonitor.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IAggregateMetric.html" title="interface in com.sonicsw.mf.common.metrics">IAggregateMetric</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IAggregateMetricsData.html#getAggregateMetrics()">getAggregateMetrics</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the metrics captured in this object.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getAggregateMetrics()"><!-- --></A><H3>
getAggregateMetrics</H3>
<PRE>
<A HREF="IAggregateMetric.html" title="interface in com.sonicsw.mf.common.metrics">IAggregateMetric</A>[] <B>getAggregateMetrics</B>()</PRE>
<DL>
<DD>Gets the metrics captured in this object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>An array of aggregated metrics.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IAggregateMetricsData.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IAggregateMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIAggregateMetricsData.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IAggregateMetricsData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IAggregateMetricsData.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IAggregateMetricsData.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,279 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:18 EDT 2011 -->
<TITLE>
IAlert (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics.IAlert interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IAlert (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IAlert.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IAggregateMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIAlert.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IAlert.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IAlert.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IAlert.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.metrics</FONT>
<BR>
Interface IAlert</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IAlert</B></DL>
</PRE>
<P>
An alert defines a high or low threshold value for a particular metric.
One or more alerts can be associated with an individual metric, an instance metric, or
all instances of an instance metric parent.
A notification is issued whenever the value of a metric exceeds the threshold of one of its
associated alerts (either high or low).
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IAlert.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;o)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines whether two alerts are equal</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="IAlert.html#getMetricIdentity()">getMetricIdentity</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the metric identity for this alert</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IAlert.html#getThresholdValue()">getThresholdValue</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the alert's threshold value</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IAlert.html#isHighThreshold()">isHighThreshold</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;True if this is a high threshold alert, false if a low threshold.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
boolean <B>equals</B>(java.lang.Object&nbsp;o)</PRE>
<DL>
<DD>Determines whether two alerts are equal
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMetricIdentity()"><!-- --></A><H3>
getMetricIdentity</H3>
<PRE>
<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A> <B>getMetricIdentity</B>()</PRE>
<DL>
<DD>Returns the metric identity for this alert
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getThresholdValue()"><!-- --></A><H3>
getThresholdValue</H3>
<PRE>
long <B>getThresholdValue</B>()</PRE>
<DL>
<DD>Returns the alert's threshold value
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isHighThreshold()"><!-- --></A><H3>
isHighThreshold</H3>
<PRE>
boolean <B>isHighThreshold</B>()</PRE>
<DL>
<DD>True if this is a high threshold alert, false if a low threshold.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IAlert.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IAggregateMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIAlert.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IAlert.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IAlert.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IAlert.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,224 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:18 EDT 2011 -->
<TITLE>
IHistoricalMetric (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics.IHistoricalMetric interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IHistoricalMetric (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IHistoricalMetric.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IHistoricalMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIHistoricalMetric.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IHistoricalMetric.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IHistoricalMetric.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IHistoricalMetric.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.metrics</FONT>
<BR>
Interface IHistoricalMetric</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A>, java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IHistoricalMetric</B><DT>extends <A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A>, java.io.Serializable</DL>
</PRE>
<P>
A HistoricalMetric extends the basic metric by encapsulating the source of the metric.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics"><CODE>IMetric</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IHistoricalMetric.html#getSource()">getSource</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the source component that created the metric.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.metrics.IMetric"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.mf.common.metrics.<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="IMetric.html#getCurrencyTimestamp()">getCurrencyTimestamp</A>, <A HREF="IMetric.html#getMetricIdentity()">getMetricIdentity</A>, <A HREF="IMetric.html#getTriggeredAlerts()">getTriggeredAlerts</A>, <A HREF="IMetric.html#getValue()">getValue</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getSource()"><!-- --></A><H3>
getSource</H3>
<PRE>
java.lang.String <B>getSource</B>()</PRE>
<DL>
<DD>Gets the source component that created the metric.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IHistoricalMetric.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IHistoricalMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIHistoricalMetric.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IHistoricalMetric.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IHistoricalMetric.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IHistoricalMetric.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,217 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:18 EDT 2011 -->
<TITLE>
IHistoricalMetricsData (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics.IHistoricalMetricsData interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IHistoricalMetricsData (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IHistoricalMetricsData.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIHistoricalMetricsData.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IHistoricalMetricsData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IHistoricalMetricsData.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IHistoricalMetricsData.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.metrics</FONT>
<BR>
Interface IHistoricalMetricsData</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IHistoricalMetricsData</B><DT>extends java.io.Serializable</DL>
</PRE>
<P>
Classes that implement this interface encapsulate multiple metrics and their runtime
value at a particular collection time.
Management clients request historical metrics data from a CollectionsMonitor.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics">IHistoricalMetric</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IHistoricalMetricsData.html#getHistoricalMetrics()">getHistoricalMetrics</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the metrics captured in this object.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getHistoricalMetrics()"><!-- --></A><H3>
getHistoricalMetrics</H3>
<PRE>
<A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics">IHistoricalMetric</A>[] <B>getHistoricalMetrics</B>()</PRE>
<DL>
<DD>Gets the metrics captured in this object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>An array of historical metrics.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IHistoricalMetricsData.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIHistoricalMetricsData.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IHistoricalMetricsData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IHistoricalMetricsData.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IHistoricalMetricsData.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,278 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:18 EDT 2011 -->
<TITLE>
IMetric (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics.IMetric interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IMetric (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IMetric.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IHistoricalMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIMetric.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMetric.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetric.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetric.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.metrics</FONT>
<BR>
Interface IMetric</H2>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics">IHistoricalMetric</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IMetric</B></DL>
</PRE>
<P>
A metric provides the numeric value of a metric identity (as captured at some point
in time).
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><CODE>IMetricsData</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetric.html#getCurrencyTimestamp()">getCurrencyTimestamp</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the currency of the metric (the time the statistical data was last
updated prior to metric evaluation).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetric.html#getMetricIdentity()">getMetricIdentity</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the metric identity of the metric.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics">IAlert</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetric.html#getTriggeredAlerts()">getTriggeredAlerts</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the triggered alerts</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetric.html#getValue()">getValue</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the metric value.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getCurrencyTimestamp()"><!-- --></A><H3>
getCurrencyTimestamp</H3>
<PRE>
long <B>getCurrencyTimestamp</B>()</PRE>
<DL>
<DD>Gets the currency of the metric (the time the statistical data was last
updated prior to metric evaluation).
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMetricIdentity()"><!-- --></A><H3>
getMetricIdentity</H3>
<PRE>
<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A> <B>getMetricIdentity</B>()</PRE>
<DL>
<DD>Gets the metric identity of the metric.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTriggeredAlerts()"><!-- --></A><H3>
getTriggeredAlerts</H3>
<PRE>
<A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics">IAlert</A>[] <B>getTriggeredAlerts</B>()</PRE>
<DL>
<DD>Gets the triggered alerts
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getValue()"><!-- --></A><H3>
getValue</H3>
<PRE>
long <B>getValue</B>()</PRE>
<DL>
<DD>Gets the metric value.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IMetric.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IHistoricalMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIMetric.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMetric.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetric.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetric.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,348 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IMetricIdentity (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics.IMetricIdentity interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IMetricIdentity (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IMetricIdentity.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMetricInfo.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIMetricIdentity.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMetricIdentity.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IMetricIdentity.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetricIdentity.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IMetricIdentity.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetricIdentity.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.metrics</FONT>
<BR>
Interface IMetricIdentity</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IMetricIdentity</B><DT>extends java.io.Serializable</DL>
</PRE>
<P>
Individual metrics are identified as leaves in a tree. A metric identity identifies one
of the following:
<pre>
- a branch of a tree of related metrics (node)
- a metric group (node)
- an individual metric (leaf)
</pre>
Each node/leaf in a metric tree has a name component (a string) and is fully described
by an array of name components that describe its path in the tree starting from the root.
A canonical form of the name components is evaluated by creating a '.' delimited list of
those name components (however the canonical form cannot be reduced to the original
name components as an individual name component is allowed to contain the '.' character).
<p>
A metric tree may be as small as a single node.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricIdentity.html#EMPTY_METRIC_IDENTITY_ARRAY">EMPTY_METRIC_IDENTITY_ARRAY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricIdentity.html#getAbsoluteName()">getAbsoluteName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the absolute name of the metric identity where by each name component is
delimited by a period '.' character.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricIdentity.html#getName()">getName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the canonical name of the metric identity where by each name component is
delimited by a period '.' character.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricIdentity.html#getNameComponents()">getNameComponents</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name components the uniquely identify the metric identity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricIdentity.html#isInstanceOf(com.sonicsw.mf.common.metrics.IMetricIdentity)">isInstanceOf</A></B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;id)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests if this metric is an instance of the given metric identity (branch
of a tree of metrics or metric group).</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="EMPTY_METRIC_IDENTITY_ARRAY"><!-- --></A><H3>
EMPTY_METRIC_IDENTITY_ARRAY</H3>
<PRE>
static final <A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>[] <B>EMPTY_METRIC_IDENTITY_ARRAY</B></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getAbsoluteName()"><!-- --></A><H3>
getAbsoluteName</H3>
<PRE>
java.lang.String <B>getAbsoluteName</B>()</PRE>
<DL>
<DD>Get the absolute name of the metric identity where by each name component is
delimited by a period '.' character. If any of the name components contain
a period '.' or percent '%' character these will be escaped using a
percent character e.g. "queue.message.Count.SoincMQ%.routingQueue"
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="IMetricIdentity.html#getName()"><CODE>getName()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
java.lang.String <B>getName</B>()</PRE>
<DL>
<DD>Get the canonical name of the metric identity where by each name component is
delimited by a period '.' character. If any of the name components contain
a period '.' or percent '%' character these will not be be escaped (this is
different to the absolute name) e.g. "queue.message.Count.SoincMQ.routingQueue"
<p>
Note: The return value from this method should not be used to create a new metric
identity instance (using the MetricsFactory).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="IMetricIdentity.html#getAbsoluteName()"><CODE>getAbsoluteName()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getNameComponents()"><!-- --></A><H3>
getNameComponents</H3>
<PRE>
java.lang.String[] <B>getNameComponents</B>()</PRE>
<DL>
<DD>Get the name components the uniquely identify the metric identity.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isInstanceOf(com.sonicsw.mf.common.metrics.IMetricIdentity)"><!-- --></A><H3>
isInstanceOf</H3>
<PRE>
boolean <B>isInstanceOf</B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;id)</PRE>
<DL>
<DD>Tests if this metric is an instance of the given metric identity (branch
of a tree of metrics or metric group). If given identity is an instance
pattern e.g. "a.b.c*", then tests if this metric matches the pattern.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IMetricIdentity.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMetricInfo.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIMetricIdentity.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMetricIdentity.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IMetricIdentity.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetricIdentity.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IMetricIdentity.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetricIdentity.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,419 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IMetricInfo (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics.IMetricInfo interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IMetricInfo (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IMetricInfo.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIMetricInfo.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMetricInfo.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetricInfo.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetricInfo.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.metrics</FONT>
<BR>
Interface IMetricInfo</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IMetricInfo</B><DT>extends java.io.Serializable</DL>
</PRE>
<P>
A metric info object provides meta-data about one of the following:
<ul>
<li>an instance metric parent (e.g. "connection.messages.ReceivedPerSecond")
<li>an individual normal (i.e. non-instance) metric (e.g. "broker.connections.Count")
</ul>
Instance metrics are described by their instance metric parent's meta-data and thus
metric info objects for such instance metrics will not exist. In other words, there will not be
an IMetricInfo object for an instance metric, but there will be one for the instance metric's parent.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricInfo.html#getDescription()">getDescription</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the optional full description of the metric.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricInfo.html#getExtendedData()">getExtendedData</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extended data allows any additional meta information that a component wishes to
convey about a metric.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricInfo.html#getMetricIdentity()">getMetricIdentity</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the metric identity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricInfo.html#getUnits()">getUnits</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Describes the units that this metric uses.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricInfo.html#getValueType()">getValueType</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the metrics value type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricInfo.html#isDynamic()">isDynamic</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If a metric is dynamic it means it can be dynamically enabled/disabled through
the components management API.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricInfo.html#isInstanceMetric()">isInstanceMetric</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, the meta-data is for an instance metric parent, and the information
provided can be applied to all of the individual instances of that instance metric parent.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricInfo.html#supportsHighThresholdAlerts()">supportsHighThresholdAlerts</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether the metric supports high threshold alerts</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricInfo.html#supportsLowThresholdAlerts()">supportsLowThresholdAlerts</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether the metric supports low threshold alerts</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getDescription()"><!-- --></A><H3>
getDescription</H3>
<PRE>
java.lang.String <B>getDescription</B>()</PRE>
<DL>
<DD>Gets the optional full description of the metric.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getExtendedData()"><!-- --></A><H3>
getExtendedData</H3>
<PRE>
java.lang.String <B>getExtendedData</B>()</PRE>
<DL>
<DD>Extended data allows any additional meta information that a component wishes to
convey about a metric. The management framework is agnostic about what this
field is used for.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMetricIdentity()"><!-- --></A><H3>
getMetricIdentity</H3>
<PRE>
<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A> <B>getMetricIdentity</B>()</PRE>
<DL>
<DD>Gets the metric identity.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getUnits()"><!-- --></A><H3>
getUnits</H3>
<PRE>
java.lang.String <B>getUnits</B>()</PRE>
<DL>
<DD>Describes the units that this metric uses.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getValueType()"><!-- --></A><H3>
getValueType</H3>
<PRE>
short <B>getValueType</B>()</PRE>
<DL>
<DD>Gets the metrics value type.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="IValueType.html" title="interface in com.sonicsw.mf.common.metrics"><CODE>IValueType</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="isDynamic()"><!-- --></A><H3>
isDynamic</H3>
<PRE>
boolean <B>isDynamic</B>()</PRE>
<DL>
<DD>If a metric is dynamic it means it can be dynamically enabled/disabled through
the components management API.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isInstanceMetric()"><!-- --></A><H3>
isInstanceMetric</H3>
<PRE>
boolean <B>isInstanceMetric</B>()</PRE>
<DL>
<DD>If true, the meta-data is for an instance metric parent, and the information
provided can be applied to all of the individual instances of that instance metric parent.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="supportsHighThresholdAlerts()"><!-- --></A><H3>
supportsHighThresholdAlerts</H3>
<PRE>
boolean <B>supportsHighThresholdAlerts</B>()</PRE>
<DL>
<DD>Indicates whether the metric supports high threshold alerts
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="supportsLowThresholdAlerts()"><!-- --></A><H3>
supportsLowThresholdAlerts</H3>
<PRE>
boolean <B>supportsLowThresholdAlerts</B>()</PRE>
<DL>
<DD>Indicates whether the metric supports low threshold alerts
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IMetricInfo.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIMetricInfo.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMetricInfo.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetricInfo.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetricInfo.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,242 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IMetricsData (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics.IMetricsData interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IMetricsData (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IMetricsData.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMetricInfo.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IValueType.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIMetricsData.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMetricsData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetricsData.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetricsData.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.metrics</FONT>
<BR>
Interface IMetricsData</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IMetricsData</B><DT>extends java.io.Serializable</DL>
</PRE>
<P>
Classes that implement this interface encapsulate multiple metrics and their runtime
value at a particular collection time.
Management clients request metrics data from a component.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricsData.html#getCurrencyTimestamp()">getCurrencyTimestamp</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the time the metrics were collected by the component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMetricsData.html#getMetrics()">getMetrics</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the metrics captured in this object.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getCurrencyTimestamp()"><!-- --></A><H3>
getCurrencyTimestamp</H3>
<PRE>
long <B>getCurrencyTimestamp</B>()</PRE>
<DL>
<DD>Gets the time the metrics were collected by the component. This
time will be based on the system clock of the host the component's
container is running on.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMetrics()"><!-- --></A><H3>
getMetrics</H3>
<PRE>
<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A>[] <B>getMetrics</B>()</PRE>
<DL>
<DD>Gets the metrics captured in this object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IMetricsData.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMetricInfo.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IValueType.html" title="interface in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIMetricsData.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMetricsData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetricsData.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMetricsData.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,634 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IValueType (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics.IValueType interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IValueType (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IValueType.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="MetricsFactory.html" title="class in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIValueType.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IValueType.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IValueType.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IValueType.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.metrics</FONT>
<BR>
Interface IValueType</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IValueType</B></DL>
</PRE>
<P>
Metric values are one of the types described in this interface. A given metric's
value type can be obtained from the metric's meta-data (see <A HREF="IMetricInfo.html" title="interface in com.sonicsw.mf.common.metrics"><CODE>IMetricInfo</CODE></A>).
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#AVERAGE">AVERAGE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents the average of all the values in a set of historical values.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#COUNT">COUNT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents the number of times a value is updated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#DESCRIPTIONS">DESCRIPTIONS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A textual description of the value type may be obtained using a
value type as an index into the array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#MAXIMUM">MAXIMUM</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents the maximum value from a set of historical values.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#MINIMUM">MINIMUM</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents the minimum value from a set of historical values.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#NUM_VALUE_TYPES">NUM_VALUE_TYPES</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of default value types</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#PEAK_PER_HOUR_RATE">PEAK_PER_HOUR_RATE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents:
&nbsp;&nbsp;(a / b) * c
where:
&nbsp;&nbsp;a = the maximum value from a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds) over which the max value was collected
<BR>&nbsp;&nbsp;c = 3600000
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#PEAK_PER_MINUTE_RATE">PEAK_PER_MINUTE_RATE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents:
&nbsp;&nbsp;(a / b) * c
where:
&nbsp;&nbsp;a = the maximum value from a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds) over which the max value was collected
<BR>&nbsp;&nbsp;c = 60000
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#PEAK_PER_SECOND_RATE">PEAK_PER_SECOND_RATE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents:
&nbsp;&nbsp;(a / b) * c
where:
&nbsp;&nbsp;a = the maximum value from a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds) over which the max value was collected
<BR>&nbsp;&nbsp;c = 1000
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#PEAK_UTILIZATION">PEAK_UTILIZATION</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents:
&nbsp;&nbsp;(a / b) * c
where:
&nbsp;&nbsp;a = the maximum value from a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds) over which the max value was collected
<BR>&nbsp;&nbsp;c = 100</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#PER_HOUR_RATE">PER_HOUR_RATE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents:
&nbsp;&nbsp;(a / b) * c
where:
&nbsp;&nbsp;a = the total of all the values in a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds)
<BR>&nbsp;&nbsp;c = 3600000
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#PER_MINUTE_RATE">PER_MINUTE_RATE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents:
&nbsp;&nbsp;(a / b) * c
where:
&nbsp;&nbsp;a = the total of all the values in a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds)
<BR>&nbsp;&nbsp;c = 60000
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#PER_SECOND_RATE">PER_SECOND_RATE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents:
&nbsp;&nbsp;(a / b) * c
where:
&nbsp;&nbsp;a = the total of all the values in a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds)
<BR>&nbsp;&nbsp;c = 1000
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#TOTAL">TOTAL</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents the total of all the values in a set of historical values.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#UTILIZATION">UTILIZATION</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents:
&nbsp;&nbsp;(a / b) * c
where:
&nbsp;&nbsp;a = the total of all the values in a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds)
<BR>&nbsp;&nbsp;c = 100
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IValueType.html#VALUE">VALUE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A metric of this type repesents a value captured at a point in time.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="AVERAGE"><!-- --></A><H3>
AVERAGE</H3>
<PRE>
static final short <B>AVERAGE</B></PRE>
<DL>
<DD>A metric of this type repesents the average of all the values in a set of historical values.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.AVERAGE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="COUNT"><!-- --></A><H3>
COUNT</H3>
<PRE>
static final short <B>COUNT</B></PRE>
<DL>
<DD>A metric of this type repesents the number of times a value is updated.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.COUNT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DESCRIPTIONS"><!-- --></A><H3>
DESCRIPTIONS</H3>
<PRE>
static final java.lang.String[] <B>DESCRIPTIONS</B></PRE>
<DL>
<DD>A textual description of the value type may be obtained using a
value type as an index into the array.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IMetricInfo.html#getValueType()"><CODE>IMetricInfo.getValueType()</CODE></A></DL>
</DL>
<HR>
<A NAME="MAXIMUM"><!-- --></A><H3>
MAXIMUM</H3>
<PRE>
static final short <B>MAXIMUM</B></PRE>
<DL>
<DD>A metric of this type repesents the maximum value from a set of historical values.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.MAXIMUM">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MINIMUM"><!-- --></A><H3>
MINIMUM</H3>
<PRE>
static final short <B>MINIMUM</B></PRE>
<DL>
<DD>A metric of this type repesents the minimum value from a set of historical values.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.MINIMUM">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="NUM_VALUE_TYPES"><!-- --></A><H3>
NUM_VALUE_TYPES</H3>
<PRE>
static final int <B>NUM_VALUE_TYPES</B></PRE>
<DL>
<DD>The number of default value types
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.NUM_VALUE_TYPES">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PEAK_PER_HOUR_RATE"><!-- --></A><H3>
PEAK_PER_HOUR_RATE</H3>
<PRE>
static final short <B>PEAK_PER_HOUR_RATE</B></PRE>
<DL>
<DD>A metric of this type repesents:
<p>
&nbsp;&nbsp;(a / b) * c
<p>
where:
<p>&nbsp;&nbsp;a = the maximum value from a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds) over which the max value was collected
<BR>&nbsp;&nbsp;c = 3600000
</pre>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.PEAK_PER_HOUR_RATE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PEAK_PER_MINUTE_RATE"><!-- --></A><H3>
PEAK_PER_MINUTE_RATE</H3>
<PRE>
static final short <B>PEAK_PER_MINUTE_RATE</B></PRE>
<DL>
<DD>A metric of this type repesents:
<p>
&nbsp;&nbsp;(a / b) * c
<p>
where:
<p>&nbsp;&nbsp;a = the maximum value from a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds) over which the max value was collected
<BR>&nbsp;&nbsp;c = 60000
</pre>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.PEAK_PER_MINUTE_RATE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PEAK_PER_SECOND_RATE"><!-- --></A><H3>
PEAK_PER_SECOND_RATE</H3>
<PRE>
static final short <B>PEAK_PER_SECOND_RATE</B></PRE>
<DL>
<DD>A metric of this type repesents:
<p>
&nbsp;&nbsp;(a / b) * c
<p>
where:
<p>&nbsp;&nbsp;a = the maximum value from a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds) over which the max value was collected
<BR>&nbsp;&nbsp;c = 1000
</pre>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.PEAK_PER_SECOND_RATE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PEAK_UTILIZATION"><!-- --></A><H3>
PEAK_UTILIZATION</H3>
<PRE>
static final short <B>PEAK_UTILIZATION</B></PRE>
<DL>
<DD>A metric of this type repesents:
<p>
&nbsp;&nbsp;(a / b) * c
<p>
where:
<p>&nbsp;&nbsp;a = the maximum value from a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds) over which the max value was collected
<BR>&nbsp;&nbsp;c = 100
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.PEAK_UTILIZATION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PER_HOUR_RATE"><!-- --></A><H3>
PER_HOUR_RATE</H3>
<PRE>
static final short <B>PER_HOUR_RATE</B></PRE>
<DL>
<DD>A metric of this type repesents:
<p>
&nbsp;&nbsp;(a / b) * c
<p>
where:
<p>&nbsp;&nbsp;a = the total of all the values in a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds)
<BR>&nbsp;&nbsp;c = 3600000
</pre>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.PER_HOUR_RATE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PER_MINUTE_RATE"><!-- --></A><H3>
PER_MINUTE_RATE</H3>
<PRE>
static final short <B>PER_MINUTE_RATE</B></PRE>
<DL>
<DD>A metric of this type repesents:
<p>
&nbsp;&nbsp;(a / b) * c
<p>
where:
<p>&nbsp;&nbsp;a = the total of all the values in a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds)
<BR>&nbsp;&nbsp;c = 60000
</pre>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.PER_MINUTE_RATE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PER_SECOND_RATE"><!-- --></A><H3>
PER_SECOND_RATE</H3>
<PRE>
static final short <B>PER_SECOND_RATE</B></PRE>
<DL>
<DD>A metric of this type repesents:
<p>
&nbsp;&nbsp;(a / b) * c
<p>
where:
<p>&nbsp;&nbsp;a = the total of all the values in a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds)
<BR>&nbsp;&nbsp;c = 1000
</pre>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.PER_SECOND_RATE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="TOTAL"><!-- --></A><H3>
TOTAL</H3>
<PRE>
static final short <B>TOTAL</B></PRE>
<DL>
<DD>A metric of this type repesents the total of all the values in a set of historical values.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.TOTAL">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="UTILIZATION"><!-- --></A><H3>
UTILIZATION</H3>
<PRE>
static final short <B>UTILIZATION</B></PRE>
<DL>
<DD>A metric of this type repesents:
<p>
&nbsp;&nbsp;(a / b) * c
<p>
where:
<p>&nbsp;&nbsp;a = the total of all the values in a set of historical values
<BR>&nbsp;&nbsp;b = the elapsed time (milliseconds)
<BR>&nbsp;&nbsp;c = 100
</pre>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.UTILIZATION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="VALUE"><!-- --></A><H3>
VALUE</H3>
<PRE>
static final short <B>VALUE</B></PRE>
<DL>
<DD>A metric of this type repesents a value captured at a point in time.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.metrics.IValueType.VALUE">Constant Field Values</A></DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IValueType.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="MetricsFactory.html" title="class in com.sonicsw.mf.common.metrics"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FIValueType.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IValueType.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IValueType.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IValueType.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,560 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
MetricsFactory (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics.MetricsFactory class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="MetricsFactory (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="MetricsFactory.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IValueType.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FMetricsFactory.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MetricsFactory.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MetricsFactory.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MetricsFactory.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MetricsFactory.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MetricsFactory.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.metrics</FONT>
<BR>
Class MetricsFactory</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.mf.common.metrics.MetricsFactory</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>MetricsFactory</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Component developers are required to use the factory to create instances of implementations
of the core metrics interfaces (of this pakage). The exception to this rule is that component
developers can create their own IMetricsManager implementation - however the preferred model is
to use the default manager provided by this factory.
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="MetricsFactory.html#MetricsFactory()">MetricsFactory</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics">IAlert</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MetricsFactory.html#createAlert(com.sonicsw.mf.common.metrics.IMetricIdentity, boolean, long)">createAlert</A></B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;metricId,
boolean&nbsp;isHighThreshold,
long&nbsp;threshold)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an Alert object</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics">IAlert</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="MetricsFactory.html#createAlerts(com.sonicsw.mf.common.metrics.IMetricIdentity, boolean, java.lang.String)">createAlerts</A></B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;metricId,
boolean&nbsp;isHighThreshold,
java.lang.String&nbsp;thresholds)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an array of Alert objects from a comma delimited threshold string</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MetricsFactory.html#createMetric(com.sonicsw.mf.common.metrics.IMetricIdentity, long, long)">createMetric</A></B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;id,
long&nbsp;value,
long&nbsp;currencyTimestamp)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a metric that encapsulates the metric identity and its value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IAggregateMetric.html" title="interface in com.sonicsw.mf.common.metrics">IAggregateMetric</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MetricsFactory.html#createMetric(java.lang.String[], com.sonicsw.mf.common.metrics.IMetricIdentity, long[], long)">createMetric</A></B>(java.lang.String[]&nbsp;sources,
<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;id,
long[]&nbsp;values,
long&nbsp;currencyTimestamp)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an aggregate metric that encapsulates the metric identity, its aggregate values and the sources
that contributed to the aggregated value of the metric.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics">IHistoricalMetric</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MetricsFactory.html#createMetric(java.lang.String, com.sonicsw.mf.common.metrics.IMetric)">createMetric</A></B>(java.lang.String&nbsp;source,
<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A>&nbsp;metric)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a historical metric that encapsulates the metric identity, its value and the source
of the metric.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MetricsFactory.html#createMetricIdentity(com.sonicsw.mf.common.metrics.IMetricIdentity, java.lang.String)">createMetricIdentity</A></B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;parentID,
java.lang.String&nbsp;nameComponent)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a metric identity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MetricsFactory.html#createMetricIdentity(java.lang.String)">createMetricIdentity</A></B>(java.lang.String&nbsp;absoluteName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a metric identity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MetricsFactory.html#createMetricIdentity(java.lang.String[])">createMetricIdentity</A></B>(java.lang.String[]&nbsp;nameComponents)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a metric identity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IMetricInfo.html" title="interface in com.sonicsw.mf.common.metrics">IMetricInfo</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MetricsFactory.html#createMetricInfo(com.sonicsw.mf.common.metrics.IMetricIdentity, short, java.lang.String, java.lang.String, boolean, boolean)">createMetricInfo</A></B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;id,
short&nbsp;valueType,
java.lang.String&nbsp;description,
java.lang.String&nbsp;extendedDataData,
boolean&nbsp;isInstanceMetric,
boolean&nbsp;isDynamic)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a info object that encapsulates the meta-data pertaining to an individual metric
or instance metric.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IMetricInfo.html" title="interface in com.sonicsw.mf.common.metrics">IMetricInfo</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MetricsFactory.html#createMetricInfo(com.sonicsw.mf.common.metrics.IMetricIdentity, short, java.lang.String, java.lang.String, boolean, boolean, boolean, boolean, java.lang.String)">createMetricInfo</A></B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;id,
short&nbsp;valueType,
java.lang.String&nbsp;description,
java.lang.String&nbsp;extendedDataData,
boolean&nbsp;isInstanceMetric,
boolean&nbsp;isDynamic,
boolean&nbsp;supportsHighAlerts,
boolean&nbsp;supportsLowAlerts,
java.lang.String&nbsp;units)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a info object that encapsulates the meta-data pertaining to an individual metric
or instance metric.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IAggregateMetricsData.html" title="interface in com.sonicsw.mf.common.metrics">IAggregateMetricsData</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MetricsFactory.html#createMetricsData(com.sonicsw.mf.common.metrics.IAggregateMetric[], long)">createMetricsData</A></B>(<A HREF="IAggregateMetric.html" title="interface in com.sonicsw.mf.common.metrics">IAggregateMetric</A>[]&nbsp;metrics,
long&nbsp;currencyTimestamp)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an aggregate metrics data object that encapsulates the given aggregrate metrics.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="IMetricsData.html" title="interface in com.sonicsw.mf.common.metrics">IMetricsData</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="MetricsFactory.html#createMetricsData(com.sonicsw.mf.common.metrics.IMetric[], long)">createMetricsData</A></B>(<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A>[]&nbsp;metrics,
long&nbsp;currencyTimestamp)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a metrics data object that encapsulates the given metrics.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="MetricsFactory()"><!-- --></A><H3>
MetricsFactory</H3>
<PRE>
public <B>MetricsFactory</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="createAlert(com.sonicsw.mf.common.metrics.IMetricIdentity, boolean, long)"><!-- --></A><H3>
createAlert</H3>
<PRE>
public static <A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics">IAlert</A> <B>createAlert</B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;metricId,
boolean&nbsp;isHighThreshold,
long&nbsp;threshold)</PRE>
<DL>
<DD>Creates an Alert object
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>IMetricIdentity</CODE> - id The metric id this alert is associated with<DD><CODE>isHighThreshold</CODE> - Whether this is a high or low threshold<DD><CODE>threshold</CODE> - The threshold to set the alert to</DL>
</DD>
</DL>
<HR>
<A NAME="createAlerts(com.sonicsw.mf.common.metrics.IMetricIdentity, boolean, java.lang.String)"><!-- --></A><H3>
createAlerts</H3>
<PRE>
public static <A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics">IAlert</A>[] <B>createAlerts</B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;metricId,
boolean&nbsp;isHighThreshold,
java.lang.String&nbsp;thresholds)</PRE>
<DL>
<DD>Creates an array of Alert objects from a comma delimited threshold string
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>IMetricIdentity</CODE> - id The metric id these alert are associated with<DD><CODE>isHighThreshold</CODE> - Whether these are high or low thresholds<DD><CODE>threshold</CODE> - A comma delimited list of threshold values</DL>
</DD>
</DL>
<HR>
<A NAME="createMetric(com.sonicsw.mf.common.metrics.IMetricIdentity, long, long)"><!-- --></A><H3>
createMetric</H3>
<PRE>
public static <A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A> <B>createMetric</B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;id,
long&nbsp;value,
long&nbsp;currencyTimestamp)</PRE>
<DL>
<DD>Returns a metric that encapsulates the metric identity and its value.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="createMetric(java.lang.String[], com.sonicsw.mf.common.metrics.IMetricIdentity, long[], long)"><!-- --></A><H3>
createMetric</H3>
<PRE>
public static <A HREF="IAggregateMetric.html" title="interface in com.sonicsw.mf.common.metrics">IAggregateMetric</A> <B>createMetric</B>(java.lang.String[]&nbsp;sources,
<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;id,
long[]&nbsp;values,
long&nbsp;currencyTimestamp)</PRE>
<DL>
<DD>Returns an aggregate metric that encapsulates the metric identity, its aggregate values and the sources
that contributed to the aggregated value of the metric. For use by the framework and not
application components.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="createMetric(java.lang.String, com.sonicsw.mf.common.metrics.IMetric)"><!-- --></A><H3>
createMetric</H3>
<PRE>
public static <A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics">IHistoricalMetric</A> <B>createMetric</B>(java.lang.String&nbsp;source,
<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A>&nbsp;metric)</PRE>
<DL>
<DD>Returns a historical metric that encapsulates the metric identity, its value and the source
of the metric. For use by the framework and not application components.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="createMetricIdentity(com.sonicsw.mf.common.metrics.IMetricIdentity, java.lang.String)"><!-- --></A><H3>
createMetricIdentity</H3>
<PRE>
public static <A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A> <B>createMetricIdentity</B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;parentID,
java.lang.String&nbsp;nameComponent)</PRE>
<DL>
<DD>Returns a metric identity. The values supplied should be valid for the life cycle of the
component.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parentID</CODE> - The metric identity of the parent.<DD><CODE>nameComponent</CODE> - The name component of the child of the parent. Special characters '.'
and '\' are treated as part of the name component rather than as further
delimiting.</DL>
</DD>
</DL>
<HR>
<A NAME="createMetricIdentity(java.lang.String)"><!-- --></A><H3>
createMetricIdentity</H3>
<PRE>
public static <A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A> <B>createMetricIdentity</B>(java.lang.String&nbsp;absoluteName)</PRE>
<DL>
<DD>Returns a metric identity. The values supplied should be valid for the life cycle of the
component.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>absoluteName</CODE> - An a period '.' delimited string that describe the path of the metric in
in the components tree of metrics (each token representing a component
of the metric name). If a component of a metric name contains periods '.'
or percents '%' then those should be escaped by a percent e.g. "%."</DL>
</DD>
</DL>
<HR>
<A NAME="createMetricIdentity(java.lang.String[])"><!-- --></A><H3>
createMetricIdentity</H3>
<PRE>
public static <A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A> <B>createMetricIdentity</B>(java.lang.String[]&nbsp;nameComponents)</PRE>
<DL>
<DD>Returns a metric identity. The values supplied should be valid for the life cycle of the
component.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nameCompnents</CODE> - An array of strings that describe the path of the metric in
in the components tree of metrics.</DL>
</DD>
</DL>
<HR>
<A NAME="createMetricInfo(com.sonicsw.mf.common.metrics.IMetricIdentity, short, java.lang.String, java.lang.String, boolean, boolean)"><!-- --></A><H3>
createMetricInfo</H3>
<PRE>
public static <A HREF="IMetricInfo.html" title="interface in com.sonicsw.mf.common.metrics">IMetricInfo</A> <B>createMetricInfo</B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;id,
short&nbsp;valueType,
java.lang.String&nbsp;description,
java.lang.String&nbsp;extendedDataData,
boolean&nbsp;isInstanceMetric,
boolean&nbsp;isDynamic)</PRE>
<DL>
<DD>Returns a info object that encapsulates the meta-data pertaining to an individual metric
or instance metric. Does not specify alerts.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="MetricsFactory.html#createMetricInfo(com.sonicsw.mf.common.metrics.IMetricIdentity, short, java.lang.String, java.lang.String, boolean, boolean, boolean, boolean, java.lang.String)"><CODE>createMetricInfo(IMetricIdentity, short, String, String, boolean, boolean, boolean, boolean, String)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="createMetricInfo(com.sonicsw.mf.common.metrics.IMetricIdentity, short, java.lang.String, java.lang.String, boolean, boolean, boolean, boolean, java.lang.String)"><!-- --></A><H3>
createMetricInfo</H3>
<PRE>
public static <A HREF="IMetricInfo.html" title="interface in com.sonicsw.mf.common.metrics">IMetricInfo</A> <B>createMetricInfo</B>(<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A>&nbsp;id,
short&nbsp;valueType,
java.lang.String&nbsp;description,
java.lang.String&nbsp;extendedDataData,
boolean&nbsp;isInstanceMetric,
boolean&nbsp;isDynamic,
boolean&nbsp;supportsHighAlerts,
boolean&nbsp;supportsLowAlerts,
java.lang.String&nbsp;units)</PRE>
<DL>
<DD>Returns a info object that encapsulates the meta-data pertaining to an individual metric
or instance metric.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The metric identity.<DD><CODE>valueType</CODE> - The metric value type (see IValueType defined types).<DD><CODE>description</CODE> - The optional free form description of the metric.<DD><CODE>extendedDataData</CODE> - The optional free form data associated with the metric.<DD><CODE>isInstanceMetric</CODE> - Indicates the meta-data describes metrics that are parented by the instance metric.<DD><CODE>isDynamic</CODE> - Indicates the metric can be enabled/disabled at runtime.<DD><CODE>supportsHighAlerts</CODE> - Indicates the metric supports high threshold alerts.<DD><CODE>supportsLowAlerts</CODE> - Indicates the metric supports low threshold alerts.<DD><CODE>units</CODE> - The units that this metric uses.<DT><B>See Also:</B><DD><A HREF="MetricsFactory.html#createMetricInfo(com.sonicsw.mf.common.metrics.IMetricIdentity, short, java.lang.String, java.lang.String, boolean, boolean)"><CODE>createMetricInfo(IMetricIdentity, short, String, String, boolean, boolean)</CODE></A>,
<A HREF="IValueType.html" title="interface in com.sonicsw.mf.common.metrics"><CODE>IValueType</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="createMetricsData(com.sonicsw.mf.common.metrics.IAggregateMetric[], long)"><!-- --></A><H3>
createMetricsData</H3>
<PRE>
public static <A HREF="IAggregateMetricsData.html" title="interface in com.sonicsw.mf.common.metrics">IAggregateMetricsData</A> <B>createMetricsData</B>(<A HREF="IAggregateMetric.html" title="interface in com.sonicsw.mf.common.metrics">IAggregateMetric</A>[]&nbsp;metrics,
long&nbsp;currencyTimestamp)</PRE>
<DL>
<DD>Returns an aggregate metrics data object that encapsulates the given aggregrate metrics. The currency timestamp
of the metrics data object will be set to the provided value.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="createMetricsData(com.sonicsw.mf.common.metrics.IMetric[], long)"><!-- --></A><H3>
createMetricsData</H3>
<PRE>
public static <A HREF="IMetricsData.html" title="interface in com.sonicsw.mf.common.metrics">IMetricsData</A> <B>createMetricsData</B>(<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A>[]&nbsp;metrics,
long&nbsp;currencyTimestamp)</PRE>
<DL>
<DD>Returns a metrics data object that encapsulates the given metrics. The currency timestamp
of the metrics data object will be set to the provided value.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="MetricsFactory.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IValueType.html" title="interface in com.sonicsw.mf.common.metrics"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252FMetricsFactory.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="MetricsFactory.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MetricsFactory.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="MetricsFactory.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="MetricsFactory.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="MetricsFactory.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,61 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.mf.common.metrics (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<FONT size="+1" CLASS="FrameTitleFont">
<A HREF="package-summary.html" target="classFrame">com.sonicsw.mf.common.metrics</A></FONT>
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
<TR>
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
Interfaces</FONT>&nbsp;
<FONT CLASS="FrameItemFont">
<BR>
<A HREF="IAggregateMetric.html" title="interface in com.sonicsw.mf.common.metrics" target="classFrame"><I>IAggregateMetric</I></A>
<BR>
<A HREF="IAggregateMetricsData.html" title="interface in com.sonicsw.mf.common.metrics" target="classFrame"><I>IAggregateMetricsData</I></A>
<BR>
<A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics" target="classFrame"><I>IAlert</I></A>
<BR>
<A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics" target="classFrame"><I>IHistoricalMetric</I></A>
<BR>
<A HREF="IHistoricalMetricsData.html" title="interface in com.sonicsw.mf.common.metrics" target="classFrame"><I>IHistoricalMetricsData</I></A>
<BR>
<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics" target="classFrame"><I>IMetric</I></A>
<BR>
<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics" target="classFrame"><I>IMetricIdentity</I></A>
<BR>
<A HREF="IMetricInfo.html" title="interface in com.sonicsw.mf.common.metrics" target="classFrame"><I>IMetricInfo</I></A>
<BR>
<A HREF="IMetricsData.html" title="interface in com.sonicsw.mf.common.metrics" target="classFrame"><I>IMetricsData</I></A>
<BR>
<A HREF="IValueType.html" title="interface in com.sonicsw.mf.common.metrics" target="classFrame"><I>IValueType</I></A></FONT></TD>
</TR>
</TABLE>
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
<TR>
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
Classes</FONT>&nbsp;
<FONT CLASS="FrameItemFont">
<BR>
<A HREF="MetricsFactory.html" title="class in com.sonicsw.mf.common.metrics" target="classFrame">MetricsFactory</A></FONT></TD>
</TR>
</TABLE>
</BODY>
</HTML>
@@ -0,0 +1,210 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.mf.common.metrics (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.metrics package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="com.sonicsw.mf.common.metrics (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="package-summary.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../runtime/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252Fpackage-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package com.sonicsw.mf.common.metrics
</H2>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IAggregateMetric.html" title="interface in com.sonicsw.mf.common.metrics">IAggregateMetric</A></B></TD>
<TD>An AggregatedMetric extends the basic metric by encapsulating the sources
of the metrics from which the aggregate metric value was derived.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IAggregateMetricsData.html" title="interface in com.sonicsw.mf.common.metrics">IAggregateMetricsData</A></B></TD>
<TD>Classes that implement this interface encapsulate multiple metrics and their runtime
value at a particular collection time.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics">IAlert</A></B></TD>
<TD>An alert defines a high or low threshold value for a particular metric.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics">IHistoricalMetric</A></B></TD>
<TD>A HistoricalMetric extends the basic metric by encapsulating the source of the metric.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IHistoricalMetricsData.html" title="interface in com.sonicsw.mf.common.metrics">IHistoricalMetricsData</A></B></TD>
<TD>Classes that implement this interface encapsulate multiple metrics and their runtime
value at a particular collection time.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A></B></TD>
<TD>A metric provides the numeric value of a metric identity (as captured at some point
in time).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics">IMetricIdentity</A></B></TD>
<TD>Individual metrics are identified as leaves in a tree.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IMetricInfo.html" title="interface in com.sonicsw.mf.common.metrics">IMetricInfo</A></B></TD>
<TD>A metric info object provides meta-data about one of the following:
an instance metric parent (e.g.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IMetricsData.html" title="interface in com.sonicsw.mf.common.metrics">IMetricsData</A></B></TD>
<TD>Classes that implement this interface encapsulate multiple metrics and their runtime
value at a particular collection time.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IValueType.html" title="interface in com.sonicsw.mf.common.metrics">IValueType</A></B></TD>
<TD>Metric values are one of the types described in this interface.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MetricsFactory.html" title="class in com.sonicsw.mf.common.metrics">MetricsFactory</A></B></TD>
<TD>Component developers are required to use the factory to create instances of implementations
of the core metrics interfaces (of this pakage).</TD>
</TR>
</TABLE>
&nbsp;
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="package-summary.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../runtime/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252Fpackage-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,158 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.mf.common.metrics Class Hierarchy (Management Application API)
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="com.sonicsw.mf.common.metrics Class Hierarchy (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="package-tree.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../package-tree.html"><B>PREV</B></A>&nbsp;
&nbsp;<A HREF="../runtime/package-tree.html"><B>NEXT</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252Fpackage-tree.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<CENTER>
<H2>
Hierarchy For Package com.sonicsw.mf.common.metrics
</H2>
</CENTER>
<DL>
<DT><B>Package Hierarchies:</B><DD><A HREF="../../../../../overview-tree.html">All Packages</A></DL>
<HR>
<H2>
Class Hierarchy
</H2>
<UL>
<LI TYPE="circle">java.lang.Object<UL>
<LI TYPE="circle">com.sonicsw.mf.common.metrics.<A HREF="MetricsFactory.html" title="class in com.sonicsw.mf.common.metrics"><B>MetricsFactory</B></A></UL>
</UL>
<H2>
Interface Hierarchy
</H2>
<UL>
<LI TYPE="circle">com.sonicsw.mf.common.metrics.<A HREF="IAlert.html" title="interface in com.sonicsw.mf.common.metrics"><B>IAlert</B></A><LI TYPE="circle">com.sonicsw.mf.common.metrics.<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>IMetric</B></A><UL>
<LI TYPE="circle">com.sonicsw.mf.common.metrics.<A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>IHistoricalMetric</B></A> (also extends java.io.Serializable)
</UL>
<LI TYPE="circle">com.sonicsw.mf.common.metrics.<A HREF="IValueType.html" title="interface in com.sonicsw.mf.common.metrics"><B>IValueType</B></A><LI TYPE="circle">java.io.Serializable<UL>
<LI TYPE="circle">com.sonicsw.mf.common.metrics.<A HREF="IAggregateMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>IAggregateMetric</B></A><LI TYPE="circle">com.sonicsw.mf.common.metrics.<A HREF="IAggregateMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>IAggregateMetricsData</B></A><LI TYPE="circle">com.sonicsw.mf.common.metrics.<A HREF="IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics"><B>IHistoricalMetric</B></A> (also extends com.sonicsw.mf.common.metrics.<A HREF="IMetric.html" title="interface in com.sonicsw.mf.common.metrics">IMetric</A>)
<LI TYPE="circle">com.sonicsw.mf.common.metrics.<A HREF="IHistoricalMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>IHistoricalMetricsData</B></A><LI TYPE="circle">com.sonicsw.mf.common.metrics.<A HREF="IMetricIdentity.html" title="interface in com.sonicsw.mf.common.metrics"><B>IMetricIdentity</B></A><LI TYPE="circle">com.sonicsw.mf.common.metrics.<A HREF="IMetricInfo.html" title="interface in com.sonicsw.mf.common.metrics"><B>IMetricInfo</B></A><LI TYPE="circle">com.sonicsw.mf.common.metrics.<A HREF="IMetricsData.html" title="interface in com.sonicsw.mf.common.metrics"><B>IMetricsData</B></A></UL>
</UL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="package-tree.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../package-tree.html"><B>PREV</B></A>&nbsp;
&nbsp;<A HREF="../runtime/package-tree.html"><B>NEXT</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fmetrics%252Fpackage-tree.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,36 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.mf.common (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<FONT size="+1" CLASS="FrameTitleFont">
<A HREF="package-summary.html" target="classFrame">com.sonicsw.mf.common</A></FONT>
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
<TR>
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
Exceptions</FONT>&nbsp;
<FONT CLASS="FrameItemFont">
<BR>
<A HREF="MFException.html" title="class in com.sonicsw.mf.common" target="classFrame">MFException</A>
<BR>
<A HREF="MFRuntimeException.html" title="class in com.sonicsw.mf.common" target="classFrame">MFRuntimeException</A>
<BR>
<A HREF="MFSecurityException.html" title="class in com.sonicsw.mf.common" target="classFrame">MFSecurityException</A></FONT></TD>
</TR>
</TABLE>
</BODY>
</HTML>
@@ -0,0 +1,160 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.mf.common (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="com.sonicsw.mf.common (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="package-summary.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../ma/mgmtapi/config/impl/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="metrics/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fpackage-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package com.sonicsw.mf.common
</H2>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Exception Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MFException.html" title="class in com.sonicsw.mf.common">MFException</A></B></TD>
<TD>Checked management exception.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MFRuntimeException.html" title="class in com.sonicsw.mf.common">MFRuntimeException</A></B></TD>
<TD>Unchecked management exception.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MFSecurityException.html" title="class in com.sonicsw.mf.common">MFSecurityException</A></B></TD>
<TD>Unchecked management security exception.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="package-summary.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../ma/mgmtapi/config/impl/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="metrics/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fpackage-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,158 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.mf.common Class Hierarchy (Management Application API)
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="com.sonicsw.mf.common Class Hierarchy (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="package-tree.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../ma/mgmtapi/config/impl/package-tree.html"><B>PREV</B></A>&nbsp;
&nbsp;<A HREF="metrics/package-tree.html"><B>NEXT</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fpackage-tree.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<CENTER>
<H2>
Hierarchy For Package com.sonicsw.mf.common
</H2>
</CENTER>
<DL>
<DT><B>Package Hierarchies:</B><DD><A HREF="../../../../overview-tree.html">All Packages</A></DL>
<HR>
<H2>
Class Hierarchy
</H2>
<UL>
<LI TYPE="circle">java.lang.Object<UL>
<LI TYPE="circle">java.lang.Throwable (implements java.io.Serializable)
<UL>
<LI TYPE="circle">java.lang.Exception<UL>
<LI TYPE="circle">com.sonicsw.mf.common.<A HREF="MFException.html" title="class in com.sonicsw.mf.common"><B>MFException</B></A> (implements java.io.Serializable)
<LI TYPE="circle">java.lang.RuntimeException<UL>
<LI TYPE="circle">com.sonicsw.mf.common.<A HREF="MFRuntimeException.html" title="class in com.sonicsw.mf.common"><B>MFRuntimeException</B></A> (implements java.io.Serializable)
<UL>
<LI TYPE="circle">com.sonicsw.mf.common.<A HREF="MFSecurityException.html" title="class in com.sonicsw.mf.common"><B>MFSecurityException</B></A></UL>
</UL>
</UL>
</UL>
</UL>
</UL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="package-tree.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../ma/mgmtapi/config/impl/package-tree.html"><B>PREV</B></A>&nbsp;
&nbsp;<A HREF="metrics/package-tree.html"><B>NEXT</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fpackage-tree.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,263 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IBackupStatus (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IBackupStatus interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IBackupStatus (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IBackupStatus.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="ICanonicalName.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIBackupStatus.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IBackupStatus.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IBackupStatus.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IBackupStatus.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IBackupStatus</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IBackupStatus</B></DL>
</PRE>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IBackupStatus.html#getCompletionTime()">getCompletionTime</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IBackupStatus.html#getLocation()">getLocation</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IBackupStatus.html#getStartTime()">getStartTime</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IBackupStatus.html#isInProgress()">isInProgress</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getCompletionTime()"><!-- --></A><H3>
getCompletionTime</H3>
<PRE>
long <B>getCompletionTime</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>The finish time of the last backup in milliseconds. -1 if a backup has not been run
or the last backup was not successful.</DL>
</DD>
</DL>
<HR>
<A NAME="getLocation()"><!-- --></A><H3>
getLocation</H3>
<PRE>
java.lang.String <B>getLocation</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>The location of the last backup. Empty string if no backup has been run.</DL>
</DD>
</DL>
<HR>
<A NAME="getStartTime()"><!-- --></A><H3>
getStartTime</H3>
<PRE>
long <B>getStartTime</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>The start time of the last backup in milliseconds. -1 if no backup has been run.</DL>
</DD>
</DL>
<HR>
<A NAME="isInProgress()"><!-- --></A><H3>
isInProgress</H3>
<PRE>
boolean <B>isInProgress</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>true if the backup is still running, false if it isn't.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IBackupStatus.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="ICanonicalName.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIBackupStatus.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IBackupStatus.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IBackupStatus.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IBackupStatus.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,348 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
ICanonicalName (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.ICanonicalName interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="ICanonicalName (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="ICanonicalName.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IBackupStatus.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IChildContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FICanonicalName.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ICanonicalName.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="ICanonicalName.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="ICanonicalName.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface ICanonicalName</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.lang.Comparable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>ICanonicalName</B><DT>extends java.lang.Comparable</DL>
</PRE>
<P>
The implmentation of this interface represents the canonical name form
of a container ot component.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="ICanonicalName.html#compareTo(java.lang.Object)">compareTo</A></B>(java.lang.Object&nbsp;object)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares this object with the specified object for order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="ICanonicalName.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;object)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests if the given object is equal to this canonical name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="ICanonicalName.html#getCanonicalName()">getCanonicalName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the full composite name of the instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="ICanonicalName.html#getComponentName()">getComponentName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the component ID within the container (if the canonical name represents a component).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="ICanonicalName.html#getContainerName()">getContainerName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the container name within the domain.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="ICanonicalName.html#getDomainName()">getDomainName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the domain name to which the instance belongs.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
compareTo</H3>
<PRE>
int <B>compareTo</B>(java.lang.Object&nbsp;object)
throws java.lang.ClassCastException</PRE>
<DL>
<DD>Compares this object with the specified object for order. Returns a negative integer,
zero, or a positive integer as this object is less than, equal to, or greater than
the specified object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.lang.ClassCastException</CODE> - If the given object is not an instance of an ICanonicalName</DL>
</DD>
</DL>
<HR>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
boolean <B>equals</B>(java.lang.Object&nbsp;object)</PRE>
<DL>
<DD>Tests if the given object is equal to this canonical name.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>Returns true if the canonical name of this object equals that of the given object.
Returns false if the given object is not an instance of ICanonicalName or the
stringified names match.</DL>
</DD>
</DL>
<HR>
<A NAME="getCanonicalName()"><!-- --></A><H3>
getCanonicalName</H3>
<PRE>
java.lang.String <B>getCanonicalName</B>()</PRE>
<DL>
<DD>Gets the full composite name of the instance. The canonical name
will vary depending upon the instance implementation, for example:
<p>
<ul>
<li>a containers cananocial name might be: "Sonic.Container"
<li>a components cananocial name might be: "Sonic.Container:ID=SonicMQ"
</ul>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getComponentName()"><!-- --></A><H3>
getComponentName</H3>
<PRE>
java.lang.String <B>getComponentName</B>()</PRE>
<DL>
<DD>Get the component ID within the container (if the canonical name represents a component).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getContainerName()"><!-- --></A><H3>
getContainerName</H3>
<PRE>
java.lang.String <B>getContainerName</B>()</PRE>
<DL>
<DD>Get the container name within the domain.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDomainName()"><!-- --></A><H3>
getDomainName</H3>
<PRE>
java.lang.String <B>getDomainName</B>()</PRE>
<DL>
<DD>Get the domain name to which the instance belongs.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="ICanonicalName.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IBackupStatus.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IChildContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FICanonicalName.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ICanonicalName.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="ICanonicalName.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="ICanonicalName.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,400 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IChildContainerState (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IChildContainerState interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IChildContainerState (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IChildContainerState.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="ICanonicalName.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="ICollectiveOpStatus.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIChildContainerState.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IChildContainerState.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IChildContainerState.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IChildContainerState.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IChildContainerState.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IChildContainerState.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IChildContainerState</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.lang.Comparable, <A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime">IState</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IChildContainerState</B><DT>extends <A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime">IState</A></DL>
</PRE>
<P>
The implmentation of this interface represents the state of a child container
managed by an Activation Daemon.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/jmx/client/IActivationDaemonProxy.html#getChildStates()" title="class or interface in com.sonicsw.mf.jmx.client"><CODE>IActivationDaemonProxy</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IChildContainerState.html#STATE_INACTIVE">STATE_INACTIVE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the child container is inan inactive state (there are no schedules that indicate the child container should be running).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IChildContainerState.html#STATE_OFFLINE">STATE_OFFLINE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the child container is offline.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IChildContainerState.html#STATE_ONLINE">STATE_ONLINE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the child container is online (in operational state).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IChildContainerState.html#STATE_TEXT">STATE_TEXT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Textual representations of child container states (indexed by STATE_<> values).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IChildContainerState.html#STATE_UNKNOWN">STATE_UNKNOWN</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the child container state cannot be determined.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Integer</CODE></FONT></TD>
<TD><CODE><B><A HREF="IChildContainerState.html#getExitCode()">getExitCode</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the last known exit code of the child container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IChildContainerState.html#getLogTail()">getLogTail</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the tail of the child containers stdout/stderr.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IChildContainerState.html#getTimeStamp()">getTimeStamp</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the time the state value was captured.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.runtime.IState"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.mf.common.runtime.<A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime">IState</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="IState.html#compareTo(java.lang.Object)">compareTo</A>, <A HREF="IState.html#equals(java.lang.Object)">equals</A>, <A HREF="IState.html#getRuntimeIdentity()">getRuntimeIdentity</A>, <A HREF="IState.html#getState()">getState</A>, <A HREF="IState.html#getStateString()">getStateString</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="STATE_INACTIVE"><!-- --></A><H3>
STATE_INACTIVE</H3>
<PRE>
static final short <B>STATE_INACTIVE</B></PRE>
<DL>
<DD>Indicates the child container is inan inactive state (there are no schedules that indicate the child container should be running).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IChildContainerState.STATE_INACTIVE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_OFFLINE"><!-- --></A><H3>
STATE_OFFLINE</H3>
<PRE>
static final short <B>STATE_OFFLINE</B></PRE>
<DL>
<DD>Indicates the child container is offline.
The child container is either not contactable or a shutdown/deactivate
has triggered the offline state.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IChildContainerState.STATE_OFFLINE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_ONLINE"><!-- --></A><H3>
STATE_ONLINE</H3>
<PRE>
static final short <B>STATE_ONLINE</B></PRE>
<DL>
<DD>Indicates the child container is online (in operational state).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IChildContainerState.STATE_ONLINE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_TEXT"><!-- --></A><H3>
STATE_TEXT</H3>
<PRE>
static final java.lang.String[] <B>STATE_TEXT</B></PRE>
<DL>
<DD>Textual representations of child container states (indexed by STATE_<> values).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="STATE_UNKNOWN"><!-- --></A><H3>
STATE_UNKNOWN</H3>
<PRE>
static final short <B>STATE_UNKNOWN</B></PRE>
<DL>
<DD>Indicates the child container state cannot be determined.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IChildContainerState.STATE_UNKNOWN">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getExitCode()"><!-- --></A><H3>
getExitCode</H3>
<PRE>
java.lang.Integer <B>getExitCode</B>()</PRE>
<DL>
<DD>Gets the last known exit code of the child container.
<p>
The exit code will be recorded when the child container is shutdown, deactivated
or fails.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The child container exit code or null if the child container has never been launched/activated.
Exit codes are defined in IContainerExitCodes.<DT><B>See Also:</B><DD><A HREF="IContainerExitCodes.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IContainerExitCodes</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getLogTail()"><!-- --></A><H3>
getLogTail</H3>
<PRE>
java.lang.String[] <B>getLogTail</B>()</PRE>
<DL>
<DD>Gets the tail of the child containers stdout/stderr.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The tail of messages/exceptions logged by the child container or null if the child container
has never been launched/activated.</DL>
</DD>
</DL>
<HR>
<A NAME="getTimeStamp()"><!-- --></A><H3>
getTimeStamp</H3>
<PRE>
long <B>getTimeStamp</B>()</PRE>
<DL>
<DD>Get the time the state value was captured.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IChildContainerState.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="ICanonicalName.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="ICollectiveOpStatus.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIChildContainerState.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IChildContainerState.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IChildContainerState.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IChildContainerState.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IChildContainerState.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IChildContainerState.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,301 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
ICollectiveOpStatus (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.ICollectiveOpStatus interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="ICollectiveOpStatus (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="ICollectiveOpStatus.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IChildContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FICollectiveOpStatus.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ICollectiveOpStatus.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="ICollectiveOpStatus.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="ICollectiveOpStatus.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface ICollectiveOpStatus</H2>
<HR>
<DL>
<DT><PRE>public interface <B>ICollectiveOpStatus</B></DL>
</PRE>
<P>
Contains the status of a collective invocation of an operation or a collective setup of an attribute.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../mgmtapi/runtime/IAgentManagerProxy.html" title="interface in com.sonicsw.mf.mgmtapi.runtime"><CODE>IAgentManagerProxy</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="ICollectiveOpStatus.html#getComponentName(int)">getComponentName</A></B>(int&nbsp;compNum)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of the compNum-th component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="ICollectiveOpStatus.html#getCount()">getCount</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of collection components that were operated on.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="ICollectiveOpStatus.html#getReturnValue(int)">getReturnValue</A></B>(int&nbsp;compNum)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the return value of the compNum-th operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Throwable</CODE></FONT></TD>
<TD><CODE><B><A HREF="ICollectiveOpStatus.html#getThrowable(int)">getThrowable</A></B>(int&nbsp;compNum)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the throwable object of a failed compNum-th operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="ICollectiveOpStatus.html#operationIsSuccessful(int)">operationIsSuccessful</A></B>(int&nbsp;compNum)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the operation on the compNum-th component was successful.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getComponentName(int)"><!-- --></A><H3>
getComponentName</H3>
<PRE>
java.lang.String <B>getComponentName</B>(int&nbsp;compNum)</PRE>
<DL>
<DD>Returns the name of the compNum-th component. The name is the same as would be returned from
com.sonicsw.mf.common.runtime.IComponentIdentity.getCanonicalName.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>compNum</CODE> - the position of the component in the list
<DT><B>Returns:</B><DD>the name of the compNum-th component</DL>
</DD>
</DL>
<HR>
<A NAME="getCount()"><!-- --></A><H3>
getCount</H3>
<PRE>
int <B>getCount</B>()</PRE>
<DL>
<DD>Returns the number of collection components that were operated on.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the number of collection components</DL>
</DD>
</DL>
<HR>
<A NAME="getReturnValue(int)"><!-- --></A><H3>
getReturnValue</H3>
<PRE>
java.lang.Object <B>getReturnValue</B>(int&nbsp;compNum)</PRE>
<DL>
<DD>Returns the return value of the compNum-th operation.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>compNum</CODE> - the position of the component in the list
<DT><B>Returns:</B><DD>the return value of the compNum-th operation. null is returned if it's a void method (or an attribute setup).
null is also returned if operationIsSuccessful(compNum) returns false.</DL>
</DD>
</DL>
<HR>
<A NAME="getThrowable(int)"><!-- --></A><H3>
getThrowable</H3>
<PRE>
java.lang.Throwable <B>getThrowable</B>(int&nbsp;compNum)</PRE>
<DL>
<DD>Returns the throwable object of a failed compNum-th operation.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>compNum</CODE> - the position of the component in the list
<DT><B>Returns:</B><DD>Returns the throwable object of a failed compNum-th operation.
null is also returned if operationIsSuccessful(compNum) returns true.</DL>
</DD>
</DL>
<HR>
<A NAME="operationIsSuccessful(int)"><!-- --></A><H3>
operationIsSuccessful</H3>
<PRE>
boolean <B>operationIsSuccessful</B>(int&nbsp;compNum)</PRE>
<DL>
<DD>Returns true if the operation on the compNum-th component was successful.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>compNum</CODE> - the position of the component in the list
<DT><B>Returns:</B><DD>true if the operation on the compNum-th component was successful</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="ICollectiveOpStatus.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IChildContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FICollectiveOpStatus.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ICollectiveOpStatus.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="ICollectiveOpStatus.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="ICollectiveOpStatus.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,314 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IComponentIdentity (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IComponentIdentity interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IComponentIdentity (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IComponentIdentity.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="ICollectiveOpStatus.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIComponentIdentity.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IComponentIdentity.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IComponentIdentity.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IComponentIdentity.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IComponentIdentity.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IComponentIdentity.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IComponentIdentity</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.lang.Comparable, <A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IIdentity</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IComponentIdentity</B><DT>extends <A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IIdentity</A></DL>
</PRE>
<P>
Represents the identity of component runtime instances.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IIdentity</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentIdentity.html#DELIMITED_ID_PREFIX">DELIMITED_ID_PREFIX</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentIdentity.html#DELIMITED_ID_PREFIX_LENGTH">DELIMITED_ID_PREFIX_LENGTH</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentIdentity.html#ID_PREFIX">ID_PREFIX</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentIdentity.html#ID_PREFIX_LENGTH">ID_PREFIX_LENGTH</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentIdentity.html#getComponentName()">getComponentName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the component ID within the container.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.runtime.IIdentity"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.mf.common.runtime.<A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IIdentity</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="IIdentity.html#compareTo(java.lang.Object)">compareTo</A>, <A HREF="IIdentity.html#equals(java.lang.Object)">equals</A>, <A HREF="IIdentity.html#getCanonicalName()">getCanonicalName</A>, <A HREF="IIdentity.html#getConfigIdentity()">getConfigIdentity</A>, <A HREF="IIdentity.html#getContainerName()">getContainerName</A>, <A HREF="IIdentity.html#getDomainName()">getDomainName</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="DELIMITED_ID_PREFIX"><!-- --></A><H3>
DELIMITED_ID_PREFIX</H3>
<PRE>
static final java.lang.String <B>DELIMITED_ID_PREFIX</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IComponentIdentity.DELIMITED_ID_PREFIX">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DELIMITED_ID_PREFIX_LENGTH"><!-- --></A><H3>
DELIMITED_ID_PREFIX_LENGTH</H3>
<PRE>
static final int <B>DELIMITED_ID_PREFIX_LENGTH</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="ID_PREFIX"><!-- --></A><H3>
ID_PREFIX</H3>
<PRE>
static final java.lang.String <B>ID_PREFIX</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IComponentIdentity.ID_PREFIX">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ID_PREFIX_LENGTH"><!-- --></A><H3>
ID_PREFIX_LENGTH</H3>
<PRE>
static final int <B>ID_PREFIX_LENGTH</B></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getComponentName()"><!-- --></A><H3>
getComponentName</H3>
<PRE>
java.lang.String <B>getComponentName</B>()</PRE>
<DL>
<DD>Get the component ID within the container.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IComponentIdentity.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="ICollectiveOpStatus.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIComponentIdentity.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IComponentIdentity.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IComponentIdentity.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IComponentIdentity.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IComponentIdentity.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IComponentIdentity.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,389 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IComponentState (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IComponentState interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IComponentState (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IComponentState.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IContainerExitCodes.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIComponentState.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IComponentState.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IComponentState.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IComponentState.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IComponentState.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IComponentState.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IComponentState</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.lang.Comparable, <A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime">IState</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IComponentState</B><DT>extends <A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime">IState</A></DL>
</PRE>
<P>
Indicates the runtime state of a component within its container.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IContainerState</CODE></A>,
<A HREF="IContainerState.html#getComponentStates()"><CODE>IContainerState.getComponentStates()</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentState.html#STATE_OFFLINE">STATE_OFFLINE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the component is offline.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentState.html#STATE_ONLINE">STATE_ONLINE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the component is online (in operational state).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentState.html#STATE_STARTING">STATE_STARTING</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the component is starting (but not yet operational).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentState.html#STATE_STOPPING">STATE_STOPPING</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the component is stopping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentState.html#STATE_TEXT">STATE_TEXT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Textual representations of component states (indexed by STATE_<> values).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentState.html#STATE_UNKNOWN">STATE_UNKNOWN</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the component state cannot be determined.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentState.html#getLastErrorDescription()">getLastErrorDescription</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the textual description of the last uncleared condition with an error level < Level.INFO.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IComponentState.html#getLastErrorLevel()">getLastErrorLevel</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get last error severity (uncleared condition with an error level < Level.INFO).</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.runtime.IState"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.mf.common.runtime.<A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime">IState</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="IState.html#compareTo(java.lang.Object)">compareTo</A>, <A HREF="IState.html#equals(java.lang.Object)">equals</A>, <A HREF="IState.html#getRuntimeIdentity()">getRuntimeIdentity</A>, <A HREF="IState.html#getState()">getState</A>, <A HREF="IState.html#getStateString()">getStateString</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="STATE_OFFLINE"><!-- --></A><H3>
STATE_OFFLINE</H3>
<PRE>
static final short <B>STATE_OFFLINE</B></PRE>
<DL>
<DD>Indicates the component is offline.
The component has been created but it is currently not in an
operational state.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IComponentState.STATE_OFFLINE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_ONLINE"><!-- --></A><H3>
STATE_ONLINE</H3>
<PRE>
static final short <B>STATE_ONLINE</B></PRE>
<DL>
<DD>Indicates the component is online (in operational state).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IComponentState.STATE_ONLINE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_STARTING"><!-- --></A><H3>
STATE_STARTING</H3>
<PRE>
static final short <B>STATE_STARTING</B></PRE>
<DL>
<DD>Indicates the component is starting (but not yet operational).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IComponentState.STATE_STARTING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_STOPPING"><!-- --></A><H3>
STATE_STOPPING</H3>
<PRE>
static final short <B>STATE_STOPPING</B></PRE>
<DL>
<DD>Indicates the component is stopping.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IComponentState.STATE_STOPPING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_TEXT"><!-- --></A><H3>
STATE_TEXT</H3>
<PRE>
static final java.lang.String[] <B>STATE_TEXT</B></PRE>
<DL>
<DD>Textual representations of component states (indexed by STATE_<> values).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="STATE_UNKNOWN"><!-- --></A><H3>
STATE_UNKNOWN</H3>
<PRE>
static final short <B>STATE_UNKNOWN</B></PRE>
<DL>
<DD>Indicates the component state cannot be determined.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IComponentState.STATE_UNKNOWN">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getLastErrorDescription()"><!-- --></A><H3>
getLastErrorDescription</H3>
<PRE>
java.lang.String <B>getLastErrorDescription</B>()</PRE>
<DL>
<DD>Get the textual description of the last uncleared condition with an error level < Level.INFO.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getLastErrorLevel()"><!-- --></A><H3>
getLastErrorLevel</H3>
<PRE>
int <B>getLastErrorLevel</B>()</PRE>
<DL>
<DD>Get last error severity (uncleared condition with an error level < Level.INFO).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="Level.html" title="class in com.sonicsw.mf.common.runtime"><CODE>Level</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IComponentState.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IContainerExitCodes.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIComponentState.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IComponentState.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IComponentState.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IComponentState.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IComponentState.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IComponentState.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,672 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IContainerExitCodes (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IContainerExitCodes interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IContainerExitCodes (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IContainerExitCodes.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IContainerIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIContainerExitCodes.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IContainerExitCodes.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IContainerExitCodes.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IContainerExitCodes.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IContainerExitCodes</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IContainerExitCodes</B></DL>
</PRE>
<P>
This interface describes the possible exit codes that may be generated on container termination.
<p>
The corresponding values are:
<p>
<table border="0" cellpadding="3" cellspacing="0" width="100%">
<tbody>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>0</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#NORMAL_SHUTDOWN_EXIT_CODE">NORMAL_SHUTDOWN_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>1</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#UNSPECIFIED_FAILURE_EXIT_CODE">UNSPECIFIED_FAILURE_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>2</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#INVALID_CMD_LINE_EXIT_CODE">INVALID_CMD_LINE_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>3</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#BOOT_FILE_NOT_FOUND_EXIT_CODE">BOOT_FILE_NOT_FOUND_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>4</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#DS_FAILURE_EXIT_CODE">DS_FAILURE_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>5</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#DS_ALREADY_RUNNING_EXIT_CODE">DS_ALREADY_RUNNING_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>6</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#AM_ALREADY_RUNNING_EXIT_CODE">AM_ALREADY_RUNNING_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>7</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#CACHE_FAILURE_EXIT_CODE">CACHE_FAILURE_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>8</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#CONFIGURATION_FAILURE_EXIT_CODE">CONFIGURATION_FAILURE_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>9</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#COMMS_FAILURE_EXIT_CODE">COMMS_FAILURE_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>10</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#LIBX_DIR_NOT_FOUND_EXIT_CODE">LIBX_DIR_NOT_FOUND_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>11</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#DS_DUAL_ACTIVE_EXIT_CODE">DS_DUAL_ACTIVE_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>12</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#INSUFFICIENT_MEMORY_EXIT_CODE">INSUFFICIENT_MEMORY_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>13</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#CONTAINER_ALREADY_RUNNING_EXIT_CODE">CONTAINER_ALREADY_RUNNING_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>14</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#CONTAINER_RESTART_EXIT_CODE">CONTAINER_RESTART_EXIT_CODE</a>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td rowspan="1" colspan="1" align="right">
<b>15</b>
</td>
<td rowspan="1" colspan="1">
<a href="IContainerExitCodes.html#FAILED_TO_START_CONTAINER_FROM_CI_DEPLOYANDSTART">FAILED_TO_START_CONTAINER_FROM_CI_DEPLOYANDSTART</a>
</td>
</tr>
</tbody>
</table>
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IContainerExitCodes.html#EXIT_CODE_TEXTS"><CODE>EXIT_CODE_TEXTS</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#AM_ALREADY_RUNNING_EXIT_CODE">AM_ALREADY_RUNNING_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Container process exit code when on startup the Agent Manager determined there is already an
existing Agent Manager running in the same deployment domain.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#BOOT_FILE_NOT_FOUND_EXIT_CODE">BOOT_FILE_NOT_FOUND_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Container process exit code when the container has been unable to find it's boot file(s).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#CACHE_FAILURE_EXIT_CODE">CACHE_FAILURE_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Container process exit code on an unclassified configuration cache failure.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#COMMS_FAILURE_EXIT_CODE">COMMS_FAILURE_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Container process exit code on a permanent (non-recoverable) communications failure.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#CONFIGURATION_FAILURE_EXIT_CODE">CONFIGURATION_FAILURE_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Container process exit code on an unclassified configuration failure.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#CONTAINER_ALREADY_RUNNING_EXIT_CODE">CONTAINER_ALREADY_RUNNING_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Container process exit code when on startup the container determined there is already an
existing container of the same name running in the same deployment domain.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#CONTAINER_RESTART_EXIT_CODE">CONTAINER_RESTART_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A special exit code used to indicate that the container was shutdown with the intent that any parent
shell or process will detect this code and restart the container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#DS_ALREADY_RUNNING_EXIT_CODE">DS_ALREADY_RUNNING_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Container process exit code when on startup the Directory Service determined there is already an
existing Directory Service running in the same configuration domain.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#DS_DUAL_ACTIVE_EXIT_CODE">DS_DUAL_ACTIVE_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Two active fault tolerant DS have been detected.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#DS_FAILURE_EXIT_CODE">DS_FAILURE_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Container process exit code on an unclassified Directory Service failure.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#EXIT_CODE_TEXTS">EXIT_CODE_TEXTS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An array holding textual equivalents to the <>_EXIT_CODE constants.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#FAILED_TO_START_CONTAINER_FROM_CI_DEPLOYANDSTART">FAILED_TO_START_CONTAINER_FROM_CI_DEPLOYANDSTART</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The centralized install DeployAndStartContainer failed to start the JVM for the container process</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#INSUFFICIENT_MEMORY_EXIT_CODE">INSUFFICIENT_MEMORY_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Insufficient memory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#INVALID_CMD_LINE_EXIT_CODE">INVALID_CMD_LINE_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Container process exit code when the container detects it was started with an invalid command line.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#LIBX_DIR_NOT_FOUND_EXIT_CODE">LIBX_DIR_NOT_FOUND_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The libX directory (for native libraries) does not exist.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#NORMAL_SHUTDOWN_EXIT_CODE">NORMAL_SHUTDOWN_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Container process exit code on normal shutdown.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerExitCodes.html#UNSPECIFIED_FAILURE_EXIT_CODE">UNSPECIFIED_FAILURE_EXIT_CODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Container process exit code on an unclassified abnormal shutdown.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="AM_ALREADY_RUNNING_EXIT_CODE"><!-- --></A><H3>
AM_ALREADY_RUNNING_EXIT_CODE</H3>
<PRE>
static final int <B>AM_ALREADY_RUNNING_EXIT_CODE</B></PRE>
<DL>
<DD>Container process exit code when on startup the Agent Manager determined there is already an
existing Agent Manager running in the same deployment domain.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.AM_ALREADY_RUNNING_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="BOOT_FILE_NOT_FOUND_EXIT_CODE"><!-- --></A><H3>
BOOT_FILE_NOT_FOUND_EXIT_CODE</H3>
<PRE>
static final int <B>BOOT_FILE_NOT_FOUND_EXIT_CODE</B></PRE>
<DL>
<DD>Container process exit code when the container has been unable to find it's boot file(s).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.BOOT_FILE_NOT_FOUND_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CACHE_FAILURE_EXIT_CODE"><!-- --></A><H3>
CACHE_FAILURE_EXIT_CODE</H3>
<PRE>
static final int <B>CACHE_FAILURE_EXIT_CODE</B></PRE>
<DL>
<DD>Container process exit code on an unclassified configuration cache failure.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.CACHE_FAILURE_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="COMMS_FAILURE_EXIT_CODE"><!-- --></A><H3>
COMMS_FAILURE_EXIT_CODE</H3>
<PRE>
static final int <B>COMMS_FAILURE_EXIT_CODE</B></PRE>
<DL>
<DD>Container process exit code on a permanent (non-recoverable) communications failure.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.COMMS_FAILURE_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CONFIGURATION_FAILURE_EXIT_CODE"><!-- --></A><H3>
CONFIGURATION_FAILURE_EXIT_CODE</H3>
<PRE>
static final int <B>CONFIGURATION_FAILURE_EXIT_CODE</B></PRE>
<DL>
<DD>Container process exit code on an unclassified configuration failure.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.CONFIGURATION_FAILURE_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CONTAINER_ALREADY_RUNNING_EXIT_CODE"><!-- --></A><H3>
CONTAINER_ALREADY_RUNNING_EXIT_CODE</H3>
<PRE>
static final int <B>CONTAINER_ALREADY_RUNNING_EXIT_CODE</B></PRE>
<DL>
<DD>Container process exit code when on startup the container determined there is already an
existing container of the same name running in the same deployment domain.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.CONTAINER_ALREADY_RUNNING_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CONTAINER_RESTART_EXIT_CODE"><!-- --></A><H3>
CONTAINER_RESTART_EXIT_CODE</H3>
<PRE>
static final int <B>CONTAINER_RESTART_EXIT_CODE</B></PRE>
<DL>
<DD>A special exit code used to indicate that the container was shutdown with the intent that any parent
shell or process will detect this code and restart the container. The following support the restart
behavior for this exit code: startcontainer.{bat|sh}, the activation daemon and the Windows service.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.CONTAINER_RESTART_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DS_ALREADY_RUNNING_EXIT_CODE"><!-- --></A><H3>
DS_ALREADY_RUNNING_EXIT_CODE</H3>
<PRE>
static final int <B>DS_ALREADY_RUNNING_EXIT_CODE</B></PRE>
<DL>
<DD>Container process exit code when on startup the Directory Service determined there is already an
existing Directory Service running in the same configuration domain.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.DS_ALREADY_RUNNING_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DS_DUAL_ACTIVE_EXIT_CODE"><!-- --></A><H3>
DS_DUAL_ACTIVE_EXIT_CODE</H3>
<PRE>
static final int <B>DS_DUAL_ACTIVE_EXIT_CODE</B></PRE>
<DL>
<DD>Two active fault tolerant DS have been detected.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.DS_DUAL_ACTIVE_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DS_FAILURE_EXIT_CODE"><!-- --></A><H3>
DS_FAILURE_EXIT_CODE</H3>
<PRE>
static final int <B>DS_FAILURE_EXIT_CODE</B></PRE>
<DL>
<DD>Container process exit code on an unclassified Directory Service failure.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.DS_FAILURE_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="EXIT_CODE_TEXTS"><!-- --></A><H3>
EXIT_CODE_TEXTS</H3>
<PRE>
static final java.lang.String[] <B>EXIT_CODE_TEXTS</B></PRE>
<DL>
<DD>An array holding textual equivalents to the <>_EXIT_CODE constants. Access using a
particular exit code string using: <code>IContainerExitCodes.EXIT_CODE_TEXTS[<>_EXIT_CODE]</code>.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="FAILED_TO_START_CONTAINER_FROM_CI_DEPLOYANDSTART"><!-- --></A><H3>
FAILED_TO_START_CONTAINER_FROM_CI_DEPLOYANDSTART</H3>
<PRE>
static final int <B>FAILED_TO_START_CONTAINER_FROM_CI_DEPLOYANDSTART</B></PRE>
<DL>
<DD>The centralized install DeployAndStartContainer failed to start the JVM for the container process
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.FAILED_TO_START_CONTAINER_FROM_CI_DEPLOYANDSTART">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="INSUFFICIENT_MEMORY_EXIT_CODE"><!-- --></A><H3>
INSUFFICIENT_MEMORY_EXIT_CODE</H3>
<PRE>
static final int <B>INSUFFICIENT_MEMORY_EXIT_CODE</B></PRE>
<DL>
<DD>Insufficient memory.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.INSUFFICIENT_MEMORY_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="INVALID_CMD_LINE_EXIT_CODE"><!-- --></A><H3>
INVALID_CMD_LINE_EXIT_CODE</H3>
<PRE>
static final int <B>INVALID_CMD_LINE_EXIT_CODE</B></PRE>
<DL>
<DD>Container process exit code when the container detects it was started with an invalid command line.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.INVALID_CMD_LINE_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LIBX_DIR_NOT_FOUND_EXIT_CODE"><!-- --></A><H3>
LIBX_DIR_NOT_FOUND_EXIT_CODE</H3>
<PRE>
static final int <B>LIBX_DIR_NOT_FOUND_EXIT_CODE</B></PRE>
<DL>
<DD>The libX directory (for native libraries) does not exist.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.LIBX_DIR_NOT_FOUND_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="NORMAL_SHUTDOWN_EXIT_CODE"><!-- --></A><H3>
NORMAL_SHUTDOWN_EXIT_CODE</H3>
<PRE>
static final int <B>NORMAL_SHUTDOWN_EXIT_CODE</B></PRE>
<DL>
<DD>Container process exit code on normal shutdown.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.NORMAL_SHUTDOWN_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="UNSPECIFIED_FAILURE_EXIT_CODE"><!-- --></A><H3>
UNSPECIFIED_FAILURE_EXIT_CODE</H3>
<PRE>
static final int <B>UNSPECIFIED_FAILURE_EXIT_CODE</B></PRE>
<DL>
<DD>Container process exit code on an unclassified abnormal shutdown.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerExitCodes.UNSPECIFIED_FAILURE_EXIT_CODE">Constant Field Values</A></DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IContainerExitCodes.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IContainerIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIContainerExitCodes.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IContainerExitCodes.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IContainerExitCodes.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IContainerExitCodes.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,222 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IContainerIdentity (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IContainerIdentity interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IContainerIdentity (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IContainerIdentity.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IContainerExitCodes.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIContainerIdentity.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IContainerIdentity.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IContainerIdentity.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IContainerIdentity.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IContainerIdentity</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.lang.Comparable, <A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IIdentity</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IContainerIdentity</B><DT>extends <A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IIdentity</A></DL>
</PRE>
<P>
Represents the identity of container runtime instances.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IIdentity</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerIdentity.html#getNodeName()">getNodeName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.runtime.IIdentity"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.mf.common.runtime.<A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IIdentity</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="IIdentity.html#compareTo(java.lang.Object)">compareTo</A>, <A HREF="IIdentity.html#equals(java.lang.Object)">equals</A>, <A HREF="IIdentity.html#getCanonicalName()">getCanonicalName</A>, <A HREF="IIdentity.html#getConfigIdentity()">getConfigIdentity</A>, <A HREF="IIdentity.html#getContainerName()">getContainerName</A>, <A HREF="IIdentity.html#getDomainName()">getDomainName</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getNodeName()"><!-- --></A><H3>
getNodeName</H3>
<PRE>
java.lang.String <B>getNodeName</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IContainerIdentity.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IContainerExitCodes.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIContainerIdentity.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IContainerIdentity.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IContainerIdentity.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IContainerIdentity.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,373 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IContainerState (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IContainerState interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IContainerState (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IContainerState.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IContainerIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IFaultTolerantState.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIContainerState.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IContainerState.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IContainerState.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IContainerState.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IContainerState.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IContainerState.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IContainerState</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.lang.Comparable, <A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime">IState</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IContainerState</B><DT>extends <A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime">IState</A></DL>
</PRE>
<P>
The implmentation of this interface represents the state of a container and
all its hosted components.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IComponentState</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerState.html#STATE_OFFLINE">STATE_OFFLINE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the container is offline.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerState.html#STATE_ONLINE">STATE_ONLINE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the container is online (in operational state).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerState.html#STATE_TEXT">STATE_TEXT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Textual representations of container states (indexed by STATE_<> values).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerState.html#STATE_UNKNOWN">STATE_UNKNOWN</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the container state cannot be determined.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime">IComponentState</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerState.html#getComponentStates()">getComponentStates</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a list of the state of all the components hosted by the container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerState.html#getContainerHost()">getContainerHost</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the IP hostname of the machine hosting the container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IContainerState.html#getTimeStamp()">getTimeStamp</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the time the state value was captured.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.runtime.IState"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.mf.common.runtime.<A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime">IState</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="IState.html#compareTo(java.lang.Object)">compareTo</A>, <A HREF="IState.html#equals(java.lang.Object)">equals</A>, <A HREF="IState.html#getRuntimeIdentity()">getRuntimeIdentity</A>, <A HREF="IState.html#getState()">getState</A>, <A HREF="IState.html#getStateString()">getStateString</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="STATE_OFFLINE"><!-- --></A><H3>
STATE_OFFLINE</H3>
<PRE>
static final short <B>STATE_OFFLINE</B></PRE>
<DL>
<DD>Indicates the container is offline.
The container is either not contactable or a shutdown
has been triggered the offline state.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerState.STATE_OFFLINE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_ONLINE"><!-- --></A><H3>
STATE_ONLINE</H3>
<PRE>
static final short <B>STATE_ONLINE</B></PRE>
<DL>
<DD>Indicates the container is online (in operational state).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerState.STATE_ONLINE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_TEXT"><!-- --></A><H3>
STATE_TEXT</H3>
<PRE>
static final java.lang.String[] <B>STATE_TEXT</B></PRE>
<DL>
<DD>Textual representations of container states (indexed by STATE_<> values).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="STATE_UNKNOWN"><!-- --></A><H3>
STATE_UNKNOWN</H3>
<PRE>
static final short <B>STATE_UNKNOWN</B></PRE>
<DL>
<DD>Indicates the container state cannot be determined.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IContainerState.STATE_UNKNOWN">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getComponentStates()"><!-- --></A><H3>
getComponentStates</H3>
<PRE>
<A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime">IComponentState</A>[] <B>getComponentStates</B>()</PRE>
<DL>
<DD>Get a list of the state of all the components hosted by the container.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getContainerHost()"><!-- --></A><H3>
getContainerHost</H3>
<PRE>
java.lang.String <B>getContainerHost</B>()</PRE>
<DL>
<DD>Get the IP hostname of the machine hosting the container.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTimeStamp()"><!-- --></A><H3>
getTimeStamp</H3>
<PRE>
long <B>getTimeStamp</B>()</PRE>
<DL>
<DD>Get the time the state value was captured.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IContainerState.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IContainerIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IFaultTolerantState.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIContainerState.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IContainerState.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IContainerState.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IContainerState.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IContainerState.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IContainerState.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,308 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IFaultTolerantState (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IFaultTolerantState interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IFaultTolerantState (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IFaultTolerantState.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IFileDescriptor.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIFaultTolerantState.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IFaultTolerantState.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IFaultTolerantState.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IFaultTolerantState.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IFaultTolerantState</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IFaultTolerantState</B></DL>
</PRE>
<P>
Indicates the general permissible set of fault tolerant states. If a component exposes additional fault tolerant
states then it should extend this interface.
Currently used by the Directory service and Agent Manager.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFaultTolerantState.html#STATE_ACTIVE">STATE_ACTIVE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the component is the active component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFaultTolerantState.html#STATE_NOT_FAULT_TOLERANT">STATE_NOT_FAULT_TOLERANT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the component is not fault tolerant.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFaultTolerantState.html#STATE_STANDBY">STATE_STANDBY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the component is standing by to become active when the current active component fails.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFaultTolerantState.html#STATE_TEXT">STATE_TEXT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Textual representations of fault tolerant states (indexed by STATE_<> values).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFaultTolerantState.html#STATE_VALUES">STATE_VALUES</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Array container each of the valid fault tolerant states.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFaultTolerantState.html#STATE_WAITING">STATE_WAITING</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the component is waiting to determine whether it should be transition to an active or standby state.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="STATE_ACTIVE"><!-- --></A><H3>
STATE_ACTIVE</H3>
<PRE>
static final short <B>STATE_ACTIVE</B></PRE>
<DL>
<DD>Indicates the component is the active component.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IFaultTolerantState.STATE_ACTIVE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_NOT_FAULT_TOLERANT"><!-- --></A><H3>
STATE_NOT_FAULT_TOLERANT</H3>
<PRE>
static final short <B>STATE_NOT_FAULT_TOLERANT</B></PRE>
<DL>
<DD>Indicates the component is not fault tolerant.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IFaultTolerantState.STATE_NOT_FAULT_TOLERANT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_STANDBY"><!-- --></A><H3>
STATE_STANDBY</H3>
<PRE>
static final short <B>STATE_STANDBY</B></PRE>
<DL>
<DD>Indicates the component is standing by to become active when the current active component fails.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IFaultTolerantState.STATE_STANDBY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_TEXT"><!-- --></A><H3>
STATE_TEXT</H3>
<PRE>
static final java.lang.String[] <B>STATE_TEXT</B></PRE>
<DL>
<DD>Textual representations of fault tolerant states (indexed by STATE_<> values).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="STATE_VALUES"><!-- --></A><H3>
STATE_VALUES</H3>
<PRE>
static final short[] <B>STATE_VALUES</B></PRE>
<DL>
<DD>Array container each of the valid fault tolerant states.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="STATE_WAITING"><!-- --></A><H3>
STATE_WAITING</H3>
<PRE>
static final short <B>STATE_WAITING</B></PRE>
<DL>
<DD>Indicates the component is waiting to determine whether it should be transition to an active or standby state.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.IFaultTolerantState.STATE_WAITING">Constant Field Values</A></DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IFaultTolerantState.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IFileDescriptor.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIFaultTolerantState.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IFaultTolerantState.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IFaultTolerantState.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IFaultTolerantState.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,414 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IFileDescriptor (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IFileDescriptor interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IFileDescriptor (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IFileDescriptor.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IFaultTolerantState.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIFileDescriptor.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IFileDescriptor.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IFileDescriptor.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IFileDescriptor.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IFileDescriptor</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IFileDescriptor</B></DL>
</PRE>
<P>
File information to be sent remotely from the Host Manager to a client
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFileDescriptor.html#canRead()">canRead</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFileDescriptor.html#canWrite()">canWrite</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFileDescriptor.html#getAbsolutePath()">getAbsolutePath</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFileDescriptor.html#getName()">getName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFileDescriptor.html#getParent()">getParent</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFileDescriptor.html#getPath()">getPath</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFileDescriptor.html#isAbsolute()">isAbsolute</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFileDescriptor.html#isDirectory()">isDirectory</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFileDescriptor.html#isFile()">isFile</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFileDescriptor.html#isHidden()">isHidden</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFileDescriptor.html#lastModified()">lastModified</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IFileDescriptor.html#length()">length</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="canRead()"><!-- --></A><H3>
canRead</H3>
<PRE>
boolean <B>canRead</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="canWrite()"><!-- --></A><H3>
canWrite</H3>
<PRE>
boolean <B>canWrite</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getAbsolutePath()"><!-- --></A><H3>
getAbsolutePath</H3>
<PRE>
java.lang.String <B>getAbsolutePath</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
java.lang.String <B>getName</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getParent()"><!-- --></A><H3>
getParent</H3>
<PRE>
java.lang.String <B>getParent</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPath()"><!-- --></A><H3>
getPath</H3>
<PRE>
java.lang.String <B>getPath</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isAbsolute()"><!-- --></A><H3>
isAbsolute</H3>
<PRE>
boolean <B>isAbsolute</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isDirectory()"><!-- --></A><H3>
isDirectory</H3>
<PRE>
boolean <B>isDirectory</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isFile()"><!-- --></A><H3>
isFile</H3>
<PRE>
boolean <B>isFile</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isHidden()"><!-- --></A><H3>
isHidden</H3>
<PRE>
boolean <B>isHidden</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="lastModified()"><!-- --></A><H3>
lastModified</H3>
<PRE>
long <B>lastModified</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="length()"><!-- --></A><H3>
length</H3>
<PRE>
long <B>length</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IFileDescriptor.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IFaultTolerantState.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIFileDescriptor.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IFileDescriptor.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IFileDescriptor.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IFileDescriptor.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,356 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IIdentity (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IIdentity interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IIdentity (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IIdentity.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IFileDescriptor.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMonitoredMetrics.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIIdentity.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IIdentity.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IIdentity.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IIdentity.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IIdentity</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.lang.Comparable</DD>
</DL>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IComponentIdentity</A>, <A HREF="IContainerIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IContainerIdentity</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IIdentity</B><DT>extends java.lang.Comparable</DL>
</PRE>
<P>
A base interface representing the runtime identity of runtime entities.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IContainerIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IContainerIdentity</CODE></A>,
<A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IComponentIdentity</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IIdentity.html#compareTo(java.lang.Object)">compareTo</A></B>(java.lang.Object&nbsp;object)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares this object with the specified object for order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IIdentity.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;object)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests if the given object is equal to this identity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IIdentity.html#getCanonicalName()">getCanonicalName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the full composite name of the instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/config.IElementIdentity.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.config.IElementIdentity</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="IIdentity.html#getConfigIdentity()">getConfigIdentity</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the configuration identity of the entity (the configuration identity
is the location in the Directory Service where this entities configuration
is stored).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IIdentity.html#getContainerName()">getContainerName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the container name within the domain.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IIdentity.html#getDomainName()">getDomainName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the domain name to which the instance belongs.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
compareTo</H3>
<PRE>
int <B>compareTo</B>(java.lang.Object&nbsp;object)
throws java.lang.ClassCastException</PRE>
<DL>
<DD>Compares this object with the specified object for order. Returns a negative integer,
zero, or a positive integer as this object is less than, equal to, or greater than
the specified object. Comparison is made using the toString() value.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.lang.ClassCastException</CODE> - If the given object is not an instance of the same object.</DL>
</DD>
</DL>
<HR>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
boolean <B>equals</B>(java.lang.Object&nbsp;object)</PRE>
<DL>
<DD>Tests if the given object is equal to this identity.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>Returns true if the canonical name and config identity of this identity
equals that of the given object.</DL>
</DD>
</DL>
<HR>
<A NAME="getCanonicalName()"><!-- --></A><H3>
getCanonicalName</H3>
<PRE>
java.lang.String <B>getCanonicalName</B>()</PRE>
<DL>
<DD>Gets the full composite name of the instance. The canonical name
will vary depending upon the instance implementation, for example:
<p>
<ul>
<li>a containers cananocial name might be: "Sonic.Container"
<li>a components cananocial name might be: "Sonic.Container:ID=SonicMQ"
</ul>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getConfigIdentity()"><!-- --></A><H3>
getConfigIdentity</H3>
<PRE>
<A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/config.IElementIdentity.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.config.IElementIdentity</A> <B>getConfigIdentity</B>()</PRE>
<DL>
<DD>Gets the configuration identity of the entity (the configuration identity
is the location in the Directory Service where this entities configuration
is stored).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getContainerName()"><!-- --></A><H3>
getContainerName</H3>
<PRE>
java.lang.String <B>getContainerName</B>()</PRE>
<DL>
<DD>Get the container name within the domain.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDomainName()"><!-- --></A><H3>
getDomainName</H3>
<PRE>
java.lang.String <B>getDomainName</B>()</PRE>
<DL>
<DD>Get the domain name to which the instance belongs.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IIdentity.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IFileDescriptor.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMonitoredMetrics.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIIdentity.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IIdentity.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IIdentity.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IIdentity.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,306 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IMonitoredMetrics (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IMonitoredMetrics interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IMonitoredMetrics (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IMonitoredMetrics.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMonitoredNotifications.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIMonitoredMetrics.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMonitoredMetrics.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMonitoredMetrics.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMonitoredMetrics.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IMonitoredMetrics</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IMonitoredMetrics</B><DT>extends java.io.Serializable</DL>
</PRE>
<P>
The IMonitoredMetrics interface represents a collection of stored metrics
that are retrieved from a CollectionsMonitor instance, along with the timestamp of the
last retrieved metric and a flag to indicate if there are any additional stored
metrics to be retrieved from the CollectionsMonitor.
<p>
A concrete instance of IMonitoredMetrics is obtained through the invocation of a CollectionsMonitor
instance's "getStoredMetrics" method. The returned IMonitoredMetrics instance
will contain a set of metrics that were retrieved from the CollectionsMonitor instance's store [if
there are any stored metrics], the timestamp of the last metric retrieved from the store, and a
boolean flag that indicates if there are any more metrics to retrieve.
<p>
It is important to note that the "getStoredMetrics" method will return only approximately 1 MB worth of
stored metrics. If the total size of the metrics stored by a given CollectionsMonitor instance,
for the specified time interval, exceeds 1 MB, then a caller will have to invoke the "getStoredMetrics"
method multiple times.
<p>
In order for a caller to determine if there are more stored metrics to retrieve for the specified time interval,
the caller must check the appropriate flag by invoking the IMonitoredMetrics instance's "hasMoreDataToRetrieve" method.
<p>
If multiple invocations of "getStoredMetricsData" must be made in order to retrieve all of the stored metrics,
then each invocation [after the initial invocation] should use an adjusted "lookback" value, based on the timestamp
value returned by invoking "getLatestTimestamp". So, the pattern of execution would be:
(a) initial invocation of "getStoredMetrics, passing in desired timestamp and lookback arguments
(b) invoke "getMetrics" method on the returned IMonitoredMetrics instance in order to obtain retrieved metrics
(c) invoke "hasMoreDataToRetrieve" method on the returned IMonitoredMetrics instance, in order
to determine if a successive invocation must be made
(d) if "hasMoreDataToRetrieve returns "true", invoke the "getLatestTimestamp" method
of the returned IMonitoredMetrics instance and use the returned timestamp value
to calculate a new "lookback" value, and use the new lookback value as an input
parameter to a follow-on invocation of "getStoredMetricsData",
along with the timestamp value used [as the "lastReceivedTimestamp" parameter] for the initial invocation
(e) repeat steps (b) through (d), until the returned value of "hasMoreDataToRetrieve"
is "false".
<p>
Invoking the "getMetrics()" method of an IMonitoredMetrics instance will return an array of IHistoricalMetric object instances.
If no stored metrics were found for the specified time interval, a zero-length array will be returned from the invocation of
"getMetrics".
<p>
Invoking "getLatestTimestamp()" will return the timestamp of the last metric returned from a CollectionsMonitor instance's store.
If there were no stored metrics for the specified time period, the returned timestamp will correspond to the time
of the invocation of "getStoredMetrics" method of the CollectionsMonitor instance. If multiple invocations of "getStoredMetrics"
are required in order to obtain all of the stored metrics for the specified time period, the returned timestamp will
correspond to the timestamp of the last returned metric PLUS one millisecond.
<p>
Invoking "hasMoreDataToRetrieve()" will return a boolean value that indicates whether there are more
stored metrics to retrieve for the time interval specified in the invocation of "getStoredMetrics".
If the returned value is "true", then successive invocations of "getStoredMetrics" will return the
remaining stored metrics, and the value returned by "getLatestTimestamp()" should be used to adjust
the maximum lookback value passed as an input argument for the successive invocation of "getStoredMetrics".
<p>
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/runtime/impl.MonitoredMetrics.html" title="class or interface in com.sonicsw.mf.common.runtime"><CODE>MonitoredMetrics</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMonitoredMetrics.html#getLatestTimestamp()">getLatestTimestamp</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../metrics/IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics">IHistoricalMetric</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMonitoredMetrics.html#getMetrics()">getMetrics</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMonitoredMetrics.html#hasMoreDataToRetrieve()">hasMoreDataToRetrieve</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getLatestTimestamp()"><!-- --></A><H3>
getLatestTimestamp</H3>
<PRE>
long <B>getLatestTimestamp</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMetrics()"><!-- --></A><H3>
getMetrics</H3>
<PRE>
<A HREF="../metrics/IHistoricalMetric.html" title="interface in com.sonicsw.mf.common.metrics">IHistoricalMetric</A>[] <B>getMetrics</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="hasMoreDataToRetrieve()"><!-- --></A><H3>
hasMoreDataToRetrieve</H3>
<PRE>
boolean <B>hasMoreDataToRetrieve</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IMonitoredMetrics.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IMonitoredNotifications.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIMonitoredMetrics.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMonitoredMetrics.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMonitoredMetrics.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMonitoredMetrics.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,306 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IMonitoredNotifications (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IMonitoredNotifications interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IMonitoredNotifications (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IMonitoredNotifications.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMonitoredMetrics.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="INotification.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIMonitoredNotifications.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMonitoredNotifications.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMonitoredNotifications.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMonitoredNotifications.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IMonitoredNotifications</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IMonitoredNotifications</B><DT>extends java.io.Serializable</DL>
</PRE>
<P>
The IMonitoredNotifications interface represents a collection of stored notifications
that are retrieved from a CollectionsMonitor instance, along with the timestamp of the
last retrieved notification and a flag to indicate if there are any additional stored
notifications to be retrieved from the CollectionsMonitor.
<p>
A concrete instance of IMonitoredNotifications is obtained through the invocation of a CollectionsMonitor
instance's "getStoredNotifications" method. The returned IMonitoredNotifications instance
will contain a set of notifications that were retrieved from the CollectionsMonitor instance's store [if
there are any stored notifications], the timestamp of the last notification retrieved from the store, and a
boolean flag that indicates if there are any more notifications to retrieve.
<p>
It is important to note that the "getStoredNotifications" method will return only approximately 1 MB worth of
stored notifications. If the total size of the notifications stored by a given CollectionsMonitor instance,
for the specified time interval, exceeds 1 MB, then a caller will have to invoke the "getStoredNotifications"
method multiple times.
<p>
In order for a caller to determine if there are more stored notifications to retrieve for the specified time interval,
the caller must check the appropriate flag by invoking the IMonitoredNotifications instance's "hasMoreDataToRetrieve" method.
<p>
If multiple invocations of "getStoredNotificationsData" must be made in order to retrieve all of the stored notifications,
then each invocation [after the initial invocation] should use an adjusted "lookback" value, based on the timestamp
value returned by invoking "getLatestTimestamp". So, the pattern of execution would be:
(a) initial invocation of "getStoredNotifications, passing in desired timestamp and lookback arguments
(b) invoke "getNotifications" method on the returned IMonitoredNotifications instance in order to obtain retrieved notifications
(c) invoke "hasMoreDataToRetrieve" method on the returned IMonitoredNotifications instance, in order
to determine if a successive invocation must be made
(d) if "hasMoreDataToRetrieve returns "true", invoke the "getLatestTimestamp" method
of the returned IMonitoredNotifications instance and use the returned timestamp value
to calculate a new "lookback" value, and use the new lookback value as an input
parameter to a follow-on invocation of "getStoredNotificationsData",
along with the timestamp value used [as the "lastReceivedTimestamp" parameter] for the initial invocation
(e) repeat steps (b) through (d), until the returned value of "hasMoreDataToRetrieve"
is "false".
<p>
Invoking the "getNotifications()" method of an IMonitoredNotifications instance will return an array of INotification object instances.
If no stored notifications were found for the specified time interval, a zero-length array will be returned from the invocation of
"getNotifications".
<p>
Invoking "getLatestTimestamp()" will return the timestamp of the last notification returned from a CollectionsMonitor instance's store.
If there were no stored notifications for the specified time period, the returned timestamp will correspond to the time
of the invocation of "getStoredNotifications" method of the CollectionsMonitor instance. If multiple invocations of "getStoredNotifications"
are required in order to obtain all of the stored notifications for the specified time period, the returned timestamp will
correspond to the timestamp of the last returned notification PLUS one millisecond.
<p>
Invoking "hasMoreDataToRetrieve()" will return a boolean value that indicates whether there are more
stored notifications to retrieve for the time interval specified in the invocation of "getStoredNotifications".
If the returned value is "true", then successive invocations of "getStoredNotifications" will return the
remaining stored notifications, and the value returned by "getLatestTimestamp()" should be used to adjust
the maximum lookback value passed as an input argument for the successive invocation of "getStoredNotifications".
<p>
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/runtime/impl.MonitoredNotifications.html" title="class or interface in com.sonicsw.mf.common.runtime"><CODE>MonitoredNotifications</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMonitoredNotifications.html#getLatestTimestamp()">getLatestTimestamp</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="INotification.html" title="interface in com.sonicsw.mf.common.runtime">INotification</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMonitoredNotifications.html#getNotifications()">getNotifications</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IMonitoredNotifications.html#hasMoreDataToRetrieve()">hasMoreDataToRetrieve</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getLatestTimestamp()"><!-- --></A><H3>
getLatestTimestamp</H3>
<PRE>
long <B>getLatestTimestamp</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getNotifications()"><!-- --></A><H3>
getNotifications</H3>
<PRE>
<A HREF="INotification.html" title="interface in com.sonicsw.mf.common.runtime">INotification</A>[] <B>getNotifications</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="hasMoreDataToRetrieve()"><!-- --></A><H3>
hasMoreDataToRetrieve</H3>
<PRE>
boolean <B>hasMoreDataToRetrieve</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IMonitoredNotifications.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMonitoredMetrics.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="INotification.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIMonitoredNotifications.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMonitoredNotifications.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMonitoredNotifications.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IMonitoredNotifications.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,924 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
INotification (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.INotification interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="INotification (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="INotification.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMonitoredNotifications.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IRemoteCallResult.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FINotification.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="INotification.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="INotification.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="INotification.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="INotification.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="INotification.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface INotification</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>INotification</B><DT>extends java.io.Serializable</DL>
</PRE>
<P>
The notification interface represents a notification emitted from a Sonic
Management Framework compliant component.
<p>
When a notifiable event occurs, components create a notification. Event
information is included in the notification by adding attributes
(name/value pairs).
<p>
Management applications subscribe to notifications through the JMS connector
and may cast JMX notifications to INotification in order to access the
additional functionality of this interface.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../jmx/client/JMSConnectorClient.html" title="class in com.sonicsw.mf.jmx.client"><CODE>JMSConnectorClient</CODE></A>,
<A HREF="../../jmx/client/JMSConnectorClient.html#addNotificationListener(javax.management.ObjectName, javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)"><CODE>JMSConnectorClient.addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#ALERT_SUBCATEGORY">ALERT_SUBCATEGORY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#APPLICATION_CATEGORY">APPLICATION_CATEGORY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#CATEGORY_TEXT">CATEGORY_TEXT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A textual representation of the notification category may be obtained using the
return value from getCategory() as an index into the array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#CLASSNAME">CLASSNAME</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#CONFIGURATION_CATEGORY">CONFIGURATION_CATEGORY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#ERROR_TYPE">ERROR_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#FAILURE_AUDIT_TYPE">FAILURE_AUDIT_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#INFORMATION_TYPE">INFORMATION_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#LOG_SUBCATEGORY">LOG_SUBCATEGORY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#LOGTYPE_TEXT">LOGTYPE_TEXT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A textual representation of the notification log type may be obtained using the
return value from getLogType() as an index into the array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#MONITOR_SUBCATEGORY">MONITOR_SUBCATEGORY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#SECURITY_SUBCATEGORY">SECURITY_SUBCATEGORY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#STATE_SUBCATEGORY">STATE_SUBCATEGORY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#STORAGE_SUBCATEGORY">STORAGE_SUBCATEGORY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#SUBCATEGORY_TEXT">SUBCATEGORY_TEXT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A textual representation of the notification subcategory may be obtained using the
return value from getSubCategory() as an index into the array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#SUCCESS_AUDIT_TYPE">SUCCESS_AUDIT_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#SYSTEM_CATEGORY">SYSTEM_CATEGORY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Management framework system notifications (reserved for internal use only)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#WARNING_TYPE">WARNING_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.HashMap</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#getAttributes()">getAttributes</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the event information specified as attributes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#getCategory()">getCategory</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Each notification belongs to a major category.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#getEventName()">getEventName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Each notification type is unique by category/subcategory/event name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#getLogType()">getLogType</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#getSequenceNumber()">getSequenceNumber</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the sequence number for the notification.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#getSeverity()">getSeverity</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Each notification has a severity associated with it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#getSourceHost()">getSourceHost</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the source of the notification.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IComponentIdentity</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#getSourceIdentity()">getSourceIdentity</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the source of the notification.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#getSubCategory()">getSubCategory</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Each notification has a minor category.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#getTimeStamp()">getTimeStamp</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the timestamp of the notification.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#getType()">getType</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Each notification type is unique by category/subcategory/event name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#setAttribute(java.lang.String, java.lang.Object)">setAttribute</A></B>(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets a notification attribute (a named piece of event information).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#setLogType(short)">setLogType</A></B>(short&nbsp;logType)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Each notification can be assigned a log type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="INotification.html#setSourceIdentity(com.sonicsw.mf.common.runtime.IComponentIdentity)">setSourceIdentity</A></B>(<A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IComponentIdentity</A>&nbsp;sourceIdentity)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the source of the notification.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ALERT_SUBCATEGORY"><!-- --></A><H3>
ALERT_SUBCATEGORY</H3>
<PRE>
static final short <B>ALERT_SUBCATEGORY</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.ALERT_SUBCATEGORY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="APPLICATION_CATEGORY"><!-- --></A><H3>
APPLICATION_CATEGORY</H3>
<PRE>
static final short <B>APPLICATION_CATEGORY</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.APPLICATION_CATEGORY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CATEGORY_TEXT"><!-- --></A><H3>
CATEGORY_TEXT</H3>
<PRE>
static final java.lang.String[] <B>CATEGORY_TEXT</B></PRE>
<DL>
<DD>A textual representation of the notification category may be obtained using the
return value from getCategory() as an index into the array.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="INotification.html#getCategory()"><CODE>getCategory()</CODE></A></DL>
</DL>
<HR>
<A NAME="CLASSNAME"><!-- --></A><H3>
CLASSNAME</H3>
<PRE>
static final java.lang.String <B>CLASSNAME</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.CLASSNAME">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CONFIGURATION_CATEGORY"><!-- --></A><H3>
CONFIGURATION_CATEGORY</H3>
<PRE>
static final short <B>CONFIGURATION_CATEGORY</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.CONFIGURATION_CATEGORY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ERROR_TYPE"><!-- --></A><H3>
ERROR_TYPE</H3>
<PRE>
static final short <B>ERROR_TYPE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.ERROR_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FAILURE_AUDIT_TYPE"><!-- --></A><H3>
FAILURE_AUDIT_TYPE</H3>
<PRE>
static final short <B>FAILURE_AUDIT_TYPE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.FAILURE_AUDIT_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="INFORMATION_TYPE"><!-- --></A><H3>
INFORMATION_TYPE</H3>
<PRE>
static final short <B>INFORMATION_TYPE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.INFORMATION_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LOG_SUBCATEGORY"><!-- --></A><H3>
LOG_SUBCATEGORY</H3>
<PRE>
static final short <B>LOG_SUBCATEGORY</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.LOG_SUBCATEGORY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LOGTYPE_TEXT"><!-- --></A><H3>
LOGTYPE_TEXT</H3>
<PRE>
static final java.lang.String[] <B>LOGTYPE_TEXT</B></PRE>
<DL>
<DD>A textual representation of the notification log type may be obtained using the
return value from getLogType() as an index into the array.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="INotification.html#getLogType()"><CODE>getLogType()</CODE></A></DL>
</DL>
<HR>
<A NAME="MONITOR_SUBCATEGORY"><!-- --></A><H3>
MONITOR_SUBCATEGORY</H3>
<PRE>
static final short <B>MONITOR_SUBCATEGORY</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.MONITOR_SUBCATEGORY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SECURITY_SUBCATEGORY"><!-- --></A><H3>
SECURITY_SUBCATEGORY</H3>
<PRE>
static final short <B>SECURITY_SUBCATEGORY</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.SECURITY_SUBCATEGORY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_SUBCATEGORY"><!-- --></A><H3>
STATE_SUBCATEGORY</H3>
<PRE>
static final short <B>STATE_SUBCATEGORY</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.STATE_SUBCATEGORY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STORAGE_SUBCATEGORY"><!-- --></A><H3>
STORAGE_SUBCATEGORY</H3>
<PRE>
static final short <B>STORAGE_SUBCATEGORY</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.STORAGE_SUBCATEGORY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SUBCATEGORY_TEXT"><!-- --></A><H3>
SUBCATEGORY_TEXT</H3>
<PRE>
static final java.lang.String[] <B>SUBCATEGORY_TEXT</B></PRE>
<DL>
<DD>A textual representation of the notification subcategory may be obtained using the
return value from getSubCategory() as an index into the array.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="INotification.html#getSubCategory()"><CODE>getSubCategory()</CODE></A></DL>
</DL>
<HR>
<A NAME="SUCCESS_AUDIT_TYPE"><!-- --></A><H3>
SUCCESS_AUDIT_TYPE</H3>
<PRE>
static final short <B>SUCCESS_AUDIT_TYPE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.SUCCESS_AUDIT_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SYSTEM_CATEGORY"><!-- --></A><H3>
SYSTEM_CATEGORY</H3>
<PRE>
static final short <B>SYSTEM_CATEGORY</B></PRE>
<DL>
<DD>Management framework system notifications (reserved for internal use only)
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.SYSTEM_CATEGORY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="WARNING_TYPE"><!-- --></A><H3>
WARNING_TYPE</H3>
<PRE>
static final short <B>WARNING_TYPE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.INotification.WARNING_TYPE">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getAttributes()"><!-- --></A><H3>
getAttributes</H3>
<PRE>
java.util.HashMap <B>getAttributes</B>()</PRE>
<DL>
<DD>Gets the event information specified as attributes.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The attribute table or null if there are no attributes.</DL>
</DD>
</DL>
<HR>
<A NAME="getCategory()"><!-- --></A><H3>
getCategory</H3>
<PRE>
short <B>getCategory</B>()</PRE>
<DL>
<DD>Each notification belongs to a major category.
<p>
Permissible values are 0 thru 3 (see <>_CATEGORY constants).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getEventName()"><!-- --></A><H3>
getEventName</H3>
<PRE>
java.lang.String <B>getEventName</B>()</PRE>
<DL>
<DD>Each notification type is unique by category/subcategory/event name. Event names
are descriptive of what event generated the notification.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getLogType()"><!-- --></A><H3>
getLogType</H3>
<PRE>
short <B>getLogType</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="INotification.html#setLogType(short)"><CODE>setLogType(short)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getSequenceNumber()"><!-- --></A><H3>
getSequenceNumber</H3>
<PRE>
long <B>getSequenceNumber</B>()</PRE>
<DL>
<DD>Gets the sequence number for the notification. Sequence numbers are unique within a
component and imply an order based on the time the sequence number is assigned to
the notification. Sequence numbers start at 0 and increment by 1, but some sequence
numbers may appear to be skipped due to the fact that notifications are also used
internally.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The sequence number of the notification.</DL>
</DD>
</DL>
<HR>
<A NAME="getSeverity()"><!-- --></A><H3>
getSeverity</H3>
<PRE>
int <B>getSeverity</B>()</PRE>
<DL>
<DD>Each notification has a severity associated with it. Severities can be used by
client applications to prioritize multiple notifications. Additionally the severity
of certain notifications will be used to derive an aggregated state for a container.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSourceHost()"><!-- --></A><H3>
getSourceHost</H3>
<PRE>
java.lang.String <B>getSourceHost</B>()</PRE>
<DL>
<DD>Gets the source of the notification. The source of the notification is set by the
container prior to sending the notification to interested parties.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The host IP of the machine hosting the container/component source that
generated the notification.</DL>
</DD>
</DL>
<HR>
<A NAME="getSourceIdentity()"><!-- --></A><H3>
getSourceIdentity</H3>
<PRE>
<A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IComponentIdentity</A> <B>getSourceIdentity</B>()</PRE>
<DL>
<DD>Gets the source of the notification. The source of the notification is set by the
container prior to sending the notification to interested parties.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The MF runtime identity of the component that generated the notification.</DL>
</DD>
</DL>
<HR>
<A NAME="getSubCategory()"><!-- --></A><H3>
getSubCategory</H3>
<PRE>
java.lang.String <B>getSubCategory</B>()</PRE>
<DL>
<DD>Each notification has a minor category.
<p>
A subset of well known values are defined as constants (see <>_SUBCATEGORY constants).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTimeStamp()"><!-- --></A><H3>
getTimeStamp</H3>
<PRE>
long <B>getTimeStamp</B>()</PRE>
<DL>
<DD>Gets the timestamp of the notification. This will be a timestamp based on the
system clock of the machine on which the notification was generated and this should be
taken into account by recipients of notifications that reside on different machines with
a possibly conflicting system clock setting.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The notification timestamp.</DL>
</DD>
</DL>
<HR>
<A NAME="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
java.lang.String <B>getType</B>()</PRE>
<DL>
<DD>Each notification type is unique by category/subcategory/event name. This method returns
the full notification type name as a string.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setAttribute(java.lang.String, java.lang.Object)"><!-- --></A><H3>
setAttribute</H3>
<PRE>
void <B>setAttribute</B>(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</PRE>
<DL>
<DD>Sets a notification attribute (a named piece of event information). Each attribute should
be uniquely named (to avoid overwriting already specified attributes).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The attribute name.<DD><CODE>value</CODE> - The attribute value (should be base types or arrays of base types).</DL>
</DD>
</DL>
<HR>
<A NAME="setLogType(short)"><!-- --></A><H3>
setLogType</H3>
<PRE>
void <B>setLogType</B>(short&nbsp;logType)</PRE>
<DL>
<DD>Each notification can be assigned a log type. If not set explicitly it will derived
from the severity.
<p>
Log types are intended for indexing of information types by log\audit services (e.g.
Microsoft Event Viewer). They provide a narrower/alternate view of severity.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>logType</CODE> - Permissible values are 0 thru 4 (see <>_TYPE constants).</DL>
</DD>
</DL>
<HR>
<A NAME="setSourceIdentity(com.sonicsw.mf.common.runtime.IComponentIdentity)"><!-- --></A><H3>
setSourceIdentity</H3>
<PRE>
void <B>setSourceIdentity</B>(<A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IComponentIdentity</A>&nbsp;sourceIdentity)</PRE>
<DL>
<DD>Sets the source of the notification. The source of the notification is set by the
container prior to sending the notification to interested parties.
Once set the sourceIdenity cannot be reset.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="INotification.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IMonitoredNotifications.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IRemoteCallResult.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FINotification.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="INotification.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="INotification.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="INotification.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="INotification.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="INotification.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,223 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:19 EDT 2011 -->
<TITLE>
IRemoteCallResult (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IRemoteCallResult interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IRemoteCallResult (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IRemoteCallResult.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="INotification.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IRemoteExecResult.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIRemoteCallResult.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IRemoteCallResult.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IRemoteCallResult.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IRemoteCallResult.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IRemoteCallResult</H2>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="IRemoteExecResult.html" title="interface in com.sonicsw.mf.common.runtime">IRemoteExecResult</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IRemoteCallResult</B></DL>
</PRE>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IRemoteCallResult.html#getOutput()">getOutput</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IRemoteCallResult.html#isSuccessful()">isSuccessful</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getOutput()"><!-- --></A><H3>
getOutput</H3>
<PRE>
java.lang.String <B>getOutput</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isSuccessful()"><!-- --></A><H3>
isSuccessful</H3>
<PRE>
boolean <B>isSuccessful</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IRemoteCallResult.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="INotification.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IRemoteExecResult.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIRemoteCallResult.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IRemoteCallResult.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IRemoteCallResult.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IRemoteCallResult.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,260 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
IRemoteExecResult (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IRemoteExecResult interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IRemoteExecResult (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IRemoteExecResult.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IRemoteCallResult.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIRemoteExecResult.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IRemoteExecResult.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IRemoteExecResult.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IRemoteExecResult.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IRemoteExecResult</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="IRemoteCallResult.html" title="interface in com.sonicsw.mf.common.runtime">IRemoteCallResult</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IRemoteExecResult</B><DT>extends <A HREF="IRemoteCallResult.html" title="interface in com.sonicsw.mf.common.runtime">IRemoteCallResult</A></DL>
</PRE>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IRemoteExecResult.html#getExitCode()">getExitCode</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IRemoteExecResult.html#getProcessStdError()">getProcessStdError</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IRemoteExecResult.html#getProcessStdOutput()">getProcessStdOutput</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.runtime.IRemoteCallResult"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.sonicsw.mf.common.runtime.<A HREF="IRemoteCallResult.html" title="interface in com.sonicsw.mf.common.runtime">IRemoteCallResult</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="IRemoteCallResult.html#getOutput()">getOutput</A>, <A HREF="IRemoteCallResult.html#isSuccessful()">isSuccessful</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getExitCode()"><!-- --></A><H3>
getExitCode</H3>
<PRE>
int <B>getExitCode</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getProcessStdError()"><!-- --></A><H3>
getProcessStdError</H3>
<PRE>
byte[] <B>getProcessStdError</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getProcessStdOutput()"><!-- --></A><H3>
getProcessStdOutput</H3>
<PRE>
byte[] <B>getProcessStdOutput</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IRemoteExecResult.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IRemoteCallResult.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIRemoteExecResult.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IRemoteExecResult.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IRemoteExecResult.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IRemoteExecResult.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,326 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
IState (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IState interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IState (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IState.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IRemoteExecResult.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IStateController.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIState.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IState.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IState.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IState.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IState</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.lang.Comparable</DD>
</DL>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="IChildContainerState.html" title="interface in com.sonicsw.mf.common.runtime">IChildContainerState</A>, <A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime">IComponentState</A>, <A HREF="IContainerState.html" title="interface in com.sonicsw.mf.common.runtime">IContainerState</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IState</B><DT>extends java.lang.Comparable</DL>
</PRE>
<P>
A base interface for interfaces that describe container or component runtime state.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IContainerState</CODE></A>,
<A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IComponentState</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IState.html#compareTo(java.lang.Object)">compareTo</A></B>(java.lang.Object&nbsp;object)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares this object with the specified object for order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IState.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;object)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests if the given object is equal to this identity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IIdentity</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="IState.html#getRuntimeIdentity()">getRuntimeIdentity</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the runtime identity of the source of the state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IState.html#getState()">getState</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the runtime state value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IState.html#getStateString()">getStateString</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a textual description for the runtime state value.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
compareTo</H3>
<PRE>
int <B>compareTo</B>(java.lang.Object&nbsp;object)
throws java.lang.ClassCastException</PRE>
<DL>
<DD>Compares this object with the specified object for order. Returns a negative integer,
zero, or a positive integer as this object is less than, equal to, or greater than
the specified object. Comparison is made using the toString() value.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.lang.ClassCastException</CODE> - If the given object is not an instance of the same object.</DL>
</DD>
</DL>
<HR>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
boolean <B>equals</B>(java.lang.Object&nbsp;object)</PRE>
<DL>
<DD>Tests if the given object is equal to this identity.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>Returns true if the runtime identity of this state and its state
equals that of the given object.</DL>
</DD>
</DL>
<HR>
<A NAME="getRuntimeIdentity()"><!-- --></A><H3>
getRuntimeIdentity</H3>
<PRE>
<A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IIdentity</A> <B>getRuntimeIdentity</B>()</PRE>
<DL>
<DD>Get the runtime identity of the source of the state.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getState()"><!-- --></A><H3>
getState</H3>
<PRE>
short <B>getState</B>()</PRE>
<DL>
<DD>Get the runtime state value.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>Return either a container or component runtime state value. Possible values
are described in their respective interfaces ("STATE_<>" members).<DT><B>See Also:</B><DD><A HREF="IContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IContainerState</CODE></A>,
<A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IComponentState</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getStateString()"><!-- --></A><H3>
getStateString</H3>
<PRE>
java.lang.String <B>getStateString</B>()</PRE>
<DL>
<DD>Get a textual description for the runtime state value.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="IContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IContainerState</CODE></A>,
<A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IComponentState</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IState.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IRemoteExecResult.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IStateController.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIState.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IState.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IState.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IState.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,216 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
IStateController (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IStateController interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IStateController (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IStateController.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IStateListener.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIStateController.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IStateController.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IStateController.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IStateController.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IStateController</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IStateController</B></DL>
</PRE>
<P>
State controllers cause the behavioral change required by a transition from on
particular state to another particular state.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><CODE>StateManager</CODE></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IStateController.html#changeState()">changeState</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called by the StateManager when a transition from one state to another is required</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="changeState()"><!-- --></A><H3>
changeState</H3>
<PRE>
boolean <B>changeState</B>()
throws <A HREF="NonRecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime">NonRecoverableStateChangeException</A>,
<A HREF="RecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime">RecoverableStateChangeException</A></PRE>
<DL>
<DD>Called by the StateManager when a transition from one state to another is required
<P>
<DD><DL>
<DT><B>Returns:</B><DD>Whether the state transition was succesful or not
<DT><B>Throws:</B>
<DD><CODE><A HREF="NonRecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime">NonRecoverableStateChangeException</A></CODE>
<DD><CODE><A HREF="RecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime">RecoverableStateChangeException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IStateController.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IStateListener.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIStateController.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IStateController.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IStateController.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IStateController.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,258 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
IStateListener (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IStateListener interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IStateListener (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IStateListener.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IStateController.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IStateManager.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIStateListener.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IStateListener.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IStateListener.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IStateListener.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IStateListener</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IStateListener</B></DL>
</PRE>
<P>
State listener methods are called for all state changes. State listeners are registered
with a StateManager.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><CODE>StateManager</CODE></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IStateListener.html#stateChanged(short, short)">stateChanged</A></B>(short&nbsp;previousState,
short&nbsp;currentState)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called immediately after a state controller successfully actions a requested state change.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IStateListener.html#stateChangeFailed(short, short)">stateChangeFailed</A></B>(short&nbsp;currentState,
short&nbsp;intendedState)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called immediately before a state controller unsuccessfully actions a requested state change.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IStateListener.html#stateChanging(short, short)">stateChanging</A></B>(short&nbsp;currentState,
short&nbsp;intendedState)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called immediately before a state controller actions a requested state change.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="stateChanged(short, short)"><!-- --></A><H3>
stateChanged</H3>
<PRE>
void <B>stateChanged</B>(short&nbsp;previousState,
short&nbsp;currentState)</PRE>
<DL>
<DD>Called immediately after a state controller successfully actions a requested state change.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="IStateController.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IStateController</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="stateChangeFailed(short, short)"><!-- --></A><H3>
stateChangeFailed</H3>
<PRE>
void <B>stateChangeFailed</B>(short&nbsp;currentState,
short&nbsp;intendedState)</PRE>
<DL>
<DD>Called immediately before a state controller unsuccessfully actions a requested state change.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="IStateController.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IStateController</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="stateChanging(short, short)"><!-- --></A><H3>
stateChanging</H3>
<PRE>
void <B>stateChanging</B>(short&nbsp;currentState,
short&nbsp;intendedState)</PRE>
<DL>
<DD>Called immediately before a state controller actions a requested state change.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="IStateController.html" title="interface in com.sonicsw.mf.common.runtime"><CODE>IStateController</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IStateListener.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IStateController.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IStateManager.html" title="interface in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIStateListener.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IStateListener.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IStateListener.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IStateListener.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,323 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
IStateManager (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.IStateManager interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IStateManager (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IStateManager.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IStateListener.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="Level.html" title="class in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIStateManager.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IStateManager.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IStateManager.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IStateManager.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Interface IStateManager</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IStateManager</B></DL>
</PRE>
<P>
A concrete implementation of the IStateManager interface acts as a central point
for managing the state of an entity, such as the fault tolerant state of the DS or AM.
<p>
A concrete state manager implementation is configured with a set.
<p>
State controllers (implementers of IStateController) may be registered to effect
the behavioral adjustments associated with a particular state transition.
<p>
State listeners (implementors of IStateListener) may be added to be informed when
a state transitions starts and whether the transition succeeds or fails.
<p>
A developer should not attempt to request a state change from either a state
controller or a state listener.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IStateManager.html#getState(java.lang.Object)">getState</A></B>(java.lang.Object&nbsp;obj)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the state of the specified object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IStateManager.html#registerStateController(com.sonicsw.mf.common.runtime.IStateController, short, short, java.lang.Object)">registerStateController</A></B>(<A HREF="IStateController.html" title="interface in com.sonicsw.mf.common.runtime">IStateController</A>&nbsp;stateController,
short&nbsp;fromState,
short&nbsp;toState,
java.lang.Object&nbsp;obj)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Register a state controller that will cause the behvioral changes associated
with the transition from one specified state to another specified state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IStateManager.html#registerStateListener(com.sonicsw.mf.common.runtime.IStateListener, java.lang.Object)">registerStateListener</A></B>(<A HREF="IStateListener.html" title="interface in com.sonicsw.mf.common.runtime">IStateListener</A>&nbsp;stateListener,
java.lang.Object&nbsp;obj)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Register a listener for the changes in state of the state-managed object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="IStateManager.html#requestStateChange(short, short, java.lang.Object)">requestStateChange</A></B>(short&nbsp;expectedCurrentState,
short&nbsp;desiredState,
java.lang.Object&nbsp;obj)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The thread that detects the condition that requires a state change will call this
method to effect the state change.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getState(java.lang.Object)"><!-- --></A><H3>
getState</H3>
<PRE>
short <B>getState</B>(java.lang.Object&nbsp;obj)</PRE>
<DL>
<DD>Get the state of the specified object.
For a concrete implementation that is designed to managed only a single object's state,
the input argument could be null.
For a concrete implementation that is designed to manage the states of multiple
objects, the input argument would be the reference to the object instance whose
state is to be returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>Object</CODE> - The object instance whose current state is to be returned.
<DT><B>Returns:</B><DD>short The current state of the object instance.</DL>
</DD>
</DL>
<HR>
<A NAME="registerStateController(com.sonicsw.mf.common.runtime.IStateController, short, short, java.lang.Object)"><!-- --></A><H3>
registerStateController</H3>
<PRE>
void <B>registerStateController</B>(<A HREF="IStateController.html" title="interface in com.sonicsw.mf.common.runtime">IStateController</A>&nbsp;stateController,
short&nbsp;fromState,
short&nbsp;toState,
java.lang.Object&nbsp;obj)</PRE>
<DL>
<DD>Register a state controller that will cause the behvioral changes associated
with the transition from one specified state to another specified state.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stateController</CODE> - The concrete implementation of IStateController that will perform the steps necessary for the state transition<DD><CODE>fromState</CODE> - The state at which the state-managed entity must be in order for the controller will be invoked<DD><CODE>toState</CODE> - The state to which the state-managed entity must transition in order for the controller to be invoked<DD><CODE>obj</CODE> - The state-managed object with which the controller is associated</DL>
</DD>
</DL>
<HR>
<A NAME="registerStateListener(com.sonicsw.mf.common.runtime.IStateListener, java.lang.Object)"><!-- --></A><H3>
registerStateListener</H3>
<PRE>
void <B>registerStateListener</B>(<A HREF="IStateListener.html" title="interface in com.sonicsw.mf.common.runtime">IStateListener</A>&nbsp;stateListener,
java.lang.Object&nbsp;obj)</PRE>
<DL>
<DD>Register a listener for the changes in state of the state-managed object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stateListener</CODE> - The concrete implementation of IStateListener<DD><CODE>obj</CODE> - The state-managed object to which the listener will be associated</DL>
</DD>
</DL>
<HR>
<A NAME="requestStateChange(short, short, java.lang.Object)"><!-- --></A><H3>
requestStateChange</H3>
<PRE>
boolean <B>requestStateChange</B>(short&nbsp;expectedCurrentState,
short&nbsp;desiredState,
java.lang.Object&nbsp;obj)
throws <A HREF="NonRecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime">NonRecoverableStateChangeException</A>,
<A HREF="RecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime">RecoverableStateChangeException</A></PRE>
<DL>
<DD>The thread that detects the condition that requires a state change will call this
method to effect the state change.
<p>
The calling thread is expected to have previously obtained the current state and
to have made the decision as to what is the next state that should be applied. To
ensure synchronization between calls, the caller is required to provide the expected
current state so that it can possibly retry if another thread changed the state
between the callers calls.
If the current state, from the state manager's perspective, does not match the current
state expected by the caller, then a value of "false" should be returned. Likewise, if
the transition to the requested desired state from the current state does not represent
an allowable transition, then a value of "false" should be returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>expectedCurrentState</CODE> - The current state obtained immediately before calling
this method<DD><CODE>desiredState</CODE> - The state the caller wishes to transition to<DD><CODE>obj</CODE> - The state-managed object whose state is to be changed
<DT><B>Returns:</B><DD>Return true if the state transition was successful, false if not.
<DT><B>Throws:</B>
<DD><CODE><A HREF="NonRecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime">NonRecoverableStateChangeException</A></CODE>
<DD><CODE><A HREF="RecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime">RecoverableStateChangeException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IStateManager.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IStateListener.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="Level.html" title="class in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FIStateManager.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IStateManager.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IStateManager.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IStateManager.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,447 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
Level (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.Level class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Level (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="Level.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IStateManager.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="NonRecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FLevel.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Level.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="Level.html#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="Level.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="Level.html#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="Level.html#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="Level.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Class Level</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.mf.common.runtime.Level</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>Level</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Defines a standard set of logging severity levels. It is intended as a way
of partially replicating what is comming in the java.util.logging package
in JDK 1.4.
<p>
It is intended for use when logging messages through a component context,
registering a component error condition through the component context, etc.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="Level.html#CONFIG">CONFIG</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CONFIG is a message/notification level for static configuration messages.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="Level.html#FINE">FINE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;FINE is a message level providing tracing information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="Level.html#FINER">FINER</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;FINER indicates a fairly detailed tracing message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="Level.html#FINEST">FINEST</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;FINEST indicates a highly detailed tracing message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="Level.html#INFO">INFO</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INFO is a message/notification level for informational messages.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="Level.html#LEVEL_TEXT">LEVEL_TEXT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Textual representations of levels.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="Level.html#SEVERE">SEVERE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;SEVERE is a message/notification level indicating a serious failure.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="Level.html#TRACE">TRACE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;TRACE is the same value as FINEST.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="Level.html#UNKNOWN">UNKNOWN</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;UNKNOWN is an undefined level and should not be generally used,</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="Level.html#WARNING">WARNING</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;WARNING is a message/notification level indicating a potential problem.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="Level.html#Level()">Level</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="CONFIG"><!-- --></A><H3>
CONFIG</H3>
<PRE>
public static final int <B>CONFIG</B></PRE>
<DL>
<DD>CONFIG is a message/notification level for static configuration messages.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.Level.CONFIG">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FINE"><!-- --></A><H3>
FINE</H3>
<PRE>
public static final int <B>FINE</B></PRE>
<DL>
<DD>FINE is a message level providing tracing information.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.Level.FINE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FINER"><!-- --></A><H3>
FINER</H3>
<PRE>
public static final int <B>FINER</B></PRE>
<DL>
<DD>FINER indicates a fairly detailed tracing message.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.Level.FINER">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FINEST"><!-- --></A><H3>
FINEST</H3>
<PRE>
public static final int <B>FINEST</B></PRE>
<DL>
<DD>FINEST indicates a highly detailed tracing message.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.Level.FINEST">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="INFO"><!-- --></A><H3>
INFO</H3>
<PRE>
public static final int <B>INFO</B></PRE>
<DL>
<DD>INFO is a message/notification level for informational messages.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.Level.INFO">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LEVEL_TEXT"><!-- --></A><H3>
LEVEL_TEXT</H3>
<PRE>
public static final java.lang.String[] <B>LEVEL_TEXT</B></PRE>
<DL>
<DD>Textual representations of levels.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="SEVERE"><!-- --></A><H3>
SEVERE</H3>
<PRE>
public static final int <B>SEVERE</B></PRE>
<DL>
<DD>SEVERE is a message/notification level indicating a serious failure.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.Level.SEVERE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="TRACE"><!-- --></A><H3>
TRACE</H3>
<PRE>
public static final int <B>TRACE</B></PRE>
<DL>
<DD>TRACE is the same value as FINEST. It is reserved for tracing information
generated for debugging.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.Level.TRACE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="UNKNOWN"><!-- --></A><H3>
UNKNOWN</H3>
<PRE>
public static final int <B>UNKNOWN</B></PRE>
<DL>
<DD>UNKNOWN is an undefined level and should not be generally used,
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.Level.UNKNOWN">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="WARNING"><!-- --></A><H3>
WARNING</H3>
<PRE>
public static final int <B>WARNING</B></PRE>
<DL>
<DD>WARNING is a message/notification level indicating a potential problem.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.runtime.Level.WARNING">Constant Field Values</A></DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="Level()"><!-- --></A><H3>
Level</H3>
<PRE>
public <B>Level</B>()</PRE>
<DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="Level.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IStateManager.html" title="interface in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="NonRecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FLevel.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Level.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="Level.html#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="Level.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="Level.html#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="Level.html#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="Level.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,253 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
NonRecoverableStateChangeException (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.NonRecoverableStateChangeException class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="NonRecoverableStateChangeException (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="NonRecoverableStateChangeException.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="Level.html" title="class in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="RecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FNonRecoverableStateChangeException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="NonRecoverableStateChangeException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="NonRecoverableStateChangeException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="NonRecoverableStateChangeException.html#methods_inherited_from_class_com.sonicsw.mf.common.MFException">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="NonRecoverableStateChangeException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Class NonRecoverableStateChangeException</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../MFException.html" title="class in com.sonicsw.mf.common">com.sonicsw.mf.common.MFException</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.mf.common.runtime.NonRecoverableStateChangeException</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>NonRecoverableStateChangeException</B><DT>extends <A HREF="../MFException.html" title="class in com.sonicsw.mf.common">MFException</A></DL>
</PRE>
<P>
Thrown by an IStateController when it has determined that it will never be able to
perform a requested state change without manual corrective action. The same excpetion
will be propagated by an IStateManager.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IStateController.html#changeState()"><CODE>IStateController.changeState()</CODE></A>,
<A HREF="IStateManager.html#requestStateChange(short, short, java.lang.Object)"><CODE>IStateManager.requestStateChange(short, short, Object)</CODE></A>,
<A HREF="../../../../../serialized-form.html#com.sonicsw.mf.common.runtime.NonRecoverableStateChangeException">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="NonRecoverableStateChangeException.html#NonRecoverableStateChangeException(java.lang.String)">NonRecoverableStateChangeException</A></B>(java.lang.String&nbsp;message)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.MFException"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.sonicsw.mf.common.<A HREF="../MFException.html" title="class in com.sonicsw.mf.common">MFException</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../MFException.html#getMessage()">getMessage</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="NonRecoverableStateChangeException(java.lang.String)"><!-- --></A><H3>
NonRecoverableStateChangeException</H3>
<PRE>
public <B>NonRecoverableStateChangeException</B>(java.lang.String&nbsp;message)</PRE>
<DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="NonRecoverableStateChangeException.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="Level.html" title="class in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="RecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FNonRecoverableStateChangeException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="NonRecoverableStateChangeException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="NonRecoverableStateChangeException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="NonRecoverableStateChangeException.html#methods_inherited_from_class_com.sonicsw.mf.common.MFException">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="NonRecoverableStateChangeException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,256 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
RecoverableStateChangeException (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime.RecoverableStateChangeException class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="RecoverableStateChangeException (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="RecoverableStateChangeException.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="NonRecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FRecoverableStateChangeException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="RecoverableStateChangeException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="RecoverableStateChangeException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="RecoverableStateChangeException.html#methods_inherited_from_class_com.sonicsw.mf.common.MFException">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="RecoverableStateChangeException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.runtime</FONT>
<BR>
Class RecoverableStateChangeException</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../MFException.html" title="class in com.sonicsw.mf.common">com.sonicsw.mf.common.MFException</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.mf.common.runtime.RecoverableStateChangeException</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>RecoverableStateChangeException</B><DT>extends <A HREF="../MFException.html" title="class in com.sonicsw.mf.common">MFException</A></DL>
</PRE>
<P>
Thrown by an IStateController when it has determined that it cannot perform the requested
state change without backing out the requested state change and re-evaluating whether the
requested state change is still required. The same excpetion will be propagated by an
IStateManager.
<p>
Not all state change implementations will support recovery.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IStateController.html#changeState()"><CODE>IStateController.changeState()</CODE></A>,
<A HREF="IStateManager.html#requestStateChange(short, short, java.lang.Object)"><CODE>IStateManager.requestStateChange(short, short, Object)</CODE></A>,
<A HREF="../../../../../serialized-form.html#com.sonicsw.mf.common.runtime.RecoverableStateChangeException">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="RecoverableStateChangeException.html#RecoverableStateChangeException(java.lang.String)">RecoverableStateChangeException</A></B>(java.lang.String&nbsp;message)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.MFException"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.sonicsw.mf.common.<A HREF="../MFException.html" title="class in com.sonicsw.mf.common">MFException</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../MFException.html#getMessage()">getMessage</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="RecoverableStateChangeException(java.lang.String)"><!-- --></A><H3>
RecoverableStateChangeException</H3>
<PRE>
public <B>RecoverableStateChangeException</B>(java.lang.String&nbsp;message)</PRE>
<DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="RecoverableStateChangeException.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="NonRecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252FRecoverableStateChangeException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="RecoverableStateChangeException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="RecoverableStateChangeException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="RecoverableStateChangeException.html#methods_inherited_from_class_com.sonicsw.mf.common.MFException">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="RecoverableStateChangeException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,96 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:09 EDT 2011 -->
<TITLE>
com.sonicsw.mf.common.runtime (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<FONT size="+1" CLASS="FrameTitleFont">
<A HREF="package-summary.html" target="classFrame">com.sonicsw.mf.common.runtime</A></FONT>
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
<TR>
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
Interfaces</FONT>&nbsp;
<FONT CLASS="FrameItemFont">
<BR>
<A HREF="IBackupStatus.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IBackupStatus</I></A>
<BR>
<A HREF="ICanonicalName.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>ICanonicalName</I></A>
<BR>
<A HREF="IChildContainerState.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IChildContainerState</I></A>
<BR>
<A HREF="ICollectiveOpStatus.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>ICollectiveOpStatus</I></A>
<BR>
<A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IComponentIdentity</I></A>
<BR>
<A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IComponentState</I></A>
<BR>
<A HREF="IContainerExitCodes.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IContainerExitCodes</I></A>
<BR>
<A HREF="IContainerIdentity.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IContainerIdentity</I></A>
<BR>
<A HREF="IContainerState.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IContainerState</I></A>
<BR>
<A HREF="IFaultTolerantState.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IFaultTolerantState</I></A>
<BR>
<A HREF="IFileDescriptor.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IFileDescriptor</I></A>
<BR>
<A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IIdentity</I></A>
<BR>
<A HREF="IMonitoredMetrics.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IMonitoredMetrics</I></A>
<BR>
<A HREF="IMonitoredNotifications.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IMonitoredNotifications</I></A>
<BR>
<A HREF="INotification.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>INotification</I></A>
<BR>
<A HREF="IRemoteCallResult.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IRemoteCallResult</I></A>
<BR>
<A HREF="IRemoteExecResult.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IRemoteExecResult</I></A>
<BR>
<A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IState</I></A>
<BR>
<A HREF="IStateController.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IStateController</I></A>
<BR>
<A HREF="IStateListener.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IStateListener</I></A>
<BR>
<A HREF="IStateManager.html" title="interface in com.sonicsw.mf.common.runtime" target="classFrame"><I>IStateManager</I></A></FONT></TD>
</TR>
</TABLE>
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
<TR>
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
Classes</FONT>&nbsp;
<FONT CLASS="FrameItemFont">
<BR>
<A HREF="Level.html" title="class in com.sonicsw.mf.common.runtime" target="classFrame">Level</A></FONT></TD>
</TR>
</TABLE>
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
<TR>
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
Exceptions</FONT>&nbsp;
<FONT CLASS="FrameItemFont">
<BR>
<A HREF="NonRecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime" target="classFrame">NonRecoverableStateChangeException</A>
<BR>
<A HREF="RecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime" target="classFrame">RecoverableStateChangeException</A></FONT></TD>
</TR>
</TABLE>
</BODY>
</HTML>
@@ -0,0 +1,279 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:10 EDT 2011 -->
<TITLE>
com.sonicsw.mf.common.runtime (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.runtime package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="com.sonicsw.mf.common.runtime (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="package-summary.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../metrics/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../security/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252Fpackage-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package com.sonicsw.mf.common.runtime
</H2>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IBackupStatus.html" title="interface in com.sonicsw.mf.common.runtime">IBackupStatus</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="ICanonicalName.html" title="interface in com.sonicsw.mf.common.runtime">ICanonicalName</A></B></TD>
<TD>The implmentation of this interface represents the canonical name form
of a container ot component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IChildContainerState.html" title="interface in com.sonicsw.mf.common.runtime">IChildContainerState</A></B></TD>
<TD>The implmentation of this interface represents the state of a child container
managed by an Activation Daemon.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="ICollectiveOpStatus.html" title="interface in com.sonicsw.mf.common.runtime">ICollectiveOpStatus</A></B></TD>
<TD>Contains the status of a collective invocation of an operation or a collective setup of an attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IComponentIdentity</A></B></TD>
<TD>Represents the identity of component runtime instances.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime">IComponentState</A></B></TD>
<TD>Indicates the runtime state of a component within its container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IContainerExitCodes.html" title="interface in com.sonicsw.mf.common.runtime">IContainerExitCodes</A></B></TD>
<TD>This interface describes the possible exit codes that may be generated on container termination.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IContainerIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IContainerIdentity</A></B></TD>
<TD>Represents the identity of container runtime instances.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IContainerState.html" title="interface in com.sonicsw.mf.common.runtime">IContainerState</A></B></TD>
<TD>The implmentation of this interface represents the state of a container and
all its hosted components.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IFaultTolerantState.html" title="interface in com.sonicsw.mf.common.runtime">IFaultTolerantState</A></B></TD>
<TD>Indicates the general permissible set of fault tolerant states.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IFileDescriptor.html" title="interface in com.sonicsw.mf.common.runtime">IFileDescriptor</A></B></TD>
<TD>File information to be sent remotely from the Host Manager to a client</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime">IIdentity</A></B></TD>
<TD>A base interface representing the runtime identity of runtime entities.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IMonitoredMetrics.html" title="interface in com.sonicsw.mf.common.runtime">IMonitoredMetrics</A></B></TD>
<TD>The IMonitoredMetrics interface represents a collection of stored metrics
that are retrieved from a CollectionsMonitor instance, along with the timestamp of the
last retrieved metric and a flag to indicate if there are any additional stored
metrics to be retrieved from the CollectionsMonitor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IMonitoredNotifications.html" title="interface in com.sonicsw.mf.common.runtime">IMonitoredNotifications</A></B></TD>
<TD>The IMonitoredNotifications interface represents a collection of stored notifications
that are retrieved from a CollectionsMonitor instance, along with the timestamp of the
last retrieved notification and a flag to indicate if there are any additional stored
notifications to be retrieved from the CollectionsMonitor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="INotification.html" title="interface in com.sonicsw.mf.common.runtime">INotification</A></B></TD>
<TD>The notification interface represents a notification emitted from a Sonic
Management Framework compliant component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IRemoteCallResult.html" title="interface in com.sonicsw.mf.common.runtime">IRemoteCallResult</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IRemoteExecResult.html" title="interface in com.sonicsw.mf.common.runtime">IRemoteExecResult</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime">IState</A></B></TD>
<TD>A base interface for interfaces that describe container or component runtime state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IStateController.html" title="interface in com.sonicsw.mf.common.runtime">IStateController</A></B></TD>
<TD>State controllers cause the behavioral change required by a transition from on
particular state to another particular state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IStateListener.html" title="interface in com.sonicsw.mf.common.runtime">IStateListener</A></B></TD>
<TD>State listener methods are called for all state changes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="IStateManager.html" title="interface in com.sonicsw.mf.common.runtime">IStateManager</A></B></TD>
<TD>A concrete implementation of the IStateManager interface acts as a central point
for managing the state of an entity, such as the fault tolerant state of the DS or AM.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="Level.html" title="class in com.sonicsw.mf.common.runtime">Level</A></B></TD>
<TD>Defines a standard set of logging severity levels.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Exception Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="NonRecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime">NonRecoverableStateChangeException</A></B></TD>
<TD>Thrown by an IStateController when it has determined that it will never be able to
perform a requested state change without manual corrective action.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="RecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime">RecoverableStateChangeException</A></B></TD>
<TD>Thrown by an IStateController when it has determined that it cannot perform the requested
state change without backing out the requested state change and re-evaluating whether the
requested state change is still required.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="package-summary.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../metrics/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../security/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252Fpackage-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,170 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:26:10 EDT 2011 -->
<TITLE>
com.sonicsw.mf.common.runtime Class Hierarchy (Management Application API)
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="com.sonicsw.mf.common.runtime Class Hierarchy (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="package-tree.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../metrics/package-tree.html"><B>PREV</B></A>&nbsp;
&nbsp;<A HREF="../security/package-tree.html"><B>NEXT</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252Fpackage-tree.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<CENTER>
<H2>
Hierarchy For Package com.sonicsw.mf.common.runtime
</H2>
</CENTER>
<DL>
<DT><B>Package Hierarchies:</B><DD><A HREF="../../../../../overview-tree.html">All Packages</A></DL>
<HR>
<H2>
Class Hierarchy
</H2>
<UL>
<LI TYPE="circle">java.lang.Object<UL>
<LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="Level.html" title="class in com.sonicsw.mf.common.runtime"><B>Level</B></A><LI TYPE="circle">java.lang.Throwable (implements java.io.Serializable)
<UL>
<LI TYPE="circle">java.lang.Exception<UL>
<LI TYPE="circle">com.sonicsw.mf.common.<A HREF="../MFException.html" title="class in com.sonicsw.mf.common"><B>MFException</B></A> (implements java.io.Serializable)
<UL>
<LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="NonRecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime"><B>NonRecoverableStateChangeException</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="RecoverableStateChangeException.html" title="class in com.sonicsw.mf.common.runtime"><B>RecoverableStateChangeException</B></A></UL>
</UL>
</UL>
</UL>
</UL>
<H2>
Interface Hierarchy
</H2>
<UL>
<LI TYPE="circle">java.lang.Comparable&lt;T&gt;<UL>
<LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="ICanonicalName.html" title="interface in com.sonicsw.mf.common.runtime"><B>ICanonicalName</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>IIdentity</B></A><UL>
<LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IComponentIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>IComponentIdentity</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IContainerIdentity.html" title="interface in com.sonicsw.mf.common.runtime"><B>IContainerIdentity</B></A></UL>
<LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IState.html" title="interface in com.sonicsw.mf.common.runtime"><B>IState</B></A><UL>
<LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IChildContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><B>IChildContainerState</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IComponentState.html" title="interface in com.sonicsw.mf.common.runtime"><B>IComponentState</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IContainerState.html" title="interface in com.sonicsw.mf.common.runtime"><B>IContainerState</B></A></UL>
</UL>
<LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IBackupStatus.html" title="interface in com.sonicsw.mf.common.runtime"><B>IBackupStatus</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="ICollectiveOpStatus.html" title="interface in com.sonicsw.mf.common.runtime"><B>ICollectiveOpStatus</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IContainerExitCodes.html" title="interface in com.sonicsw.mf.common.runtime"><B>IContainerExitCodes</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IFaultTolerantState.html" title="interface in com.sonicsw.mf.common.runtime"><B>IFaultTolerantState</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IFileDescriptor.html" title="interface in com.sonicsw.mf.common.runtime"><B>IFileDescriptor</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IRemoteCallResult.html" title="interface in com.sonicsw.mf.common.runtime"><B>IRemoteCallResult</B></A><UL>
<LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IRemoteExecResult.html" title="interface in com.sonicsw.mf.common.runtime"><B>IRemoteExecResult</B></A></UL>
<LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IStateController.html" title="interface in com.sonicsw.mf.common.runtime"><B>IStateController</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IStateListener.html" title="interface in com.sonicsw.mf.common.runtime"><B>IStateListener</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IStateManager.html" title="interface in com.sonicsw.mf.common.runtime"><B>IStateManager</B></A><LI TYPE="circle">java.io.Serializable<UL>
<LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IMonitoredMetrics.html" title="interface in com.sonicsw.mf.common.runtime"><B>IMonitoredMetrics</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="IMonitoredNotifications.html" title="interface in com.sonicsw.mf.common.runtime"><B>IMonitoredNotifications</B></A><LI TYPE="circle">com.sonicsw.mf.common.runtime.<A HREF="INotification.html" title="interface in com.sonicsw.mf.common.runtime"><B>INotification</B></A></UL>
</UL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="package-tree.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../metrics/package-tree.html"><B>PREV</B></A>&nbsp;
&nbsp;<A HREF="../security/package-tree.html"><B>NEXT</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fruntime%252Fpackage-tree.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,316 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
ConfigurePermissionDeniedException (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.security.ConfigurePermissionDeniedException class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="ConfigurePermissionDeniedException (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="ConfigurePermissionDeniedException.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FConfigurePermissionDeniedException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ConfigurePermissionDeniedException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ConfigurePermissionDeniedException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="ConfigurePermissionDeniedException.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ConfigurePermissionDeniedException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="ConfigurePermissionDeniedException.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.security</FONT>
<BR>
Class ConfigurePermissionDeniedException</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.RuntimeException
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../MFRuntimeException.html" title="class in com.sonicsw.mf.common">com.sonicsw.mf.common.MFRuntimeException</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="ManagementPermissionDeniedException.html" title="class in com.sonicsw.mf.common.security">com.sonicsw.mf.common.security.ManagementPermissionDeniedException</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.mf.common.security.ConfigurePermissionDeniedException</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public final class <B>ConfigurePermissionDeniedException</B><DT>extends <A HREF="ManagementPermissionDeniedException.html" title="class in com.sonicsw.mf.common.security">ManagementPermissionDeniedException</A></DL>
</PRE>
<P>
Unchecked management exception.
<p>
Indicates that a caller attempted to directly or indirectly perform some action
on configuration data stored in the Directory Service but did not have permission
to perform that action.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#com.sonicsw.mf.common.security.ConfigurePermissionDeniedException">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="ConfigurePermissionDeniedException.html#ConfigurePermissionDeniedException(java.lang.String, java.lang.String, int)">ConfigurePermissionDeniedException</A></B>(java.lang.String&nbsp;message,
java.lang.String&nbsp;logicalPath,
int&nbsp;requiredPermission)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new exception with the specified detail message.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="ConfigurePermissionDeniedException.html#getLogicalPath()">getLogicalPath</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the logical path to which the permission was denied (or null if this was a storage path with no logical equivalent).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="ConfigurePermissionDeniedException.html#getRequiredPermission()">getRequiredPermission</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the permission that was denied.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.MFRuntimeException"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.sonicsw.mf.common.<A HREF="../MFRuntimeException.html" title="class in com.sonicsw.mf.common">MFRuntimeException</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../MFRuntimeException.html#getMessage()">getMessage</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ConfigurePermissionDeniedException(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
ConfigurePermissionDeniedException</H3>
<PRE>
public <B>ConfigurePermissionDeniedException</B>(java.lang.String&nbsp;message,
java.lang.String&nbsp;logicalPath,
int&nbsp;requiredPermission)</PRE>
<DL>
<DD>Constructs a new exception with the specified detail message. The
cause is not initialized, and may subsequently be initialized by
a call to <A HREF="../MFRuntimeException.html#setLinkedException(java.lang.Exception)"><CODE>MFRuntimeException.setLinkedException(java.lang.Exception)</CODE></A>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - The textural details of why the permission was denied.<DD><CODE>logicalPath</CODE> - The logical path to which the permission was denied (or null if this was a storage path with no logical equivalent).<DD><CODE>requiredPermission</CODE> - The permission that was denied.<DT><B>See Also:</B><DD><A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigurePermissionBits</CODE></A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getLogicalPath()"><!-- --></A><H3>
getLogicalPath</H3>
<PRE>
public java.lang.String <B>getLogicalPath</B>()</PRE>
<DL>
<DD>Gets the logical path to which the permission was denied (or null if this was a storage path with no logical equivalent).
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getRequiredPermission()"><!-- --></A><H3>
getRequiredPermission</H3>
<PRE>
public int <B>getRequiredPermission</B>()</PRE>
<DL>
<DD>Gets the permission that was denied.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="ConfigurePermissionDeniedException.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FConfigurePermissionDeniedException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ConfigurePermissionDeniedException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ConfigurePermissionDeniedException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="ConfigurePermissionDeniedException.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ConfigurePermissionDeniedException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="ConfigurePermissionDeniedException.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,349 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
IConfigurePermissionBits (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.security.IConfigurePermissionBits interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IConfigurePermissionBits (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IConfigurePermissionBits.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="ConfigurePermissionDeniedException.html" title="class in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FIConfigurePermissionBits.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IConfigurePermissionBits.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IConfigurePermissionBits.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IConfigurePermissionBits.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.security</FONT>
<BR>
Interface IConfigurePermissionBits</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IConfigurePermissionBits</B></DL>
</PRE>
<P>
This interface describes the bits used to define management "configure" permissions.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html#setPermissions(int)"><CODE>IManagementPermission.setPermissions(int)</CODE></A>,
<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigureScopeBits</CODE></A>,
<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IConfigurePermissionBits.html#ALLOW_DELETE">ALLOW_DELETE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to allow delete of a folder, configuration or file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IConfigurePermissionBits.html#ALLOW_READ">ALLOW_READ</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to allow reading of a configuration or file or listing of a folder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IConfigurePermissionBits.html#ALLOW_SET_PERMISSIONS">ALLOW_SET_PERMISSIONS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to allow setting management permissions on a configuration entity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IConfigurePermissionBits.html#ALLOW_WRITE">ALLOW_WRITE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to allow updating of a configuration or file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IConfigurePermissionBits.html#DENY_DELETE">DENY_DELETE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to deny delete of a folder, configuration or file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IConfigurePermissionBits.html#DENY_READ">DENY_READ</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to deny reading of a configuration or listing of a folder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IConfigurePermissionBits.html#DENY_SET_PERMISSIONS">DENY_SET_PERMISSIONS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to deny setting management permissions on a configuration entity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IConfigurePermissionBits.html#DENY_WRITE">DENY_WRITE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to deny updating of a configuration or file.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ALLOW_DELETE"><!-- --></A><H3>
ALLOW_DELETE</H3>
<PRE>
static final int <B>ALLOW_DELETE</B></PRE>
<DL>
<DD>Permission bit to allow delete of a folder, configuration or file.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IConfigurePermissionBits.ALLOW_DELETE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALLOW_READ"><!-- --></A><H3>
ALLOW_READ</H3>
<PRE>
static final int <B>ALLOW_READ</B></PRE>
<DL>
<DD>Permission bit to allow reading of a configuration or file or listing of a folder.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IConfigurePermissionBits.ALLOW_READ">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALLOW_SET_PERMISSIONS"><!-- --></A><H3>
ALLOW_SET_PERMISSIONS</H3>
<PRE>
static final int <B>ALLOW_SET_PERMISSIONS</B></PRE>
<DL>
<DD>Permission bit to allow setting management permissions on a configuration entity.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IConfigurePermissionBits.ALLOW_SET_PERMISSIONS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALLOW_WRITE"><!-- --></A><H3>
ALLOW_WRITE</H3>
<PRE>
static final int <B>ALLOW_WRITE</B></PRE>
<DL>
<DD>Permission bit to allow updating of a configuration or file.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IConfigurePermissionBits.ALLOW_WRITE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DENY_DELETE"><!-- --></A><H3>
DENY_DELETE</H3>
<PRE>
static final int <B>DENY_DELETE</B></PRE>
<DL>
<DD>Permission bit to deny delete of a folder, configuration or file.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IConfigurePermissionBits.DENY_DELETE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DENY_READ"><!-- --></A><H3>
DENY_READ</H3>
<PRE>
static final int <B>DENY_READ</B></PRE>
<DL>
<DD>Permission bit to deny reading of a configuration or listing of a folder.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IConfigurePermissionBits.DENY_READ">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DENY_SET_PERMISSIONS"><!-- --></A><H3>
DENY_SET_PERMISSIONS</H3>
<PRE>
static final int <B>DENY_SET_PERMISSIONS</B></PRE>
<DL>
<DD>Permission bit to deny setting management permissions on a configuration entity.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IConfigurePermissionBits.DENY_SET_PERMISSIONS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DENY_WRITE"><!-- --></A><H3>
DENY_WRITE</H3>
<PRE>
static final int <B>DENY_WRITE</B></PRE>
<DL>
<DD>Permission bit to deny updating of a configuration or file.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IConfigurePermissionBits.DENY_WRITE">Constant Field Values</A></DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IConfigurePermissionBits.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="ConfigurePermissionDeniedException.html" title="class in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FIConfigurePermissionBits.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IConfigurePermissionBits.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IConfigurePermissionBits.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IConfigurePermissionBits.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,269 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
IConfigureScopeBits (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.security.IConfigureScopeBits interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IConfigureScopeBits (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IConfigureScopeBits.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FIConfigureScopeBits.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IConfigureScopeBits.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IConfigureScopeBits.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IConfigureScopeBits.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.security</FONT>
<BR>
Interface IConfigureScopeBits</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IConfigureScopeBits</B></DL>
</PRE>
<P>
This interface describes the bits used to define management "configure" scopes.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html#setScope(int)"><CODE>IManagementPermission.setScope(int)</CODE></A>,
<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigurePermissionBits</CODE></A>,
<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManageScopeBits</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IConfigureScopeBits.html#ALL_CONFIGURATIONS_AND_FILES_SCOPE">ALL_CONFIGURATIONS_AND_FILES_SCOPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Scope bit to include all configurations or files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IConfigureScopeBits.html#ALL_FOLDERS_SCOPE">ALL_FOLDERS_SCOPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Scope bit to recursively include all subfolders.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IConfigureScopeBits.html#THIS_CONFIGURATION_OR_FILE_SCOPE">THIS_CONFIGURATION_OR_FILE_SCOPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Scope bit to include this configuration or file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IConfigureScopeBits.html#THIS_FOLDER_SCOPE">THIS_FOLDER_SCOPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Scope bit to include this folder.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ALL_CONFIGURATIONS_AND_FILES_SCOPE"><!-- --></A><H3>
ALL_CONFIGURATIONS_AND_FILES_SCOPE</H3>
<PRE>
static final int <B>ALL_CONFIGURATIONS_AND_FILES_SCOPE</B></PRE>
<DL>
<DD>Scope bit to include all configurations or files.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IConfigureScopeBits.ALL_CONFIGURATIONS_AND_FILES_SCOPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALL_FOLDERS_SCOPE"><!-- --></A><H3>
ALL_FOLDERS_SCOPE</H3>
<PRE>
static final int <B>ALL_FOLDERS_SCOPE</B></PRE>
<DL>
<DD>Scope bit to recursively include all subfolders.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IConfigureScopeBits.ALL_FOLDERS_SCOPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="THIS_CONFIGURATION_OR_FILE_SCOPE"><!-- --></A><H3>
THIS_CONFIGURATION_OR_FILE_SCOPE</H3>
<PRE>
static final int <B>THIS_CONFIGURATION_OR_FILE_SCOPE</B></PRE>
<DL>
<DD>Scope bit to include this configuration or file.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IConfigureScopeBits.THIS_CONFIGURATION_OR_FILE_SCOPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="THIS_FOLDER_SCOPE"><!-- --></A><H3>
THIS_FOLDER_SCOPE</H3>
<PRE>
static final int <B>THIS_FOLDER_SCOPE</B></PRE>
<DL>
<DD>Scope bit to include this folder.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IConfigureScopeBits.THIS_FOLDER_SCOPE">Constant Field Values</A></DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IConfigureScopeBits.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FIConfigureScopeBits.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IConfigureScopeBits.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IConfigureScopeBits.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IConfigureScopeBits.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,433 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
IManagePermissionBits (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.security.IManagePermissionBits interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IManagePermissionBits (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IManagePermissionBits.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IManagementSecurityConfigurator.html" title="interface in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FIManagePermissionBits.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IManagePermissionBits.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IManagePermissionBits.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IManagePermissionBits.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.security</FONT>
<BR>
Interface IManagePermissionBits</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IManagePermissionBits</B></DL>
</PRE>
<P>
This interface describes the bits used to define management "manage" permissions.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html#setPermissions(int)"><CODE>IManagementPermission.setPermissions(int)</CODE></A>,
<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManageScopeBits</CODE></A>,
<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigurePermissionBits</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagePermissionBits.html#ALLOW_ENABLE_DISABLE_METRICS">ALLOW_ENABLE_DISABLE_METRICS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to allow operations associated with metrics exposed by containers/components.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagePermissionBits.html#ALLOW_GET_INFORMATION">ALLOW_GET_INFORMATION</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to allow other JMX operations with an "impact" of <a href="../../../../..</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagePermissionBits.html#ALLOW_LIFE_CYCLE_CONTROL">ALLOW_LIFE_CYCLE_CONTROL</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to allow life cycle type operations to be executed (e.g. stop, start, shutdown, etc.).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagePermissionBits.html#ALLOW_NOTIFICATION_SUBSCRIPTION">ALLOW_NOTIFICATION_SUBSCRIPTION</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to allow JMX notification listeners to be added to a container/component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagePermissionBits.html#ALLOW_PERFORM_ACTIONS">ALLOW_PERFORM_ACTIONS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to allow other JMX operations with an "impact" of <a href="../../../../..</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagePermissionBits.html#ALLOW_SET_ATTRIBUTES">ALLOW_SET_ATTRIBUTES</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to allow runtime attributes to be set on a container/component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagePermissionBits.html#DENY_ENABLE_DISABLE_METRICS">DENY_ENABLE_DISABLE_METRICS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to deny operations associated with metrics exposed by containers/components.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagePermissionBits.html#DENY_GET_INFORMATION">DENY_GET_INFORMATION</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to deny other JMX operations with an "impact" of <a href="../../../../..</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagePermissionBits.html#DENY_LIFE_CYCLE_CONTROL">DENY_LIFE_CYCLE_CONTROL</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to deny life cycle type operations from being executed (e.g. stop, start, shutdown, etc.).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagePermissionBits.html#DENY_NOTIFICATION_SUBSCRIPTION">DENY_NOTIFICATION_SUBSCRIPTION</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to deny JMX notification listeners from being added to a container/component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagePermissionBits.html#DENY_PERFORM_ACTIONS">DENY_PERFORM_ACTIONS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to deny other JMX operations with an "impact" of <a href="../../../../..</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagePermissionBits.html#DENY_SET_ATTRIBUTES">DENY_SET_ATTRIBUTES</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Permission bit to deny runtime attributes from being set on a container/component.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ALLOW_ENABLE_DISABLE_METRICS"><!-- --></A><H3>
ALLOW_ENABLE_DISABLE_METRICS</H3>
<PRE>
static final int <B>ALLOW_ENABLE_DISABLE_METRICS</B></PRE>
<DL>
<DD>Permission bit to allow operations associated with metrics exposed by containers/components.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagePermissionBits.ALLOW_ENABLE_DISABLE_METRICS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALLOW_GET_INFORMATION"><!-- --></A><H3>
ALLOW_GET_INFORMATION</H3>
<PRE>
static final int <B>ALLOW_GET_INFORMATION</B></PRE>
<DL>
<DD>Permission bit to allow other JMX operations with an "impact" of <a href="../../../../../javax/management/MBeanOperationInfo.html#INFO">INFO</a> or
<a href="../../../../../javax/management/MBeanOperationInfo.html#UNKNOWN">UNKNOWN</a> to be executed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagePermissionBits.ALLOW_GET_INFORMATION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALLOW_LIFE_CYCLE_CONTROL"><!-- --></A><H3>
ALLOW_LIFE_CYCLE_CONTROL</H3>
<PRE>
static final int <B>ALLOW_LIFE_CYCLE_CONTROL</B></PRE>
<DL>
<DD>Permission bit to allow life cycle type operations to be executed (e.g. stop, start, shutdown, etc.).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagePermissionBits.ALLOW_LIFE_CYCLE_CONTROL">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALLOW_NOTIFICATION_SUBSCRIPTION"><!-- --></A><H3>
ALLOW_NOTIFICATION_SUBSCRIPTION</H3>
<PRE>
static final int <B>ALLOW_NOTIFICATION_SUBSCRIPTION</B></PRE>
<DL>
<DD>Permission bit to allow JMX notification listeners to be added to a container/component.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagePermissionBits.ALLOW_NOTIFICATION_SUBSCRIPTION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALLOW_PERFORM_ACTIONS"><!-- --></A><H3>
ALLOW_PERFORM_ACTIONS</H3>
<PRE>
static final int <B>ALLOW_PERFORM_ACTIONS</B></PRE>
<DL>
<DD>Permission bit to allow other JMX operations with an "impact" of <a href="../../../../../javax/management/MBeanOperationInfo.html#ACTION">ACTION</a> or
<a href="../../../../../javax/management/MBeanOperationInfo.html#ACTION_INFO">ACTION_INFO</a> to be executed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagePermissionBits.ALLOW_PERFORM_ACTIONS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALLOW_SET_ATTRIBUTES"><!-- --></A><H3>
ALLOW_SET_ATTRIBUTES</H3>
<PRE>
static final int <B>ALLOW_SET_ATTRIBUTES</B></PRE>
<DL>
<DD>Permission bit to allow runtime attributes to be set on a container/component.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagePermissionBits.ALLOW_SET_ATTRIBUTES">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DENY_ENABLE_DISABLE_METRICS"><!-- --></A><H3>
DENY_ENABLE_DISABLE_METRICS</H3>
<PRE>
static final int <B>DENY_ENABLE_DISABLE_METRICS</B></PRE>
<DL>
<DD>Permission bit to deny operations associated with metrics exposed by containers/components.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagePermissionBits.DENY_ENABLE_DISABLE_METRICS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DENY_GET_INFORMATION"><!-- --></A><H3>
DENY_GET_INFORMATION</H3>
<PRE>
static final int <B>DENY_GET_INFORMATION</B></PRE>
<DL>
<DD>Permission bit to deny other JMX operations with an "impact" of <a href="../../../../../javax/management/MBeanOperationInfo.html#INFO">INFO</a> or
<a href="../../../../../javax/management/MBeanOperationInfo.html#UNKNOWN">UNKNOWN</a> from being executed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagePermissionBits.DENY_GET_INFORMATION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DENY_LIFE_CYCLE_CONTROL"><!-- --></A><H3>
DENY_LIFE_CYCLE_CONTROL</H3>
<PRE>
static final int <B>DENY_LIFE_CYCLE_CONTROL</B></PRE>
<DL>
<DD>Permission bit to deny life cycle type operations from being executed (e.g. stop, start, shutdown, etc.).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagePermissionBits.DENY_LIFE_CYCLE_CONTROL">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DENY_NOTIFICATION_SUBSCRIPTION"><!-- --></A><H3>
DENY_NOTIFICATION_SUBSCRIPTION</H3>
<PRE>
static final int <B>DENY_NOTIFICATION_SUBSCRIPTION</B></PRE>
<DL>
<DD>Permission bit to deny JMX notification listeners from being added to a container/component.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagePermissionBits.DENY_NOTIFICATION_SUBSCRIPTION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DENY_PERFORM_ACTIONS"><!-- --></A><H3>
DENY_PERFORM_ACTIONS</H3>
<PRE>
static final int <B>DENY_PERFORM_ACTIONS</B></PRE>
<DL>
<DD>Permission bit to deny other JMX operations with an "impact" of <a href="../../../../../javax/management/MBeanOperationInfo.html#ACTION">ACTION</a> or
<a href="../../../../../javax/management/MBeanOperationInfo.html#ACTION_INFO">ACTION_INFO</a> from being executed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagePermissionBits.DENY_PERFORM_ACTIONS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DENY_SET_ATTRIBUTES"><!-- --></A><H3>
DENY_SET_ATTRIBUTES</H3>
<PRE>
static final int <B>DENY_SET_ATTRIBUTES</B></PRE>
<DL>
<DD>Permission bit to deny runtime attributes from being set on a container/component.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagePermissionBits.DENY_SET_ATTRIBUTES">Constant Field Values</A></DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IManagePermissionBits.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IManagementSecurityConfigurator.html" title="interface in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FIManagePermissionBits.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IManagePermissionBits.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IManagePermissionBits.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IManagePermissionBits.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,289 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
IManageScopeBits (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.security.IManageScopeBits interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IManageScopeBits (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IManageScopeBits.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="InvalidManagementPermissionException.html" title="class in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FIManageScopeBits.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IManageScopeBits.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IManageScopeBits.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IManageScopeBits.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.security</FONT>
<BR>
Interface IManageScopeBits</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IManageScopeBits</B></DL>
</PRE>
<P>
This interface describes the bits used to define management "manage" scopes.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html#setScope(int)"><CODE>IManagementPermission.setScope(int)</CODE></A>,
<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A>,
<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigureScopeBits</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManageScopeBits.html#ALL_COMPONENTS_SCOPE">ALL_COMPONENTS_SCOPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Scope bit to include all components.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManageScopeBits.html#ALL_CONTAINERS_SCOPE">ALL_CONTAINERS_SCOPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Scope bit to include all containers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManageScopeBits.html#ALL_FOLDERS_SCOPE">ALL_FOLDERS_SCOPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Scope bit to recursively include all subfolders.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManageScopeBits.html#THIS_COMPONENT_SCOPE">THIS_COMPONENT_SCOPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Scope bit to include this component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManageScopeBits.html#THIS_CONTAINER_SCOPE">THIS_CONTAINER_SCOPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Scope bit to include this container.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ALL_COMPONENTS_SCOPE"><!-- --></A><H3>
ALL_COMPONENTS_SCOPE</H3>
<PRE>
static final int <B>ALL_COMPONENTS_SCOPE</B></PRE>
<DL>
<DD>Scope bit to include all components.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManageScopeBits.ALL_COMPONENTS_SCOPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALL_CONTAINERS_SCOPE"><!-- --></A><H3>
ALL_CONTAINERS_SCOPE</H3>
<PRE>
static final int <B>ALL_CONTAINERS_SCOPE</B></PRE>
<DL>
<DD>Scope bit to include all containers.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManageScopeBits.ALL_CONTAINERS_SCOPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALL_FOLDERS_SCOPE"><!-- --></A><H3>
ALL_FOLDERS_SCOPE</H3>
<PRE>
static final int <B>ALL_FOLDERS_SCOPE</B></PRE>
<DL>
<DD>Scope bit to recursively include all subfolders.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManageScopeBits.ALL_FOLDERS_SCOPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="THIS_COMPONENT_SCOPE"><!-- --></A><H3>
THIS_COMPONENT_SCOPE</H3>
<PRE>
static final int <B>THIS_COMPONENT_SCOPE</B></PRE>
<DL>
<DD>Scope bit to include this component.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManageScopeBits.THIS_COMPONENT_SCOPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="THIS_CONTAINER_SCOPE"><!-- --></A><H3>
THIS_CONTAINER_SCOPE</H3>
<PRE>
static final int <B>THIS_CONTAINER_SCOPE</B></PRE>
<DL>
<DD>Scope bit to include this container.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManageScopeBits.THIS_CONTAINER_SCOPE">Constant Field Values</A></DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IManageScopeBits.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="InvalidManagementPermissionException.html" title="class in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FIManageScopeBits.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IManageScopeBits.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IManageScopeBits.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IManageScopeBits.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,469 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
IManagementPermission (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.security.IManagementPermission interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IManagementPermission (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IManagementPermission.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IManagementSecurityConfigurator.html" title="interface in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FIManagementPermission.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IManagementPermission.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IManagementPermission.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IManagementPermission.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IManagementPermission.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IManagementPermission.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.security</FONT>
<BR>
Interface IManagementPermission</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IManagementPermission</B></DL>
</PRE>
<P>
This interface defines the API of a management permission object.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="ManagementPermissionFactory.html" title="class in com.sonicsw.mf.common.security"><CODE>ManagementPermissionFactory</CODE></A>,
<A HREF="IManagementSecurityConfigurator.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagementSecurityConfigurator</CODE></A>,
<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigurePermissionBits</CODE></A>,
<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A>,
<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigureScopeBits</CODE></A>,
<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManageScopeBits</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementPermission.html#CONFIGURE_TYPE">CONFIGURE_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant for the "configure" management permission type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementPermission.html#GROUP_PRINCIPAL_TYPE">GROUP_PRINCIPAL_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant for a group principal type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementPermission.html#MANAGE_TYPE">MANAGE_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant for the "manage" management permission type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementPermission.html#SUPER_USER_NAME">SUPER_USER_NAME</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant for the IManagementPermission.SUPER_USER_NAME super-user identity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementPermission.html#UNKNOWN_PRINCIPAL_TYPE">UNKNOWN_PRINCIPAL_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant for an unknown principal type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementPermission.html#USER_PRINCIPAL_TYPE">USER_PRINCIPAL_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant for a user principal type.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementPermission.html#getPermissions()">getPermissions</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the permissions to be applied.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementPermission.html#getPrincipal()">getPrincipal</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the principal to which the management permission applies.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementPermission.html#getPrincipalType()">getPrincipalType</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the principal type to which the management permission applies.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementPermission.html#getScope()">getScope</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the scope to which the management permission applies.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementPermission.html#setPermissions(int)">setPermissions</A></B>(int&nbsp;permissions)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the permissions to be applied.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementPermission.html#setScope(int)">setScope</A></B>(int&nbsp;scope)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the scope to which the management permission applies.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="CONFIGURE_TYPE"><!-- --></A><H3>
CONFIGURE_TYPE</H3>
<PRE>
static final java.lang.String <B>CONFIGURE_TYPE</B></PRE>
<DL>
<DD>Constant for the "configure" management permission type.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagementPermission.CONFIGURE_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="GROUP_PRINCIPAL_TYPE"><!-- --></A><H3>
GROUP_PRINCIPAL_TYPE</H3>
<PRE>
static final short <B>GROUP_PRINCIPAL_TYPE</B></PRE>
<DL>
<DD>Constant for a group principal type.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagementPermission.GROUP_PRINCIPAL_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MANAGE_TYPE"><!-- --></A><H3>
MANAGE_TYPE</H3>
<PRE>
static final java.lang.String <B>MANAGE_TYPE</B></PRE>
<DL>
<DD>Constant for the "manage" management permission type.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagementPermission.MANAGE_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SUPER_USER_NAME"><!-- --></A><H3>
SUPER_USER_NAME</H3>
<PRE>
static final java.lang.String <B>SUPER_USER_NAME</B></PRE>
<DL>
<DD>Constant for the IManagementPermission.SUPER_USER_NAME super-user identity.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagementPermission.SUPER_USER_NAME">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="UNKNOWN_PRINCIPAL_TYPE"><!-- --></A><H3>
UNKNOWN_PRINCIPAL_TYPE</H3>
<PRE>
static final short <B>UNKNOWN_PRINCIPAL_TYPE</B></PRE>
<DL>
<DD>Constant for an unknown principal type.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagementPermission.UNKNOWN_PRINCIPAL_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="USER_PRINCIPAL_TYPE"><!-- --></A><H3>
USER_PRINCIPAL_TYPE</H3>
<PRE>
static final short <B>USER_PRINCIPAL_TYPE</B></PRE>
<DL>
<DD>Constant for a user principal type.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.sonicsw.mf.common.security.IManagementPermission.USER_PRINCIPAL_TYPE">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getPermissions()"><!-- --></A><H3>
getPermissions</H3>
<PRE>
int <B>getPermissions</B>()</PRE>
<DL>
<DD>Gets the permissions to be applied.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html#setPermissions(int)"><CODE>setPermissions(int)</CODE></A>,
<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigurePermissionBits</CODE></A>,
<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getPrincipal()"><!-- --></A><H3>
getPrincipal</H3>
<PRE>
java.lang.String <B>getPrincipal</B>()</PRE>
<DL>
<DD>Gets the principal to which the management permission applies.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The principal name.<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html#getPrincipalType()"><CODE>getPrincipalType()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getPrincipalType()"><!-- --></A><H3>
getPrincipalType</H3>
<PRE>
short <B>getPrincipalType</B>()</PRE>
<DL>
<DD>Gets the principal type to which the management permission applies.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The principal type.<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html#getPrincipal()"><CODE>getPrincipal()</CODE></A>,
<A HREF="IManagementPermission.html#USER_PRINCIPAL_TYPE"><CODE>USER_PRINCIPAL_TYPE</CODE></A>,
<A HREF="IManagementPermission.html#GROUP_PRINCIPAL_TYPE"><CODE>GROUP_PRINCIPAL_TYPE</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getScope()"><!-- --></A><H3>
getScope</H3>
<PRE>
int <B>getScope</B>()</PRE>
<DL>
<DD>Gets the scope to which the management permission applies.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html#setScope(int)"><CODE>setScope(int)</CODE></A>,
<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigureScopeBits</CODE></A>,
<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManageScopeBits</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setPermissions(int)"><!-- --></A><H3>
setPermissions</H3>
<PRE>
void <B>setPermissions</B>(int&nbsp;permissions)</PRE>
<DL>
<DD>Sets the permissions to be applied.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>permissions</CODE> - The sum of the permission bits to be applied.<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html#getPermissions()"><CODE>getPermissions()</CODE></A>,
<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigurePermissionBits</CODE></A>,
<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setScope(int)"><!-- --></A><H3>
setScope</H3>
<PRE>
void <B>setScope</B>(int&nbsp;scope)</PRE>
<DL>
<DD>Sets the scope to which the management permission applies.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>scope</CODE> - The sum of the scope bits to which the management permission applies.<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html#getScope()"><CODE>getScope()</CODE></A>,
<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigureScopeBits</CODE></A>,
<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManageScopeBits</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IManagementPermission.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IManagementSecurityConfigurator.html" title="interface in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FIManagementPermission.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IManagementPermission.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="IManagementPermission.html#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IManagementPermission.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="IManagementPermission.html#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IManagementPermission.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,449 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
IManagementSecurityConfigurator (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.security.IManagementSecurityConfigurator interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IManagementSecurityConfigurator (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="IManagementSecurityConfigurator.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FIManagementSecurityConfigurator.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IManagementSecurityConfigurator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IManagementSecurityConfigurator.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IManagementSecurityConfigurator.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.security</FONT>
<BR>
Interface IManagementSecurityConfigurator</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IManagementSecurityConfigurator</B></DL>
</PRE>
<P>
This interface is used by administration clients to enable and configure the management security features:
<ul>
<li>Configuration and runtime checking of management permissions
<li>Auditing of configuration and/or runtime events.
</ul>
Creation and use of an instance of this interface is best demonstrated by the sample located at:
&lt;installdir&gt;/MQ&lt;version&gt;/samples/Management/mgmtSecurityAPI/java
<p>
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.IDirElement.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.IDirElement</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementSecurityConfigurator.html#getDomainElement(boolean)">getDomainElement</A></B>(boolean&nbsp;forUpdate)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the element that contains the domain-wide settings.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security">IManagementPermission</A>[][]</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementSecurityConfigurator.html#getManagementPermissions(java.lang.String[], java.lang.String)">getManagementPermissions</A></B>(java.lang.String[]&nbsp;paths,
java.lang.String&nbsp;type)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the management permissions for the given paths of the particular type ("configure" or "manage").</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementSecurityConfigurator.html#removeAllManagementPermissions()">removeAllManagementPermissions</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove all management permissions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementSecurityConfigurator.html#removeManagementPermissions(java.lang.String[], java.lang.String)">removeManagementPermissions</A></B>(java.lang.String[]&nbsp;paths,
java.lang.String&nbsp;type)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove all manage or configure permissions for each path in paths.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementSecurityConfigurator.html#removeManagementPermissions(java.lang.String[], java.lang.String, java.lang.String[][])">removeManagementPermissions</A></B>(java.lang.String[]&nbsp;paths,
java.lang.String&nbsp;type,
java.lang.String[][]&nbsp;principals)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove the manage or configure permissions in the corresponding principals array for each path in paths.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementSecurityConfigurator.html#setDefaultManagementPermissions()">setDefaultManagementPermissions</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the global default manage and configure permissions for the Administrators group.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementSecurityConfigurator.html#setDomainElement(com.sonicsw.mf.common.dirconfig.IDeltaDirElement)">setDomainElement</A></B>(<A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.IDeltaDirElement.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.IDeltaDirElement</A>&nbsp;element)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Applies a modification to the domain-wide settings element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="IManagementSecurityConfigurator.html#setManagementPermissions(java.lang.String[], java.lang.String, com.sonicsw.mf.common.security.IManagementPermission[][])">setManagementPermissions</A></B>(java.lang.String[]&nbsp;paths,
java.lang.String&nbsp;type,
<A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security">IManagementPermission</A>[][]&nbsp;permissions)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set management permissions.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getDomainElement(boolean)"><!-- --></A><H3>
getDomainElement</H3>
<PRE>
<A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.IDirElement.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.IDirElement</A> <B>getDomainElement</B>(boolean&nbsp;forUpdate)
throws <A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></PRE>
<DL>
<DD>Gets the element that contains the domain-wide settings.
<p>
Although the configuration element containing domain-wide management security
settings is available through this API, it is recommened that users configure
the domain-wide settings through the Sonic Management Console or strictly follow
the sample located at: &lt;installdir&gt;/MQ&lt;version&gt;/samples/Management/mgmtSecurityAPI/java
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The domain wide element.
<DT><B>Throws:</B>
<DD><CODE><A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></CODE> - Thrown if there is a problem accessing the underlying storage.</DL>
</DD>
</DL>
<HR>
<A NAME="getManagementPermissions(java.lang.String[], java.lang.String)"><!-- --></A><H3>
getManagementPermissions</H3>
<PRE>
<A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security">IManagementPermission</A>[][] <B>getManagementPermissions</B>(java.lang.String[]&nbsp;paths,
java.lang.String&nbsp;type)
throws <A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></PRE>
<DL>
<DD>Return the management permissions for the given paths of the particular type ("configure" or "manage").
<p>
Will throw a runtime ConfigurePermissionDeniedException
if the calling user does not have IConfigurePermissionBit.ALLOW_READ permission on any of the paths.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>paths</CODE> - The logical names of folders or configurations (for "configure" permissions) or folders, containers or
components for "manage" permissions.<DD><CODE>type</CODE> - "manage" or "configure", for manage or configure permissions.
<DT><B>Returns:</B><DD>An array of defined permissions for each path in paths.
<DT><B>Throws:</B>
<DD><CODE><A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></CODE> - Thrown if a path is invalid, or there's a problem getting the permissions information.<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagementPermission</CODE></A>,
<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigureScopeBits</CODE></A>,
<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigurePermissionBits</CODE></A>,
<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManageScopeBits</CODE></A>,
<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="removeAllManagementPermissions()"><!-- --></A><H3>
removeAllManagementPermissions</H3>
<PRE>
void <B>removeAllManagementPermissions</B>()
throws <A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></PRE>
<DL>
<DD>Remove all management permissions.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></CODE> - Thrown if there's a problem updating the permissions information.</DL>
</DD>
</DL>
<HR>
<A NAME="removeManagementPermissions(java.lang.String[], java.lang.String)"><!-- --></A><H3>
removeManagementPermissions</H3>
<PRE>
void <B>removeManagementPermissions</B>(java.lang.String[]&nbsp;paths,
java.lang.String&nbsp;type)
throws <A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></PRE>
<DL>
<DD>Remove all manage or configure permissions for each path in paths.
<p>
Will throw a ConfigurePermissionDeniedException if the caller does not have IConfigurePermissionBits.ALLOW_SET_PERMISSIONS
permission on any of the paths.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>paths</CODE> - The logical names of folders or configurations (for "configure" permissions) or folders, containers or components for "manage" permissions.<DD><CODE>type</CODE> - "manage" or "configure", for manage or configure permissions.
<DT><B>Throws:</B>
<DD><CODE><A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></CODE> - Thrown if a path is invalid, or there's a problem getting the permissions information.<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagementPermission</CODE></A>,
<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigureScopeBits</CODE></A>,
<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigurePermissionBits</CODE></A>,
<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManageScopeBits</CODE></A>,
<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="removeManagementPermissions(java.lang.String[], java.lang.String, java.lang.String[][])"><!-- --></A><H3>
removeManagementPermissions</H3>
<PRE>
void <B>removeManagementPermissions</B>(java.lang.String[]&nbsp;paths,
java.lang.String&nbsp;type,
java.lang.String[][]&nbsp;principals)
throws <A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A>,
<A HREF="InvalidManagementPermissionException.html" title="class in com.sonicsw.mf.common.security">InvalidManagementPermissionException</A></PRE>
<DL>
<DD>Remove the manage or configure permissions in the corresponding principals array for each path in paths.
<p>
Will throw a runtime ConfigurePermissionDeniedException if the caller does not have IConfigurePermissionBits.ALLOW_SET_PERMISSIONS
permission on any of the paths.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>paths</CODE> - The logical names of folders or configurations (for "configure" permissions) or folders, containers or components for "manage" permissions.<DD><CODE>type</CODE> - "manage" or "configure", for manage or configure permissions.<DD><CODE>principals</CODE> - An array of array of principals for each path in paths. This method removes the permissions set for each principal.
<DT><B>Throws:</B>
<DD><CODE><A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></CODE> - Thrown if a path is invalid, or there's a problem getting the permissions information.
<DD><CODE><A HREF="InvalidManagementPermissionException.html" title="class in com.sonicsw.mf.common.security">InvalidManagementPermissionException</A></CODE> - Thrown if a given principal does not have a permission on the associated path.<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagementPermission</CODE></A>,
<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigureScopeBits</CODE></A>,
<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigurePermissionBits</CODE></A>,
<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManageScopeBits</CODE></A>,
<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setDefaultManagementPermissions()"><!-- --></A><H3>
setDefaultManagementPermissions</H3>
<PRE>
void <B>setDefaultManagementPermissions</B>()
throws <A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></PRE>
<DL>
<DD>Set the global default manage and configure permissions for the Administrators group.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></CODE> - Thrown if there's a problem updating the permissions information.</DL>
</DD>
</DL>
<HR>
<A NAME="setDomainElement(com.sonicsw.mf.common.dirconfig.IDeltaDirElement)"><!-- --></A><H3>
setDomainElement</H3>
<PRE>
void <B>setDomainElement</B>(<A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.IDeltaDirElement.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.IDeltaDirElement</A>&nbsp;element)
throws <A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></PRE>
<DL>
<DD>Applies a modification to the domain-wide settings element.
<p>
Although the configuration element containing domain-wide management security
settings is available through this API, it is recommened that users configure
the domain-wide settings through the Sonic Management Console or strictly follow
the sample located at: &lt;installdir&gt;/MQ&lt;version&gt;/samples/Management/mgmtSecurityAPI/java
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - The delta element to be applied to the DS.
<DT><B>Throws:</B>
<DD><CODE><A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></CODE> - Thrown if there is a problem accessing the underlying storage
or the folder does not exist.</DL>
</DD>
</DL>
<HR>
<A NAME="setManagementPermissions(java.lang.String[], java.lang.String, com.sonicsw.mf.common.security.IManagementPermission[][])"><!-- --></A><H3>
setManagementPermissions</H3>
<PRE>
void <B>setManagementPermissions</B>(java.lang.String[]&nbsp;paths,
java.lang.String&nbsp;type,
<A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security">IManagementPermission</A>[][]&nbsp;permissions)
throws <A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A>,
<A HREF="InvalidManagementPermissionException.html" title="class in com.sonicsw.mf.common.security">InvalidManagementPermissionException</A></PRE>
<DL>
<DD>Set management permissions.
<p>
For "manage" permissions, the path of components in containers is
specified as /&lt;folder1&gt;/.../&lt;foldern&gt;/&lt;ContainerName&gt;:ID=&lt;ComponentName&gt;
<p>
Will throw a runtime ConfigurePermissionDeniedException if the caller does not have
IConfigurePermissionBits.ALLOW_SET_PERMISSIONS permission on any of the paths.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>paths</CODE> - The logical names of folders or configurations (for "configure" permissions) or folders, containers or
components for "manage" permissions.<DD><CODE>type</CODE> - "manage" or "configure", for manage or configure permissions.<DD><CODE>permissions</CODE> - An array of permissions for each one of the paths.
<DT><B>Throws:</B>
<DD><CODE><A HREF="https://documentation.progress.com/output/Sonic/8.5.0/Docs8.5/api/mgmt_api/com/sonicsw/mf/common/dirconfig.DirectoryServiceException.html" title="class or interface in com.sonicsw.mf.common">com.sonicsw.mf.common.dirconfig.DirectoryServiceException</A></CODE> - Thrown if a path is invalid, or there's a problem getting or modifying the permissions information.
<DD><CODE>InvalidPermissionException</CODE> - Thrown if a scope specification is incorrect for the path, or a principal
does not exist in the global authentication domain.
<DD><CODE><A HREF="InvalidManagementPermissionException.html" title="class in com.sonicsw.mf.common.security">InvalidManagementPermissionException</A></CODE><DT><B>See Also:</B><DD><A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagementPermission</CODE></A>,
<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigureScopeBits</CODE></A>,
<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigurePermissionBits</CODE></A>,
<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManageScopeBits</CODE></A>,
<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="IManagementSecurityConfigurator.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FIManagementSecurityConfigurator.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IManagementSecurityConfigurator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IManagementSecurityConfigurator.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="IManagementSecurityConfigurator.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,259 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
InvalidManagementPermissionException (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.security.InvalidManagementPermissionException class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="InvalidManagementPermissionException (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="InvalidManagementPermissionException.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="ManagementPermissionDeniedException.html" title="class in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FInvalidManagementPermissionException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="InvalidManagementPermissionException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="InvalidManagementPermissionException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="InvalidManagementPermissionException.html#methods_inherited_from_class_com.sonicsw.mf.common.MFException">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="InvalidManagementPermissionException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.security</FONT>
<BR>
Class InvalidManagementPermissionException</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../MFException.html" title="class in com.sonicsw.mf.common">com.sonicsw.mf.common.MFException</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.mf.common.security.InvalidManagementPermissionException</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>InvalidManagementPermissionException</B><DT>extends <A HREF="../MFException.html" title="class in com.sonicsw.mf.common">MFException</A></DL>
</PRE>
<P>
Checked management exception.
<p>
Indicates that a given IManagementPermission was invalid the reason for which is contained in the
exception message.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IManagementSecurityConfigurator.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagementSecurityConfigurator</CODE></A>,
<A HREF="../../../../../serialized-form.html#com.sonicsw.mf.common.security.InvalidManagementPermissionException">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="InvalidManagementPermissionException.html#InvalidManagementPermissionException(java.lang.String)">InvalidManagementPermissionException</A></B>(java.lang.String&nbsp;message)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new exception with the specified detail message.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.MFException"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.sonicsw.mf.common.<A HREF="../MFException.html" title="class in com.sonicsw.mf.common">MFException</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../MFException.html#getMessage()">getMessage</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="InvalidManagementPermissionException(java.lang.String)"><!-- --></A><H3>
InvalidManagementPermissionException</H3>
<PRE>
public <B>InvalidManagementPermissionException</B>(java.lang.String&nbsp;message)</PRE>
<DL>
<DD>Constructs a new exception with the specified detail message. The
cause is not initialized, and may subsequently be initialized by
a call to <A HREF="../MFException.html#setLinkedException(java.lang.Exception)"><CODE>MFException.setLinkedException(java.lang.Exception)</CODE></A>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - The textural details of why the management permission was invalid.</DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="InvalidManagementPermissionException.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="ManagementPermissionDeniedException.html" title="class in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FInvalidManagementPermissionException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="InvalidManagementPermissionException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="InvalidManagementPermissionException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="InvalidManagementPermissionException.html#methods_inherited_from_class_com.sonicsw.mf.common.MFException">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="InvalidManagementPermissionException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,315 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
ManagePermissionDeniedException (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.security.ManagePermissionDeniedException class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="ManagePermissionDeniedException (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="ManagePermissionDeniedException.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="ManagementPermissionsCheckingNotEnabledException.html" title="class in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FManagePermissionDeniedException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ManagePermissionDeniedException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ManagePermissionDeniedException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="ManagePermissionDeniedException.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ManagePermissionDeniedException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="ManagePermissionDeniedException.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.security</FONT>
<BR>
Class ManagePermissionDeniedException</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.RuntimeException
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../MFRuntimeException.html" title="class in com.sonicsw.mf.common">com.sonicsw.mf.common.MFRuntimeException</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="ManagementPermissionDeniedException.html" title="class in com.sonicsw.mf.common.security">com.sonicsw.mf.common.security.ManagementPermissionDeniedException</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.mf.common.security.ManagePermissionDeniedException</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>ManagePermissionDeniedException</B><DT>extends <A HREF="ManagementPermissionDeniedException.html" title="class in com.sonicsw.mf.common.security">ManagementPermissionDeniedException</A></DL>
</PRE>
<P>
Unchecked management exception.
<p>
Indicates that a caller attempted to directly or indirectly perform some action
on a container or component but did not have permission to perform that action.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#com.sonicsw.mf.common.security.ManagePermissionDeniedException">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="ManagePermissionDeniedException.html#ManagePermissionDeniedException(java.lang.String, java.lang.String, int)">ManagePermissionDeniedException</A></B>(java.lang.String&nbsp;message,
java.lang.String&nbsp;target,
int&nbsp;requiredPermission)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new exception with the specified detail message.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="ManagePermissionDeniedException.html#getRequiredPermission()">getRequiredPermission</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the permission that was denied.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="ManagePermissionDeniedException.html#getTarget()">getTarget</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the target component to which the permission was denied.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.MFRuntimeException"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.sonicsw.mf.common.<A HREF="../MFRuntimeException.html" title="class in com.sonicsw.mf.common">MFRuntimeException</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../MFRuntimeException.html#getMessage()">getMessage</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ManagePermissionDeniedException(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
ManagePermissionDeniedException</H3>
<PRE>
public <B>ManagePermissionDeniedException</B>(java.lang.String&nbsp;message,
java.lang.String&nbsp;target,
int&nbsp;requiredPermission)</PRE>
<DL>
<DD>Constructs a new exception with the specified detail message. The
cause is not initialized, and may subsequently be initialized by
a call to <A HREF="../MFRuntimeException.html#setLinkedException(java.lang.Exception)"><CODE>MFRuntimeException.setLinkedException(java.lang.Exception)</CODE></A>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - The textural details of why the permission was denied.<DD><CODE>target</CODE> - The target component to which the permission was denied.<DD><CODE>requiredPermission</CODE> - The permission that was denied.<DT><B>See Also:</B><DD><A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getRequiredPermission()"><!-- --></A><H3>
getRequiredPermission</H3>
<PRE>
public int <B>getRequiredPermission</B>()</PRE>
<DL>
<DD>Gets the permission that was denied.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getTarget()"><!-- --></A><H3>
getTarget</H3>
<PRE>
public java.lang.String <B>getTarget</B>()</PRE>
<DL>
<DD>Gets the target component to which the permission was denied.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="ManagePermissionDeniedException.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="ManagementPermissionsCheckingNotEnabledException.html" title="class in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FManagePermissionDeniedException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ManagePermissionDeniedException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ManagePermissionDeniedException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="ManagePermissionDeniedException.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ManagePermissionDeniedException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="ManagePermissionDeniedException.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,253 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
ManagementPermissionDeniedException (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.security.ManagementPermissionDeniedException class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="ManagementPermissionDeniedException (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="ManagementPermissionDeniedException.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="InvalidManagementPermissionException.html" title="class in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="ManagementPermissionFactory.html" title="class in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FManagementPermissionDeniedException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ManagementPermissionDeniedException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ManagementPermissionDeniedException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="ManagementPermissionDeniedException.html#methods_inherited_from_class_com.sonicsw.mf.common.MFRuntimeException">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ManagementPermissionDeniedException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.security</FONT>
<BR>
Class ManagementPermissionDeniedException</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.RuntimeException
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../MFRuntimeException.html" title="class in com.sonicsw.mf.common">com.sonicsw.mf.common.MFRuntimeException</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.mf.common.security.ManagementPermissionDeniedException</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="ConfigurePermissionDeniedException.html" title="class in com.sonicsw.mf.common.security">ConfigurePermissionDeniedException</A>, <A HREF="ManagePermissionDeniedException.html" title="class in com.sonicsw.mf.common.security">ManagePermissionDeniedException</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>ManagementPermissionDeniedException</B><DT>extends <A HREF="../MFRuntimeException.html" title="class in com.sonicsw.mf.common">MFRuntimeException</A></DL>
</PRE>
<P>
Management permission denied exception base class.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#com.sonicsw.mf.common.security.ManagementPermissionDeniedException">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="ManagementPermissionDeniedException.html#ManagementPermissionDeniedException(java.lang.String)">ManagementPermissionDeniedException</A></B>(java.lang.String&nbsp;message)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.sonicsw.mf.common.MFRuntimeException"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.sonicsw.mf.common.<A HREF="../MFRuntimeException.html" title="class in com.sonicsw.mf.common">MFRuntimeException</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../MFRuntimeException.html#getMessage()">getMessage</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ManagementPermissionDeniedException(java.lang.String)"><!-- --></A><H3>
ManagementPermissionDeniedException</H3>
<PRE>
public <B>ManagementPermissionDeniedException</B>(java.lang.String&nbsp;message)</PRE>
<DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="ManagementPermissionDeniedException.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="InvalidManagementPermissionException.html" title="class in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="ManagementPermissionFactory.html" title="class in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FManagementPermissionDeniedException.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ManagementPermissionDeniedException.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ManagementPermissionDeniedException.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="ManagementPermissionDeniedException.html#methods_inherited_from_class_com.sonicsw.mf.common.MFRuntimeException">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ManagementPermissionDeniedException.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>
@@ -0,0 +1,295 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:20 EDT 2011 -->
<TITLE>
ManagementPermissionFactory (Management Application API)
</TITLE>
<META NAME="keywords" CONTENT="com.sonicsw.mf.common.security.ManagementPermissionFactory class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="ManagementPermissionFactory (Management Application API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="ManagementPermissionFactory.html#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="ManagementPermissionDeniedException.html" title="class in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="ManagementPermissionsCheckingNotEnabledException.html" title="class in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FManagementPermissionFactory.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ManagementPermissionFactory.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ManagementPermissionFactory.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="ManagementPermissionFactory.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ManagementPermissionFactory.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="ManagementPermissionFactory.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sonicsw.mf.common.security</FONT>
<BR>
Class ManagementPermissionFactory</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sonicsw.mf.common.security.ManagementPermissionFactory</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>ManagementPermissionFactory</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
This factory is used to create <a href="IManagementPermission.html">IManagementPermission</a> instances.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagementPermission</CODE></A>,
<A HREF="IManagementSecurityConfigurator.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagementSecurityConfigurator</CODE></A>,
<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigurePermissionBits</CODE></A>,
<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A>,
<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigureScopeBits</CODE></A>,
<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManageScopeBits</CODE></A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="ManagementPermissionFactory.html#ManagementPermissionFactory()">ManagementPermissionFactory</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security">IManagementPermission</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="ManagementPermissionFactory.html#createManagementPermission(java.lang.String, short)">createManagementPermission</A></B>(java.lang.String&nbsp;principal,
short&nbsp;principalType)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a management permission object to define a new management permission.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security">IManagementPermission</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="ManagementPermissionFactory.html#createManagementPermission(java.lang.String, short, int, int)">createManagementPermission</A></B>(java.lang.String&nbsp;principal,
short&nbsp;principalType,
int&nbsp;scope,
int&nbsp;permissions)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a management permission object to define a new management permission.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ManagementPermissionFactory()"><!-- --></A><H3>
ManagementPermissionFactory</H3>
<PRE>
public <B>ManagementPermissionFactory</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="createManagementPermission(java.lang.String, short)"><!-- --></A><H3>
createManagementPermission</H3>
<PRE>
public <A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security">IManagementPermission</A> <B>createManagementPermission</B>(java.lang.String&nbsp;principal,
short&nbsp;principalType)</PRE>
<DL>
<DD>Creates a management permission object to define a new management permission.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>principal</CODE> - The user or group to which the permission will apply.<DD><CODE>principalType</CODE> - Whether the given principal is a user (<a href="IManagementPermission.html#USER_PRINCIPAL_TYPE">USER_PRINCIPAL_TYPE</a>)
or a group (<a href="IManagementPermission.html#GROUP_PRINCIPAL_TYPE">GROUP_PRINCIPAL_TYPE</a>).<DT><B>See Also:</B><DD><A HREF="IManagementSecurityConfigurator.html#setManagementPermissions(java.lang.String[], java.lang.String, com.sonicsw.mf.common.security.IManagementPermission[][])"><CODE>IManagementSecurityConfigurator.setManagementPermissions(java.lang.String[], java.lang.String, com.sonicsw.mf.common.security.IManagementPermission[][])</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="createManagementPermission(java.lang.String, short, int, int)"><!-- --></A><H3>
createManagementPermission</H3>
<PRE>
public <A HREF="IManagementPermission.html" title="interface in com.sonicsw.mf.common.security">IManagementPermission</A> <B>createManagementPermission</B>(java.lang.String&nbsp;principal,
short&nbsp;principalType,
int&nbsp;scope,
int&nbsp;permissions)</PRE>
<DL>
<DD>Creates a management permission object to define a new management permission.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>principal</CODE> - The user or group to which the permission will apply.<DD><CODE>principalType</CODE> - Whether the given principal is a user (<a href="IManagementPermission.html#USER_PRINCIPAL_TYPE">USER_PRINCIPAL_TYPE</a>)
or a group (<a href="IManagementPermission.html#GROUP_PRINCIPAL_TYPE">GROUP_PRINCIPAL_TYPE</a>).<DD><CODE>scope</CODE> - The sum of the scope bits to which the permission should apply.<DD><CODE>permissions</CODE> - The sum of the permission bits to which the permission should apply.<DT><B>See Also:</B><DD><A HREF="IManagementSecurityConfigurator.html#setManagementPermissions(java.lang.String[], java.lang.String, com.sonicsw.mf.common.security.IManagementPermission[][])"><CODE>IManagementSecurityConfigurator.setManagementPermissions(java.lang.String[], java.lang.String, com.sonicsw.mf.common.security.IManagementPermission[][])</CODE></A>,
<A HREF="IConfigurePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigurePermissionBits</CODE></A>,
<A HREF="IManagePermissionBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManagePermissionBits</CODE></A>,
<A HREF="IConfigureScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IConfigureScopeBits</CODE></A>,
<A HREF="IManageScopeBits.html" title="interface in com.sonicsw.mf.common.security"><CODE>IManageScopeBits</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="ManagementPermissionFactory.html#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Sonic Management API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="ManagementPermissionDeniedException.html" title="class in com.sonicsw.mf.common.security"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="ManagementPermissionsCheckingNotEnabledException.html" title="class in com.sonicsw.mf.common.security"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html@com%252Fsonicsw%252Fmf%252Fcommon%252Fsecurity%252FManagementPermissionFactory.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ManagementPermissionFactory.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ManagementPermissionFactory.html#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="ManagementPermissionFactory.html#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="ManagementPermissionFactory.html#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="ManagementPermissionFactory.html#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size="-1">Copyright &copy; 2001-2011
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
<br>HTML formatted on 12-Aug-2011.</font>
</BODY>
</HTML>

Some files were not shown because too many files have changed in this diff Show More