From 89debdc4f4f38e0d973c9f4f37e1c34002deeeb4 Mon Sep 17 00:00:00 2001
From: matthew_swift <matthew_swift@localhost>
Date: Tue, 22 May 2007 14:35:47 +0000
Subject: [PATCH] Various improvements and refactorings of the admin framework client API, including:
---
opendj-sdk/opends/resource/admin/clientMO.xsl | 351 +++++++++++++++++++++++++++++++++++++++-------------------
1 files changed, 234 insertions(+), 117 deletions(-)
diff --git a/opendj-sdk/opends/resource/admin/clientMO.xsl b/opendj-sdk/opends/resource/admin/clientMO.xsl
index bfaf653..3db6324 100644
--- a/opendj-sdk/opends/resource/admin/clientMO.xsl
+++ b/opendj-sdk/opends/resource/admin/clientMO.xsl
@@ -97,84 +97,138 @@
</xsl:variable>
<xsl:choose>
<xsl:when test="adm:one-to-one">
+ <xsl:call-template name="add-java-comment2">
+ <xsl:with-param name="indent" select="2" />
+ <xsl:with-param name="content"
+ select="concat(
+ 'Gets the ', $ufn,'.
',
+ '
',
+ '@return Returns the ', $ufn,'.
',
+ '@throws DefinitionDecodingException
',
+ ' If the ', $ufn, ' was found but its type could not be determined.
',
+ '@throws ManagedObjectDecodingException
',
+ ' If the ', $ufn, ' was found but one or more of its properties could not be decoded.
',
+ '@throws ManagedObjectNotFoundException
',
+ ' If the ', $ufn, ' could not be found on the server.
',
+ '@throws ConcurrentModificationException
',
+ ' If this ', $this-ufn, ' has been removed from the server by another client.
',
+ '@throws AuthorizationException
',
+ ' If the server refuses to retrieve the ', $ufn, ' because the client does not have the correct privileges.
',
+ '@throws CommunicationException
',
+ ' If the client cannot contact the server due to an underlying communication problem.')" />
+ </xsl:call-template>
<xsl:value-of
- select="concat(' /**
',
- ' * Gets the ', $ufn,'.
',
- ' *
',
- ' * @return Returns the ', $ufn,'.
',
- ' * @throws OperationsException
',
- ' * If the ', $ufn,' could not be read due to some
',
- ' * underlying communication problem.
',
- ' */
')" />
- <xsl:value-of
- select="concat(' ', $java-class-name, 'CfgClient get',
- $java-relation-name, '() throws OperationsException;
')" />
+ select="concat(' ', $java-class-name, 'CfgClient get', $java-relation-name, '()
',
+ ' throws DefinitionDecodingException, ManagedObjectDecodingException,
',
+ ' ManagedObjectNotFoundException, ConcurrentModificationException,
',
+ ' AuthorizationException, CommunicationException;
')" />
</xsl:when>
<xsl:when test="adm:one-to-zero-or-one">
- <xsl:value-of
- select="concat(' /**
',
- ' * Determines whether or not the ', $ufn,' exists.
',
- ' *
',
- ' * @return Returns <true> if the ', $ufn,' exists.
',
- ' * @throws OperationsException
',
- ' * If the determination could not be made
',
- ' * due to some underlying communication problem.
',
- ' */
')" />
+ <xsl:call-template name="add-java-comment2">
+ <xsl:with-param name="indent" select="2" />
+ <xsl:with-param name="content"
+ select="concat('Determines whether or not the ', $ufn,' exists.
',
+ '
',
+ '@return Returns <true> if the ', $ufn,' exists.
',
+ '@throws ConcurrentModificationException
',
+ ' If this ', $this-ufn, ' has been removed from the server by another client.
',
+ '@throws AuthorizationException
',
+ ' If the server refuses to make the determination because the client does not have the correct privileges.
',
+ '@throws CommunicationException
',
+ ' If the client cannot contact the server due to an underlying communication problem.')" />
+ </xsl:call-template>
<xsl:value-of
select="concat(' boolean has',
- $java-relation-name, '() throws OperationsException;
')" />
+ $java-relation-name, '() throws ConcurrentModificationException,
',
+ ' AuthorizationException, CommunicationException;
')" />
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
+ <xsl:call-template name="add-java-comment2">
+ <xsl:with-param name="indent" select="2" />
+ <xsl:with-param name="content"
+ select="concat(
+ 'Gets the ', $ufn,' if it is present.
',
+ '
',
+ '@return Returns the ', $ufn, ' if it is present.
',
+ '@throws DefinitionDecodingException
',
+ ' If the ', $ufn, ' was found but its type could not be determined.
',
+ '@throws ManagedObjectDecodingException
',
+ ' If the ', $ufn, ' was found but one or more of its properties could not be decoded.
',
+ '@throws ManagedObjectNotFoundException
',
+ ' If the ', $ufn, ' is not present.
',
+ '@throws ConcurrentModificationException
',
+ ' If this ', $this-ufn, ' has been removed from the server by another client.
',
+ '@throws AuthorizationException
',
+ ' If the server refuses to retrieve the ', $ufn, ' because the client does not have the correct privileges.
',
+ '@throws CommunicationException
',
+ ' If the client cannot contact the server due to an underlying communication problem.')" />
+ </xsl:call-template>
<xsl:value-of
- select="concat(' /**
',
- ' * Gets the ', $ufn,' if it is present.
',
- ' *
',
- ' * @return Returns the ', $ufn,' if it is present.
',
- ' * @throws OperationsException
',
- ' * If the ', $ufn,' does not exist or could not be read
',
- ' * due to some underlying communication problem.
',
- ' */
')" />
- <xsl:value-of
- select="concat(' ', $java-class-name, 'CfgClient get',
- $java-relation-name, '() throws OperationsException;
')" />
+ select="concat(' ', $java-class-name, 'CfgClient get', $java-relation-name, '()
',
+ ' throws DefinitionDecodingException, ManagedObjectDecodingException,
',
+ ' ManagedObjectNotFoundException, ConcurrentModificationException,
',
+ ' AuthorizationException, CommunicationException;
')" />
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
- <xsl:value-of
- select="concat(' /**
',
- ' * Creates the ', $ufn,' if it does not exist yet.
',
- ' *
',
- ' * @param <C>
',
- ' * The type of the ', $ufn,' being added.
',
- ' * @param d
',
- ' * The definition of the ', $ufn,' to be created.
',
- ' * @param p
',
- ' * A property provider which can be used to initialize
',
- ' * the property values of the new ', $ufn,'.
',
- ' * @return Returns the ', $ufn,' instance representing the
',
- ' * ', $ufn,' that was created.
',
- ' * @throws OperationsException
',
- ' * If the ', $ufn,' already exists or could not be created
',
- ' * due to some underlying communication problem.
',
- ' */
')" />
+ <xsl:call-template name="add-java-comment2">
+ <xsl:with-param name="indent" select="2" />
+ <xsl:with-param name="content"
+ select="concat(
+ 'Creates the ', $ufn,' if it does not exist yet.
',
+ '
',
+ '@param <C>
',
+ ' The type of the ', $ufn,' being added.
',
+ '@param d
',
+ ' The definition of the ', $ufn,' to be created.
',
+ '@param p
',
+ ' A property provider which can be used to initialize the property values of the new ', $ufn,'.
',
+ '@return Returns the ', $ufn,' instance representing the ', $ufn,' that was created.
',
+ '@throws ManagedObjectDecodingException
',
+ ' If the ', $ufn,' could not be created because one or more of its properties are invalid.
',
+ '@throws ManagedObjectAlreadyExistsException
',
+ ' If the ', $ufn,' cannot be created because it already exists on the server.
',
+ '@throws ConcurrentModificationException
',
+ ' If this ', $ufn,' has been removed from the server by another client.
',
+ '@throws OperationRejectedException
',
+ ' If the server refuses to create the ', $ufn,' due to some server-side constraint which cannot be satisfied.
',
+ '@throws AuthorizationException
',
+ ' If the server refuses to create the ', $ufn,' because the client does not have the correct privileges.
',
+ '@throws CommunicationException
',
+ ' If the client cannot contact the server due to an underlying communication problem.
')" />
+ </xsl:call-template>
<xsl:value-of
select="concat(' <C extends ', $java-class-name,'CfgClient> C create', $java-relation-name, '(
',
- ' ManagedObjectDefinition<C, ?> d, PropertyProvider p) throws OperationsException;
')" />
+ ' ManagedObjectDefinition<C, ?> d, PropertyProvider p)
',
+ ' throws ManagedObjectDecodingException, ManagedObjectAlreadyExistsException,
',
+ ' ConcurrentModificationException, OperationRejectedException,
',
+ ' AuthorizationException, CommunicationException;
')" />
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
+ <xsl:call-template name="add-java-comment2">
+ <xsl:with-param name="indent" select="2" />
+ <xsl:with-param name="content"
+ select="concat(
+ 'Removes the ', $ufn,' if it exists.
',
+ '
',
+ '@throws ManagedObjectNotFoundException
',
+ ' If the ', $ufn, ' does not exist.
',
+ '@throws OperationRejectedException
',
+ ' If the server refuses to remove the ', $ufn, ' due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
',
+ '@throws ConcurrentModificationException
',
+ ' If this ', $this-ufn, ' has been removed from the server by another client.
',
+ '@throws AuthorizationException
',
+ ' If the server refuses to remove the ', $ufn, ' because the client does not have the correct privileges.
',
+ '@throws CommunicationException
',
+ ' If the client cannot contact the server due to an underlying communication problem.')" />
+ </xsl:call-template>
<xsl:value-of
- select="concat(' /**
',
- ' * Removes the ', $ufn,' if it exists.
',
- ' *
',
- ' * @throws OperationsException
',
- ' * If the ', $ufn,' does not exist or could not be removed
',
- ' * due to some underlying communication problem.
',
- ' */
')" />
- <xsl:value-of
- select="concat(' void remove',
- $java-relation-name, '() throws OperationsException;
')" />
+ select="concat(' void remove', $java-relation-name, '()
',
+ ' throws ManagedObjectNotFoundException, OperationRejectedException,
',
+ ' ConcurrentModificationException, AuthorizationException,
',
+ ' CommunicationException;
')" />
</xsl:when>
<xsl:when test="adm:one-to-many">
<xsl:variable name="plural-name"
@@ -189,77 +243,117 @@
<xsl:with-param name="value" select="$plural-name" />
</xsl:call-template>
</xsl:variable>
- <xsl:value-of
- select="concat(' /**
',
- ' * Lists the ', $ufpn,'.
',
- ' *
',
- ' * @return Returns an array containing the names of the
',
- ' * ', $ufpn,'.
',
- ' * @throws OperationsException
',
- ' * If the ', $ufpn,' could not be listed due to some
',
- ' * underlying communication problem.
',
- ' */
')" />
+ <xsl:call-template name="add-java-comment2">
+ <xsl:with-param name="indent" select="2" />
+ <xsl:with-param name="content"
+ select="concat('Lists the ', $ufpn,'.
',
+ '
',
+ '@return Returns an array containing the names of the ', $ufpn,'.
',
+ '@throws ConcurrentModificationException
',
+ ' If this ', $this-ufn, ' has been removed from the server by another client.
',
+ '@throws AuthorizationException
',
+ ' If the server refuses to list the ', $ufpn, ' because the client does not have the correct privileges.
',
+ '@throws CommunicationException
',
+ ' If the client cannot contact the server due to an underlying communication problem.')" />
+ </xsl:call-template>
<xsl:value-of
select="concat(' String[] list',
- $java-relation-plural-name, '() throws OperationsException;
')" />
+ $java-relation-plural-name, '() throws ConcurrentModificationException,
',
+ ' AuthorizationException, CommunicationException;
')" />
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
+ <xsl:call-template name="add-java-comment2">
+ <xsl:with-param name="indent" select="2" />
+ <xsl:with-param name="content"
+ select="concat(
+ 'Gets the named ', $ufn, '.
',
+ '
',
+ '@param name
',
+ ' The name of the ', $ufn,' to retrieve.
',
+ '@return Returns the named ', $ufn, '.
',
+ '@throws DefinitionDecodingException
',
+ ' If the named ', $ufn, ' was found but its type could not be determined.
',
+ '@throws ManagedObjectDecodingException
',
+ ' If the named ', $ufn, ' was found but one or more of its properties could not be decoded.
',
+ '@throws ManagedObjectNotFoundException
',
+ ' If the named ', $ufn, ' was not found on the server.
',
+ '@throws ConcurrentModificationException
',
+ ' If this ', $this-ufn, ' has been removed from the server by another client.
',
+ '@throws AuthorizationException
',
+ ' If the server refuses to retrieve the named ', $ufn, ' because the client does not have the correct privileges.
',
+ '@throws CommunicationException
',
+ ' If the client cannot contact the server due to an underlying communication problem.')" />
+ </xsl:call-template>
<xsl:value-of
- select="concat(' /**
',
- ' * Gets the named ', $ufn,'.
',
- ' *
',
- ' * @param name
',
- ' * The name of the ', $ufn,' to retrieve.
',
- ' * @return Returns the named ', $ufn,'.
',
- ' * @throws OperationsException
',
- ' * If the ', $ufn,' does not exist or could not be read
',
- ' * due to some underlying communication problem.
',
- ' */
')" />
- <xsl:value-of
- select="concat(' ', $java-class-name, 'CfgClient get',
- $java-relation-name, '(String name) throws OperationsException;
')" />
+ select="concat(' ', $java-class-name, 'CfgClient get', $java-relation-name, '(String name)
',
+ ' throws DefinitionDecodingException, ManagedObjectDecodingException,
',
+ ' ManagedObjectNotFoundException, ConcurrentModificationException,
',
+ ' AuthorizationException, CommunicationException;
')" />
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
- <xsl:value-of
- select="concat(' /**
',
- ' * Creates a new ', $ufn,'.
',
- ' *
',
- ' * @param <C>
',
- ' * The type of the ', $ufn,' being added.
',
- ' * @param d
',
- ' * The definition of the ', $ufn,' to be created.
',
- ' * @param name
',
- ' * The name of the new ', $ufn,'.
',
- ' * @param p
',
- ' * A property provider which can be used to initialize
',
- ' * the property values of the new ', $ufn,'.
',
- ' * @return Returns a new ', $ufn,' instance representing the
',
- ' * ', $ufn,' that was created.
',
- ' * @throws OperationsException
',
- ' * If the ', $ufn,' already exists or could not be created
',
- ' * due to some underlying communication problem.
',
- ' */
')" />
+ <xsl:call-template name="add-java-comment2">
+ <xsl:with-param name="indent" select="2" />
+ <xsl:with-param name="content"
+ select="concat(
+ 'Creates a new ', $ufn,'.
',
+ '
',
+ '@param <C>
',
+ ' The type of the ', $ufn,' being added.
',
+ '@param d
',
+ ' The definition of the ', $ufn,' to be created.
',
+ '@param name
',
+ ' The name of the new ', $ufn,'.
',
+ '@param p
',
+ ' A property provider which can be used to initialize the property values of the new ', $ufn,'.
',
+ '@return Returns a new ', $ufn,' instance representing the ', $ufn,' that was created.
',
+ '@throws ManagedObjectDecodingException
',
+ ' If the ', $ufn,' could not be created because one or more of its properties are invalid.
',
+ '@throws ManagedObjectAlreadyExistsException
',
+ ' If the ', $ufn,' cannot be created because it already exists on the server.
',
+ '@throws ConcurrentModificationException
',
+ ' If this ', $ufn,' has been removed from the server by another client.
',
+ '@throws OperationRejectedException
',
+ ' If the server refuses to create the ', $ufn,' due to some server-side constraint which cannot be satisfied.
',
+ '@throws AuthorizationException
',
+ ' If the server refuses to create the ', $ufn,' because the client does not have the correct privileges.
',
+ '@throws CommunicationException
',
+ ' If the client cannot contact the server due to an underlying communication problem.
')" />
+ </xsl:call-template>
<xsl:value-of
select="concat(' <C extends ', $java-class-name,'CfgClient> C create', $java-relation-name, '(
',
- ' ManagedObjectDefinition<C, ?> d, String name, PropertyProvider p) throws OperationsException;
')" />
+ ' ManagedObjectDefinition<C, ?> d, String name, PropertyProvider p)
',
+ ' throws ManagedObjectDecodingException, ManagedObjectAlreadyExistsException,
',
+ ' ConcurrentModificationException, OperationRejectedException,
',
+ ' AuthorizationException, CommunicationException;
')" />
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
+ <xsl:call-template name="add-java-comment2">
+ <xsl:with-param name="indent" select="2" />
+ <xsl:with-param name="content"
+ select="concat(
+ 'Removes the named ', $ufn,'.
',
+ '
',
+ '@param name
',
+ ' The name of the ', $ufn,' to remove.
',
+ '@throws ManagedObjectNotFoundException
',
+ ' If the ', $ufn, ' does not exist.
',
+ '@throws OperationRejectedException
',
+ ' If the server refuses to remove the ', $ufn, ' due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
',
+ '@throws ConcurrentModificationException
',
+ ' If this ', $this-ufn, ' has been removed from the server by another client.
',
+ '@throws AuthorizationException
',
+ ' If the server refuses to remove the ', $ufn, ' because the client does not have the correct privileges.
',
+ '@throws CommunicationException
',
+ ' If the client cannot contact the server due to an underlying communication problem.')" />
+ </xsl:call-template>
<xsl:value-of
- select="concat(' /**
',
- ' * Removes the named ', $ufn,'.
',
- ' *
',
- ' * @param name
',
- ' * The name of the ', $ufn,' to remove.
',
- ' * @throws OperationsException
',
- ' * If the ', $ufn,' does not exist or could not be removed
',
- ' * due to some underlying communication problem.
',
- ' */
')" />
- <xsl:value-of
- select="concat(' void remove',
- $java-relation-name, '(String name) throws OperationsException;
')" />
+ select="concat(' void remove', $java-relation-name, '(String name)
',
+ ' throws ManagedObjectNotFoundException, OperationRejectedException,
',
+ ' ConcurrentModificationException, AuthorizationException,
',
+ ' CommunicationException;
')" />
</xsl:when>
<xsl:otherwise>
<xsl:message terminate="yes">
@@ -294,11 +388,34 @@
</import>
</xsl:if>
<xsl:if test="$this-local-relations">
- <import>org.opends.server.admin.OperationsException</import>
+ <import>
+ org.opends.server.admin.DefinitionDecodingException
+ </import>
+ <import>
+ org.opends.server.admin.ManagedObjectNotFoundException
+ </import>
+ <import>
+ org.opends.server.admin.client.ManagedObjectDecodingException
+ </import>
+ <import>
+ org.opends.server.admin.client.ConcurrentModificationException
+ </import>
+ <import>
+ org.opends.server.admin.client.AuthorizationException
+ </import>
+ <import>
+ org.opends.server.admin.client.CommunicationException
+ </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.PropertyProvider</import>
+ <import>
+ org.opends.server.admin.ManagedObjectAlreadyExistsException
+ </import>
+ <import>
+ org.opends.server.admin.client.OperationRejectedException
+ </import>
</xsl:if>
<xsl:choose>
<xsl:when test="$this/@extends">
--
Gitblit v1.10.0