將服務與JMX控制台整合

使用JMX控制台建立並部署MBean以管理服務。 公開服務屬性和操作,以便執行管理任務。

有關使用JMX控制台的資訊,請參閱使用JMX控制台監視伺服器資源

Felix和CQ5中的JMX框架

在Apache Felix平台上,您可將MBean部署為OSGi服務。 在OSGi服務註冊表中註冊MBean服務時,Aries JMX白板模組會自動向MBean伺服器註冊MBean。 MBean隨後可用於JMX控制台,該控制台將公開公共屬性和操作。

jmxhitboard

為CQ5和CRX建立MBean

您為管理CQ5或CRX資源而建立的MBean是基於javax.management.DynamicMBean介面。 要建立它們,請遵循JMX規範中規定的常規設計模式:

  • 建立管理介面,包括get、set和是定義屬性的方法,以及定義操作的其他方法。
  • 建立實作類別。 類必須實施DynamicMBean,或擴展DynamicMBean的實施類。
  • 請遵循標準命名慣例,使實施類的名稱為尾碼為MBean的介面名稱。

除了定義管理介面外,介面還定義了OSGi服務介面。 實施類實現OSGi服務。

使用注釋提供MBean資訊

com.adobe.granite.jmx.annotation套件提供數個注釋和類,以便輕鬆地向JMX控制台提供MBean元資料。 使用這些注釋和類,而不是直接將資訊添加到MBean的MBeanInfo對象。

註解

向管理介面添加註釋以指定MBean元資料。 資訊會顯示在JMX控制台中,用於部署的每個實施類。 下列為可用的註解(如需完整資訊,請參閱com.adobe.granite.jmx.annotation JavaDocs):

  • 說明: 提供MBean類或方法的說明。在類聲明上使用時,說明將出現在MBean的「JMX控制台」頁上。 在方法上使用時,說明會顯示為對應屬性或操作的暫留文字。

  • 影響: 方法的影響。有效參數值是由javax.management.MBeanOperationInfo定義的欄位。

  • 名稱: 指定要為操作參數顯示的名稱。使用此注釋覆蓋介面中使用的方法參數的實際名稱。

  • OpenTypeInfo: 指定在JMX控制台中用於表示複合資料或表格資料的類。用於Open MBean

  • TabularTypeInfo: 用於注釋用於表示表格資料的類。

類別

提供的類用於建立動態MBean,這些ean使用您添加到其介面的注釋:

  • AnnotatedStandardMBean: javax.management.StandardMBean類的子類,它自動向JMX控制台提供注釋元資料。
  • OpenAnnotatedStandardMBean: AnnotatedStandardMBean類的子類,用於建立使用OpenTypeInfo注釋的Open Mbean。

開發MBean

通常,您的MBean是對您要管理的OSGi服務的反映。 在Felix平台上,您會像在其他Java伺服器平台上部署時一樣建立MBean。 主要區別是,您可以使用注釋來指定MBean資訊:

  • 管理介面:使用getter、setter和is方法定義屬性。 使用任何其他公用方法定義操作。 使用注釋來提供BeanInfo對象的元資料。
  • MBean類:實作管理介面。 擴展AnnotatedStandardMBean類,以便處理介面上的注釋。

以下範例MBean提供有關CRX存放庫的資訊。 介面使用「說明」注釋來向JMX控制台提供資訊。

管理介面

package com.adobe.example.myapp;

import com.adobe.granite.jmx.annotation.Description;

@Description("Example MBean that exposes repository properties.")
public interface ExampleMBean {

    @Description("The name of the repository.")
    String getRepositoryName();

    @Description("The vendor of the repository.")
    String   getRepositoryVendor();

    @Description("The URL of repository vendor.")
    String getVendorUrl();
}

實作類別使用SlingRepository服務來擷取CRX存放庫的相關資訊。

MBean實現類

package com.adobe.example.myapp;

import org.apache.felix.scr.annotations.*;
import org.apache.sling.jcr.api.SlingRepository;

import com.adobe.granite.jmx.annotation.AnnotatedStandardMBean;

import javax.management.*;

public class ExampleMBeanImpl extends AnnotatedStandardMBean implements ExampleMBean {

    @Reference(cardinality = ReferenceCardinality.OPTIONAL_UNARY)
    private SlingRepository repository;

    public ExampleMBeanImpl() throws NotCompliantMBeanException {
        super(ExampleMBean.class);
    }

    public String getRepositoryName() {
        return repository.getDescriptor("jcr.repository.name");
    }

    public String getRepositoryVendor() {
        return repository.getDescriptor("jcr.repository.vendor");
    }

    public String getVendorUrl() {
        return repository.getDescriptor("jcr.repository.vendor.url");
    }
}

下圖顯示了JMX控制台中此MBean的頁。

jmxdescription

註冊MBean

將MBean註冊為OSGi服務時,它們會自動註冊到MBean伺服器。 若要在CQ5上安裝MBean,請將其納入套件,然後像導出任何其他OSGi服務一樣導出MBean服務。

除了與OSGi相關的元資料之外,您還必須提供元資料,Aries JMX Whiteboard模組需要這些元資料,以便向MBean伺服器註冊MBean:

  • DynamicMBean介面的名稱: 聲明MBean服務實 javax.management.DynamicMBea施n介面。此聲明通知Aries JMX白板模組,該服務是MBean服務。

  • MBean網域和索引鍵屬性: 在Felix上,您以MBean的OSGi服務的屬性提供此資訊。這與通常在javax.management.ObjectName對象中提供給MBean伺服器的資訊相同。

如果MBean是單一服務的反映,則只需要MBean服務的單個實例。 在此情況下,如果使用Felix SCR Maven插件,則可以使用MBean實施類上的Apache Felix服務元件運行時(SCR)注釋來指定與JMX相關的元資料。 要實例化多個MBean實例,可以建立另一個類,用於執行MBean的OSGi服務的註冊。 在這種情況下,在運行時生成與JMX相關的元資料。

單MBean

可以使用MBean實現類中的SCR注釋來部署可在設計時定義所有屬性和操作的MBean。 在以下示例中,Service批注的value屬性聲明服務實現DynamicMBean介面。 Property批注的name屬性指定JMX域和鍵屬性。

具有SCR注釋的MBean實現類

package com.adobe.example.myapp;

import org.apache.felix.scr.annotations.*;
import org.apache.sling.jcr.api.SlingRepository;

import com.adobe.granite.jmx.annotation.AnnotatedStandardMBean;

import javax.management.*;

@Component(immediate = true)
@Property(name = "jmx.objectname", value="com.adobe.example:type=CRX")
@Service(value = DynamicMBean.class)
public class ExampleMBeanImpl extends AnnotatedStandardMBean implements ExampleMBean {

    @Reference(cardinality = ReferenceCardinality.OPTIONAL_UNARY)
    private SlingRepository repository;

    public ExampleMBeanImpl() throws NotCompliantMBeanException {
        super(ExampleMBean.class);
    }

    public String getRepositoryName() {
        return repository.getDescriptor("jcr.repository.name");
    }

    public String getRepositoryVendor() {
        return repository.getDescriptor("jcr.repository.vendor");
    }

    public String getVendorUrl() {
        return repository.getDescriptor("jcr.repository.vendor.url");
    }
}

多個MBean服務實例

要管理托管服務的多個實例,請建立相應MBean服務的多個實例。 此外,在啟動或停止受管實例時,應建立或刪除MBean服務實例。 您可以建立MBean管理器類以在運行時實例化MBean服務,並管理服務生命週期。

使用BundleContext將MBean註冊為OSGi服務。 在Dictionary對象中包括與JMX相關的資訊,該對象用作BundleContext.registerService方法的參數。

在以下代碼示例中, ExampleMBean服務以寫程式方式註冊。 componentContext對象是ComponentContext,它提供對BundleContext的訪問。

程式碼片段:程式化MBean服務註冊

Dictionary mbeanProps = new Hashtable();
mbeanProps.put("jmx.objectname", "com.adobe.example:type=CRX");
ExampleMBeanImpl mbean = new ExampleMBeanImpl();
ServiceRegistration serviceregistration =
            componentContext.getBundleContext().registerService(DynamicMBean.class.getName(), mbean, mbeanProps);

下一節中的示例MBean提供了更多詳細資訊。

當儲存庫中儲存服務配置時, MBean服務管理器很有用。 管理器可檢索服務資訊,並使用它配置和建立相應的MBean。 管理器類還可以監聽儲存庫更改事件,並相應地更新MBean服務。

範例:使用JMX監控工作流模型

此範例中的MBean提供儲存在存放庫中的CQ5工作流程模型的相關資訊。 MBean管理器類基於儲存在儲存庫中的工作流模型建立MBean,並在運行時註冊其OSGi服務。 此示例由包含以下成員的單個束組成:

  • 工作流MBean:管理介面。
  • WorkflowMBeanImpl:MBean實現類。
  • WorkflowMBeanManager:MBean管理器類的介面。
  • WorkflowMBeanManager實施:MBean管理器的實施類。

注意: 為簡單起見,此範例中的程式碼不會執行記錄或回應擲回的例外狀況。

WorkflowMBeanManagerImpl包括元件激活方法。 啟動元件時,方法會執行下列工作:

  • 獲取該捆綁的BundleContext。
  • 查詢儲存庫以獲取現有工作流模型的路徑。
  • 為每個工作流模型建立MBean。
  • 向OSGi服務註冊表註冊MBean。

MBean元資料顯示在JMX控制台中,其中包含com.adobe.example域、workflow_model類型,而Properties是工作流模型配置節點的路徑。

jmxworkflowbean

示例MBean

此示例需要MBean介面和實現,該介面是com.day.cq.workflow.model.WorkflowModel介面上的反映。 MBean非常簡單,因此示例可以專注於設計的配置和部署方面。 MBean會公開單一屬性,即模型名稱。

WorkflowMBean介面

package com.adobe.example.myapp.api;

import com.adobe.granite.jmx.annotation.Description;

@Description("Example MBean that exposes Workflow model properties.")
public interface WorkflowMBean {

 @Description("The name of the Workflow model.")
 String getModelName();
}

WorkflowMBeanImpl

package com.adobe.example.myapp.impl;

import javax.management.NotCompliantMBeanException;

import com.day.cq.workflow.model.WorkflowModel;
import com.adobe.example.myapp.api.WorkflowMBean;
import com.adobe.granite.jmx.annotation.AnnotatedStandardMBean;

public class WorkflowMBeanImpl extends AnnotatedStandardMBean implements WorkflowMBean {

 WorkflowModel model;

 protected WorkflowMBeanImpl(WorkflowModel inmodel)
   throws NotCompliantMBeanException {
  super(WorkflowMBean.class);
  model=inmodel;
 }

 public String getModelName() {
  return model.getTitle();
 }
}

示例MBean管理器

WorkflowMBeanManager服務包括建立WorkflowMBean服務的元件激活方法。 服務實作包含下列方法:

  • 啟用:元件激活器。 建立JCR會話以讀取WorkflowModel配置節點。 儲存模型配置的根節點在靜態欄位中定義。 配置節點的名稱也在靜態欄位中定義。 此方法會呼叫其他方法,以取得節點模型路徑並建立模型WorkflowMBeans。
  • getModelIds:遍歷根節點下的儲存庫,並檢索每個模型節點的路徑。
  • makeMBean:使用模型路徑建立WorkflowModel對象,為其建立WorkflowMBean,並註冊其OSGi服務。
注意

WorkflowMBeanManager實施僅為激活元件時存在的模型配置建立MBean服務。 更強大的實施會監聽與新模型配置以及現有模型配置的更改或刪除相關的儲存庫事件。 發生更改時,管理器可以建立、修改或刪除相應的WorkflowMBean服務。

WorkflowMBeanManager介面

package com.adobe.example.myapp.api;

public interface WorkflowMBeanManager {

}

WorkflowMBeanManagerImpl

package com.adobe.example.myapp.impl;

import java.util.*;

import org.apache.felix.scr.annotations.*;

import javax.jcr.Session;
import javax.jcr.Node;
import javax.jcr.NodeIterator;
import javax.jcr.RepositoryException;
import javax.management.ObjectName;

import org.apache.sling.jcr.api.SlingRepository;
import org.osgi.framework.ServiceRegistration;
import org.osgi.service.component.ComponentContext;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.day.cq.workflow.WorkflowService;
import com.day.cq.workflow.WorkflowSession;
import com.adobe.example.myapp.api.WorkflowMBean;
import com.adobe.example.myapp.api.WorkflowMBeanManager;

/**Instantiates and registers WorkflowMBean services */
@Component(immediate=true)
@Service(value=WorkflowMBeanManager.class)
public class WorkflowMBeanManagerImpl implements WorkflowMBeanManager {
 //The ComponentContext provides access to the BundleContext
 private ComponentContext componentContext;

 //Use the SlingRepository service to read model nodes
 @Reference
        private SlingRepository repository = null;

 //Use the WorkflowService service to create WorkflowModel objects
 @Reference
 private WorkflowService workflowservice = null;

  private Session session;

         //Details about model nodes
  private static final String MODEL_ROOT ="/etc/workflow/models";
  private static final String MODEL_NODE = "model";

  private Set<String> modelIds = new HashSet<String>();

        //Storage for ServiceRegistrations for MBean services
  private Collection<ServiceRegistration> mbeanRegistrations= new Vector<ServiceRegistration>(0,1);

 @Activate
        protected void activate(ComponentContext ctx) {
             //Traverse the repository and load the model nodes
             try {
                   session = repository.loginAdministrative(null);
                   // load and store model node paths
                   if (session.nodeExists(MODEL_ROOT)) {
                          getModelIds(session.getNode(MODEL_ROOT));
                   }
                   //Create MBeans for each model
                   for(String modid: modelIds){
                    makeMBean(modid);
                    }
             }catch(Exception e){ }
          }

        /**
         * Add JMX domain and key properties to a collection
         * Instantiate a WorkflowModel and its WorkflowMBeanImpl object
         * Register the MBean OSGi service
         */
 private void makeMBean(String modelId) {
             // create MBean for the model
             try {
                 Dictionary<String, String> mbeanProps = new Hashtable<String, String>();
                 //These properties appear on the JMX Console home page
                 mbeanProps.put("jmx.objectname", "com.adobe.example:type=workflow_model,id=" + ObjectName.quote(modelId));
                 WorkflowSession wfsession = workflowservice.getWorkflowSession(session);
                 WorkflowMBeanImpl mbean = new WorkflowMBeanImpl(wfsession.getModel(modelId));

                ServiceRegistration serviceregistration = componentContext.getBundleContext().registerService(WorkflowMBean.class.getName(), mbean, mbeanProps);
                //Store the ServiceRegistration objects for deactivation
                mbeanRegistrations.add(serviceregistration);
             } catch (Throwable t) {}
         }

        /**
         * Traverses the repository branch below a given Node. Stores the path of each model node.
         */
 private void getModelIds(Node node) throws RepositoryException {
  try{
                     NodeIterator iter = node.getNodes();
                     while (iter.hasNext()) {
                           Node n = iter.nextNode();
                           //Look for "jcr:content" nodes
                           if (n.getName().equals("jcr:content")) {
                                //get the path of the model node and save it
                                if(n.hasNode(MODEL_NODE)){
                                      modelIds.add(n.getNode(MODEL_NODE).getPath());
                                 }
                           } else{
                                   //Scan child nodes
                                   getModelIds(n);
                           }
                       }
  }catch(Exception e){ }
       }

        /**
         * Log out of the JCR session and unregister WorkflowMBean services
         */
        @Deactivate
        protected void deactivate() {
          session.logout();
          session=null;
          for(ServiceRegistration sr:mbeanRegistrations){
         sr.unregister();
          }
        }
}

示例MBean的POM檔案

為方便起見,您可以將下列XML程式碼複製並貼到您的專案pom.xml檔案中,以便建立元件套件組合。 POM會參考數個必要的外掛程式和相依性。

外掛程式:

  • Apache Maven編譯器插件:從原始碼編譯Java類。
  • Apache Felix Maven套件組合外掛程式:建立套件和資訊清單
  • Apache Felix Maven SCR外掛程式:建立元件描述符檔案並配置服務元件清單標頭。

注意: 撰寫時,Maven scr外掛程式與Eclipse適用的m2e外掛程式不相容。(請參閱Felix bug 3170。) 若要使用Eclipse IDE,請安裝Maven並使用命令列介面來執行組建。

範例POM檔案

<project xmlns="https://maven.apache.org/POM/4.0.0"
  xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.adobe.example.myapp</groupId>
  <artifactId>workflow-mbean</artifactId>
  <version>0.0.2-SNAPSHOT</version>
  <name>mbean-simple</name>
  <url>www.adobe.com</url>
  <description>A simple MBean</description>
  <packaging>bundle</packaging>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
    <build>
        <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>1.5</source>
                <target>1.5</target>
            </configuration>
        </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-scr-plugin</artifactId>
                <version>1.7.2</version>
                <executions>
                    <execution>
                        <id>generate-scr-scrdescriptor</id>
              <goals>
                 <goal>scr</goal>
              </goals>
            </execution>
         </executions>
            </plugin>
             <plugin>
            <groupId>org.apache.felix</groupId>
            <artifactId>maven-bundle-plugin</artifactId>
            <version>1.4.3</version>
            <extensions>true</extensions>
            <configuration>
                <instructions>
                    <Export-Package>com.adobe.example.myapp.*;version=${project.version}</Export-Package>
                </instructions>
            </configuration>
        </plugin>
        </plugins>
    </build>
    <dependencies>
        <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr.annotations</artifactId>
            <version>1.6.0</version>
            <scope>provided</scope>
        </dependency>
         <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.api</artifactId>
            <version>2.0.8</version>
            <scope>provided</scope>
        </dependency>
         <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr</artifactId>
            <version>1.6.1-R1236132</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.jcr.api</artifactId>
            <version>2.0.4</version>
        </dependency>
        <dependency>
            <groupId>com.adobe.granite</groupId>
            <artifactId>com.adobe.granite.jmx</artifactId>
            <version>0.1.6</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
       <groupId>com.day.cq.wcm</groupId>
       <artifactId>cq-wcm-mobile-api</artifactId>
       <version>5.5.2</version>
       <scope>provided</scope>
      </dependency>
      <dependency>
       <groupId>com.day.cq.workflow</groupId>
       <artifactId>cq-workflow-api</artifactId>
       <version>5.5.0</version>
       <scope>provided</scope>
      </dependency>
      <dependency>
       <groupId>javax.jcr</groupId>
       <artifactId>jcr</artifactId>
       <version>2.0</version>
       <scope>provided</scope>
      </dependency>
      <dependency>
                <groupId>org.slf4j</groupId>
  <artifactId>slf4j-api</artifactId>
  <version>1.6.4</version>
  <scope>provided</scope>
 </dependency>
    </dependencies>
</project>

將下列設定檔新增至您的Maven設定檔,以使用公用Adobe存放庫。

Maven配置檔案

<profile>
    <id>adobe-public</id>
    <activation>
         <activeByDefault>false</activeByDefault>
    </activation>
    <properties>
         <releaseRepository-Id>adobe-public-releases</releaseRepository-Id>
         <releaseRepository-Name>Adobe Public Releases</releaseRepository-Name>
         <releaseRepository-URL>https://repo.adobe.com/nexus/content/groups/public</releaseRepository-URL>
    </properties>
    <repositories>
         <repository>
             <id>adobe-public-releases</id>
             <name>Adobe Basel Public Repository</name>
             <url>https://repo.adobe.com/nexus/content/groups/public</url>
             <releases>
                 <enabled>true</enabled>
                 <updatePolicy>never</updatePolicy>
             </releases>
             <snapshots>
                 <enabled>false</enabled>
             </snapshots>
         </repository>
     </repositories>
     <pluginRepositories>
         <pluginRepository>
             <id>adobe-public-releases</id>
             <name>Adobe Basel Public Repository</name>
             <url>https://repo.adobe.com/nexus/content/groups/public</url>
             <releases>
                 <enabled>true</enabled>
                 <updatePolicy>never</updatePolicy>
             </releases>
             <snapshots>
                 <enabled>false</enabled>
             </snapshots>
         </pluginRepository>
     </pluginRepositories>
</profile>

本頁內容