Mailing-List: contact avalon-cvs-help@jakarta.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Avalon Developers List" <avalon-dev@jakarta.apache.org>
Date: 30 Jul 2002 12:27:48 -0000
Message-ID: <20020730122748.26949.qmail@icarus.apache.org>
From: donaldp@apache.org
To: jakarta-avalon-phoenix-cvs@apache.org
Subject: cvs commit: jakarta-avalon-phoenix/src/schema mxinfo.dtd

donaldp     2002/07/30 05:27:48

  Added:       src/schema mxinfo.dtd
  Log:
  Add in basic DTD for MXInfo stuff.
  
  Submitted by: Huw Roberts <Huw@mmlive.com>
  
  Revision  Changes    Path
  1.1                  jakarta-avalon-phoenix/src/schema/mxinfo.dtd
  
  Index: mxinfo.dtd
  ===================================================================
  <!--
  
     This is the DTD defining the Phoenix MxInfo 1.0
     descriptor (XML) file format/syntax.
  
     Author: Huw Roberts <huw@mmlive.com>
  
     An MxInfo is an XML file used to describe the management info for Blocks
     and other manageable resources.  It is located side-by-side with the 
     managed .class file.  It describes the operations and attributes that can
     bes used to manage the object.
  
     Copyright (C) The Apache Software Foundation. All rights reserved.
  
     This software is published under the terms of the Apache Software License
     version 1.1, a copy of which has been included  with this distribution in
     the LICENSE.txt file.
  
    -->
  
  <!--
  
  The mxinfo is the document root, it defines one or more management topics.
  
  -->
  <!ELEMENT mxinfo (topic+)>
  <!ATTLIST mxinfo id ID #IMPLIED
            xmlns CDATA #FIXED "http://jakarta.apache.org/phoenix/mxinfo_1_0.dtd" >
  
  <!--
  The topic element describes a set of attributes and operations relating to a
  particular aspect of the managed objects manageability.
  
  It defines:
  
  name	     the human readable name of the type.  Must be a string
               containing alphanumeric characters, '.', '_' and starting
               with a letter.
  
  -->
  <!ELEMENT topic          (attribute*, operation*)>
    <!ATTLIST topic
         name CDATA #REQUIRED
    >
  
  <!--
  an element defining an attribute that can be get and/or set on the 
  managed object.
  
  It defines:
  
  name         the name of the attribute. This must be equal the name of the attribute
               in the managed class, following the usual get/set conventions.
  description  a human friendly description of the attribute.
  type         (optional) the class returned by the method.
  isReadable   (optional) whether or not the value of the attribute can be get.  
  isWriteable  (optional) whether or not the value of the attribute can be set.  
  isIs         (optional) whether or not the attibute is accessed with a method of the
               syntax 'isAttributeName'.  If omitted it will be determined through
               introspection of the class.
  
  -->
  <!ELEMENT attribute   EMPTY >
    <!ATTLIST attribute
         name         CDATA #REQUIRED
         description  CDATA #IMPLIED
         type         CDATA #IMPLIED
         isReadable   (yes|no) #IMPLIED
         isWriteable  (yes|no) #IMPLIED
         isIs         (yes|no) #IMPLIED
    >
   
  <!--
  An element defining a method that can be called on the managed object.
  
  It defines:
  
  name         the name of the operation. This must be the name of method in 
               the managed class.
  description  a human friendly description of the operation
  type         (optional) the return value of the method
  -->
  <!ELEMENT operation   (param*) >
    <!ATTLIST operation
         name         CDATA #REQUIRED
         description  CDATA #IMPLIED
         type         CDATA #IMPLIED
    >
  
  <!--
  An element defining a parameter of a method.
  
  It defines:
  
  name         the name of the service. This must be equal to the class name of the
               interface that defines the service.
  description  a human friendly description of the operation
  type         (optional) the class of the attribute.  this is for information purposes
               only, it will be determined by introspection during initialization.
  -->
  <!ELEMENT param   EMPTY >
    <!ATTLIST param
         name         CDATA #REQUIRED
         description  CDATA #IMPLIED
         type         CDATA #IMPLIED
    >
  
  
  
  

--
To unsubscribe, e-mail:   <mailto:avalon-cvs-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-cvs-help@jakarta.apache.org>