resource/admin/serverMO.xsl

	serverMO.xsl revision a3d3ab94806056d2355afea6fe8daac41059b9fb
0N/A<!--
2362N/A  ! CDDL HEADER START
0N/A  !
0N/A  ! The contents of this file are subject to the terms of the
0N/A  ! Common Development and Distribution License, Version 1.0 only
0N/A  ! (the "License").  You may not use this file except in compliance
0N/A  ! with the License.
0N/A  !
0N/A  ! You can obtain a copy of the license at
0N/A  ! trunk/opends/resource/legal-notices/OpenDS.LICENSE
0N/A  ! or https://OpenDS.dev.java.net/OpenDS.LICENSE.
0N/A  ! See the License for the specific language governing permissions
0N/A  ! and limitations under the License.
0N/A  !
0N/A  ! When distributing Covered Code, include this CDDL HEADER in each
0N/A  ! file and include the License file at
0N/A  ! trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
0N/A  ! add the following below this CDDL HEADER, with the fields enclosed
2362N/A  ! by brackets "[]" replaced with your own identifying information:
2362N/A  !      Portions Copyright [yyyy] [name of copyright owner]
2362N/A  !
0N/A  ! CDDL HEADER END
0N/A  !
0N/A  !
0N/A  !      Copyright 2007-2008 Sun Microsystems, Inc.
0N/A  ! -->
0N/A<xsl:stylesheet version="1.0" xmlns:adm="http://www.opends.org/admin"
0N/A  xmlns:admpp="http://www.opends.org/admin-preprocessor"
0N/A  xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
0N/A  <xsl:import href="java-utilities.xsl" />
0N/A  <xsl:import href="preprocessor.xsl" />
0N/A  <xsl:import href="property-types.xsl" />
0N/A  <xsl:output method="text" encoding="us-ascii" />
0N/A  <!--
0N/A    Template for generating the interface declaration.
0N/A  -->
0N/A  <xsl:template name="generate-interface-declaration">
0N/A    <xsl:value-of select="'/**&#xa;'" />
0N/A    <xsl:call-template name="add-java-comment">
0N/A      <xsl:with-param name="indent-text" select="' *'" />
0N/A      <xsl:with-param name="content"
0N/A        select="concat('A server-side interface for querying ', $this-ufn,
0N/A                       ' settings.')" />
0N/A    </xsl:call-template>
0N/A    <xsl:value-of select="' * &lt;p&gt;&#xa;'" />
0N/A    <xsl:call-template name="add-java-comment">
0N/A      <xsl:with-param name="indent-text" select="' *'" />
0N/A      <xsl:with-param name="content" select="$this/adm:synopsis" />
0N/A    </xsl:call-template>
0N/A    <xsl:value-of select="' */&#xa;'" />
0N/A    <xsl:value-of
0N/A      select="concat('public interface ',
0N/A                                   $this-java-class ,
0N/A                                   'Cfg extends ')" />
0N/A    <xsl:choose>
0N/A      <xsl:when test="boolean($this/@extends)">
0N/A        <xsl:value-of select="concat($parent-java-class,'Cfg ')" />
0N/A      </xsl:when>
0N/A      <xsl:otherwise>
0N/A        <xsl:value-of select="'Configuration '" />
0N/A      </xsl:otherwise>
0N/A    </xsl:choose>
0N/A    <xsl:text>{&#xa;</xsl:text>
0N/A  </xsl:template>
0N/A  <!--
0N/A    Template for generating the configuration class getter.
0N/A  -->
0N/A  <xsl:template name="generate-configuration-definition-getter">
0N/A    <xsl:value-of
0N/A      select="concat('  /**&#xa;',
0N/A                       '   * Gets the configuration class associated with this ', $this-ufn, '.&#xa;',
0N/A                       '   *&#xa;',
0N/A                       '   * @return Returns the configuration class associated with this ', $this-ufn, '.&#xa;',
0N/A                       '   */&#xa;')" />
0N/A    <xsl:value-of
0N/A      select="concat('  Class&lt;? extends ', $this-java-class,'Cfg&gt; configurationClass();&#xa;')" />
0N/A  </xsl:template>
0N/A  <!--
0N/A    Template for generating the change listener declaration.
0N/A  -->
0N/A  <xsl:template name="generate-change-listener-declaration">
0N/A    <xsl:value-of
0N/A      select="concat('  /**&#xa;',
0N/A                       '   * Register to be notified when this ', $this-ufn,' is changed.&#xa;',
0N/A                       '   *&#xa;',
0N/A                       '   * @param listener&#xa;',
0N/A                       '   *          The ', $this-ufn,' configuration change listener.&#xa;',
0N/A                       '   */&#xa;')" />
0N/A    <xsl:value-of
0N/A      select="concat('  void add', $this-short-java-class,
0N/A                       'ChangeListener(ConfigurationChangeListener&lt;',
0N/A                       $this-java-class,'Cfg&gt; listener);&#xa;')" />
0N/A    <xsl:text>&#xa;</xsl:text>
0N/A    <xsl:text>&#xa;</xsl:text>
0N/A    <xsl:text>&#xa;</xsl:text>
0N/A    <xsl:value-of
0N/A      select="concat('  /**&#xa;',
0N/A                       '   * Deregister an existing ', $this-ufn,' configuration change listener.&#xa;',
0N/A                       '   *&#xa;',
0N/A                       '   * @param listener&#xa;',
0N/A                       '   *          The ', $this-ufn,' configuration change listener.&#xa;',
0N/A                       '   */&#xa;')" />
0N/A    <xsl:value-of
0N/A      select="concat('  void remove', $this-short-java-class,
0N/A                       'ChangeListener(ConfigurationChangeListener&lt;',
0N/A                       $this-java-class,'Cfg&gt; listener);&#xa;')" />
0N/A  </xsl:template>
0N/A  <!--
0N/A    Template for generating the relation getter declarations.
0N/A  -->
0N/A  <xsl:template name="generate-relation-declarations">
0N/A    <xsl:variable name="name" select="@name" />
0N/A    <xsl:variable name="ufn">
0N/A      <xsl:call-template name="name-to-ufn">
0N/A        <xsl:with-param name="value" select="$name" />
0N/A      </xsl:call-template>
0N/A    </xsl:variable>
0N/A    <xsl:variable name="java-relation-name">
0N/A      <xsl:call-template name="name-to-java">
0N/A        <xsl:with-param name="value" select="$name" />
0N/A      </xsl:call-template>
0N/A    </xsl:variable>
0N/A    <xsl:variable name="java-class-name">
0N/A      <xsl:call-template name="name-to-java">
0N/A        <xsl:with-param name="value" select="@managed-object-name" />
0N/A      </xsl:call-template>
0N/A    </xsl:variable>
0N/A    <xsl:choose>
0N/A      <xsl:when test="adm:one-to-one">
0N/A        <xsl:value-of
0N/A          select="concat('  /**&#xa;',
0N/A                       '   * Gets the ', $ufn,'.&#xa;',
0N/A                       '   *&#xa;',
0N/A                       '   * @return Returns the ', $ufn,'.&#xa;',
0N/A                       '   * @throws ConfigException&#xa;',
0N/A                       '   *           If the ', $ufn,' could not be found or it could not&#xa;',
0N/A                       '   *           be successfully decoded.&#xa;',
0N/A                       '   */&#xa;')" />
0N/A        <xsl:value-of
          select="concat('  ', $java-class-name, 'Cfg get',
                       $java-relation-name, '() throws ConfigException;&#xa;')" />
      </xsl:when>
      <xsl:when test="adm:one-to-zero-or-one">
        <xsl:value-of
          select="concat('  /**&#xa;',
                       '   * Determines whether or not the ', $ufn,' exists.&#xa;',
                       '   *&#xa;',
                       '   * @return Returns &lt;true&gt; if the ', $ufn,' exists.&#xa;',
                       '   */&#xa;')" />
        <xsl:value-of
          select="concat('  boolean has',
                       $java-relation-name, '();&#xa;')" />
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:value-of
          select="concat('  /**&#xa;',
                       '   * Gets the ', $ufn,' if it is present.&#xa;',
                       '   *&#xa;',
                       '   * @return Returns the ', $ufn,' if it is present.&#xa;',
                       '   * @throws ConfigException&#xa;',
                       '   *           If the ', $ufn,' does not exist or it could not&#xa;',
                       '   *           be successfully decoded.&#xa;',
                       '   */&#xa;')" />
        <xsl:value-of
          select="concat('  ', $java-class-name, 'Cfg get',
                       $java-relation-name, '() throws ConfigException;&#xa;')" />
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:value-of
          select="concat('  /**&#xa;',
                       '   * Registers to be notified when the ', $ufn,' is added.&#xa;',
                       '   *&#xa;',
                       '   * @param listener&#xa;',
                       '   *          The ', $ufn,' configuration add listener.&#xa;',
                       '   * @throws ConfigException&#xa;',
                       '   *          If the add listener could not be registered.&#xa;',
                       '   */&#xa;')" />
        <xsl:value-of
          select="concat('  void add', $java-relation-name,
                       'AddListener(ConfigurationAddListener&lt;',
                       $java-class-name,'Cfg&gt; listener) throws ConfigException;&#xa;')" />
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:value-of
          select="concat('  /**&#xa;',
                       '   * Deregisters an existing ', $ufn,' configuration add listener.&#xa;',
                       '   *&#xa;',
                       '   * @param listener&#xa;',
                       '   *          The ', $ufn,' configuration add listener.&#xa;',
                       '   */&#xa;')" />
        <xsl:value-of
          select="concat('  void remove', $java-relation-name,
                       'AddListener(ConfigurationAddListener&lt;',
                       $java-class-name,'Cfg&gt; listener);&#xa;')" />
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:value-of
          select="concat('  /**&#xa;',
                       '   * Registers to be notified the ', $ufn,' is deleted.&#xa;',
                       '   *&#xa;',
                       '   * @param listener&#xa;',
                       '   *          The ', $ufn,' configuration delete listener.&#xa;',
                       '   * @throws ConfigException&#xa;',
                       '   *          If the delete listener could not be registered.&#xa;',
                       '   */&#xa;')" />
        <xsl:value-of
          select="concat('  void add', $java-relation-name,
                       'DeleteListener(ConfigurationDeleteListener&lt;',
                       $java-class-name,'Cfg&gt; listener) throws ConfigException;&#xa;')" />
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:value-of
          select="concat('  /**&#xa;',
                       '   * Deregisters an existing ', $ufn,' configuration delete listener.&#xa;',
                       '   *&#xa;',
                       '   * @param listener&#xa;',
                       '   *          The ', $ufn,' configuration delete listener.&#xa;',
                       '   */&#xa;')" />
        <xsl:value-of
          select="concat('  void remove', $java-relation-name,
                       'DeleteListener(ConfigurationDeleteListener&lt;',
                       $java-class-name,'Cfg&gt; listener);&#xa;')" />
      </xsl:when>
      <xsl:when test="adm:one-to-many">
        <xsl:variable name="plural-name"
          select="adm:one-to-many/@plural-name" />
        <xsl:variable name="ufpn">
          <xsl:call-template name="name-to-ufn">
            <xsl:with-param name="value" select="$plural-name" />
          </xsl:call-template>
        </xsl:variable>
        <xsl:variable name="java-relation-plural-name">
          <xsl:call-template name="name-to-java">
            <xsl:with-param name="value" select="$plural-name" />
          </xsl:call-template>
        </xsl:variable>
        <xsl:value-of
          select="concat('  /**&#xa;',
                       '   * Lists the ', $ufpn, '.&#xa;',
                       '   *&#xa;',
                       '   * @return Returns an array containing the names of the&#xa;',
                       '   *         ', $ufpn,'.&#xa;',
                       '   */&#xa;')" />
        <xsl:value-of
          select="concat('  String[] list', $java-relation-plural-name, '();&#xa;')" />
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:value-of
          select="concat('  /**&#xa;',
                       '   * Gets the named ', $ufn,'.&#xa;',
                       '   *&#xa;',
                       '   * @param name&#xa;',
                       '   *          The name of the ',$ufn,' to retrieve.&#xa;',
                       '   * @return Returns the named ', $ufn,'.&#xa;',
                       '   * @throws ConfigException&#xa;',
                       '   *           If the ', $ufn,' could not be found or it&#xa;',
                       '   *           could not be successfully decoded.&#xa;',
                       '   */&#xa;')" />
        <xsl:value-of
          select="concat('  ', $java-class-name, 'Cfg get',
                       $java-relation-name, '(String name) throws ConfigException;&#xa;')" />
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:value-of
          select="concat('  /**&#xa;',
                       '   * Registers to be notified when new ', $ufpn,' are added.&#xa;',
                       '   *&#xa;',
                       '   * @param listener&#xa;',
                       '   *          The ', $ufn,' configuration add listener.&#xa;',
                       '   * @throws ConfigException&#xa;',
                       '   *          If the add listener could not be registered.&#xa;',
                       '   */&#xa;')" />
        <xsl:value-of
          select="concat('  void add', $java-relation-name,
                       'AddListener(ConfigurationAddListener&lt;',
                       $java-class-name,'Cfg&gt; listener) throws ConfigException;&#xa;')" />
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:value-of
          select="concat('  /**&#xa;',
                       '   * Deregisters an existing ', $ufn,' configuration add listener.&#xa;',
                       '   *&#xa;',
                       '   * @param listener&#xa;',
                       '   *          The ', $ufn,' configuration add listener.&#xa;',
                       '   */&#xa;')" />
        <xsl:value-of
          select="concat('  void remove', $java-relation-name,
                       'AddListener(ConfigurationAddListener&lt;',
                       $java-class-name,'Cfg&gt; listener);&#xa;')" />
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:value-of
          select="concat('  /**&#xa;',
                       '   * Registers to be notified when existing ', $ufpn,' are deleted.&#xa;',
                       '   *&#xa;',
                       '   * @param listener&#xa;',
                       '   *          The ', $ufn,' configuration delete listener.&#xa;',
                       '   * @throws ConfigException&#xa;',
                       '   *          If the delete listener could not be registered.&#xa;',
                       '   */&#xa;')" />
        <xsl:value-of
          select="concat('  void add', $java-relation-name,
                       'DeleteListener(ConfigurationDeleteListener&lt;',
                       $java-class-name,'Cfg&gt; listener) throws ConfigException;&#xa;')" />
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:text>&#xa;</xsl:text>
        <xsl:value-of
          select="concat('  /**&#xa;',
                       '   * Deregisters an existing ', $ufn,' configuration delete listener.&#xa;',
                       '   *&#xa;',
                       '   * @param listener&#xa;',
                       '   *          The ', $ufn,' configuration delete listener.&#xa;',
                       '   */&#xa;')" />
        <xsl:value-of
          select="concat('  void remove', $java-relation-name,
                       'DeleteListener(ConfigurationDeleteListener&lt;',
                       $java-class-name,'Cfg&gt; listener);&#xa;')" />
      </xsl:when>
      <xsl:otherwise>
        <xsl:message terminate="yes">
          <xsl:value-of
            select="concat('Unknown relation type &quot;', local-name(*), '&quot; in relation &quot;', $name, '&quot;.')" />
        </xsl:message>
      </xsl:otherwise>
    </xsl:choose>
  </xsl:template>
  <!--
    Main document parsing template.
  -->
  <xsl:template match="/">
    <xsl:call-template name="copyright-notice" />
    <xsl:value-of
      select="concat('package ', $this-package, '.server;&#xa;')" />
    <xsl:text>&#xa;</xsl:text>
    <xsl:text>&#xa;</xsl:text>
    <xsl:text>&#xa;</xsl:text>
    <xsl:call-template name="generate-import-statements">
      <xsl:with-param name="imports">
        <xsl:for-each select="$this-local-properties">
          <xsl:call-template name="get-property-java-imports" >
            <xsl:with-param name="interface" select="'server'" />
          </xsl:call-template>
        </xsl:for-each>
        <xsl:if test="$this-local-properties[@multi-valued='true']">
          <import>java.util.SortedSet</import>
        </xsl:if>
        <xsl:choose>
          <xsl:when test="$this/@extends">
            <xsl:if test="$parent-package != $this-package">
              <xsl:element name="import">
                <xsl:value-of
                  select="concat($parent-package, '.server.', $parent-java-class, 'Cfg')" />
              </xsl:element>
            </xsl:if>
          </xsl:when>
          <xsl:otherwise>
            <import>org.opends.server.admin.Configuration</import>
          </xsl:otherwise>
        </xsl:choose>
        <xsl:if test="not($this-is-root)">
          <import>
            org.opends.server.admin.server.ConfigurationChangeListener
          </import>
        </xsl:if>
        <xsl:if test="$this-local-relations">
          <import>org.opends.server.config.ConfigException</import>
        </xsl:if>
        <xsl:if
          test="$this-local-relations/adm:one-to-zero-or-one|$this-local-relations/adm:one-to-many">
          <import>
            org.opends.server.admin.server.ConfigurationAddListener
          </import>
          <import>
            org.opends.server.admin.server.ConfigurationDeleteListener
          </import>
        </xsl:if>
      </xsl:with-param>
    </xsl:call-template>
    <xsl:text>&#xa;</xsl:text>
    <xsl:text>&#xa;</xsl:text>
    <xsl:text>&#xa;</xsl:text>
    <xsl:call-template name="generate-interface-declaration" />
    <xsl:text>&#xa;</xsl:text>
    <xsl:call-template name="generate-configuration-definition-getter" />
    <xsl:if test="not($this-is-root)">
      <xsl:text>&#xa;</xsl:text>
      <xsl:text>&#xa;</xsl:text>
      <xsl:text>&#xa;</xsl:text>
      <xsl:call-template name="generate-change-listener-declaration" />
    </xsl:if>
    <xsl:for-each select="$this-local-properties">
      <xsl:sort select="@name" />
      <xsl:text>&#xa;</xsl:text>
      <xsl:text>&#xa;</xsl:text>
      <xsl:text>&#xa;</xsl:text>
      <xsl:call-template name="generate-property-getter-declaration">
        <xsl:with-param name="interface" select="'server'" />
      </xsl:call-template>
    </xsl:for-each>
    <xsl:for-each select="$this-local-relations">
      <xsl:sort select="@name" />
      <xsl:text>&#xa;</xsl:text>
      <xsl:text>&#xa;</xsl:text>
      <xsl:text>&#xa;</xsl:text>
      <xsl:call-template name="generate-relation-declarations" />
    </xsl:for-each>
    <xsl:text>&#xa;</xsl:text>
    <xsl:text>}&#xa;</xsl:text>
  </xsl:template>
</xsl:stylesheet>