Java API inicializálása és előkészítése

Mielőtt megkezdené a dokumentummeghatározások konfigurálását és a dokumentumok előállítását, inicializálja a Java™ alkalmazás programozási felületet és válassza ki a naplózási módszert.

Eljárás

  1. Kötelező: Válassza ki az API inicializálásának módját:
    • Automatikusan: Az RPE_HOME környezeti változóval azonosítsa a config és a source könyvtár elérési útját a Rational Publishing Engine telepítésben.
    • Programból: Az AppUtils.setProductHome(path) használatával állítsa be a config és a source könyvtár elérési útját a Rational Publishing Engine telepítésben.
    Tipp: Az API programból való inicializálása az ajánlott módszer. Amikor programból inicializálja az API-t, akkor az alkalmazás config és source könyvtárral együtt szállított, nem a Rational Publishing Engine telepítésben található könyvtárakra támaszkodik.
  2. Választható: Válasszon egy naplózási módszert:
    • Állítsa be a Rational Publishing Engine terméket az alkalmazásban található naplózó használatára:
      • Hozza létre az org.apache.commons.logging.Log osztály egy példányát a naplózáshoz.
      • Ha az alkalmazás nem az általános naplózást használja, akkor megadhatja a Rational Publishing Engine számára az IRPELogger felületet megvalósító osztály egy példányát. Ez az osztály átalakítja a Rational Publishing Engine naplózási hívásait az adott alkalmazás naplózásához intézett hívásokká.
    • Állítsa be a Rational Publishing Engine naplózót az alkalmazásban:
      • Használja a Rational Publishing Engine naplózót az alkalmazásban. Például:
        AppUtils.getLogger().info( "Starting RPE");
      • Mielőtt bármilyen Rational Publishing Engine funkciót használna, állítsa be a Log4j naplózót:
        • Ha a log4j.properties fájl a projekt gyökérmappájában található, akkor az alábbi módon inicializálja a Log4j naplózót:
          PropertyConfigurator.configure( this.class.getClassLoader().getResource("./log4j.properties"));
        • Ha a log4j.properties fájl nem a projekt gyökérmappájában található, akkor az alábbi módon inicializálja a Log4j naplózót:
          PropertyConfigurator.configure( new File( AppUtils.getConfigFilePath(), "log4j.properties").getAbsolutePath());
  3. Választható: Csatlakozzon az előrehaladási értesítésekhez. A jelentéselőállítóknak az RPEListener figyelőn keresztül küldhetők értesítési üzenetek. Ezek az üzenetek ugyanazok, mint amiket a Launcher alkalmazás megjelenít az előrehaladás ablakban a dokumentum előállítása során.

Visszajelzés