You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by do...@apache.org on 2002/09/07 01:58:32 UTC
cvs commit: jakarta-avalon-site/docs/dtds/phoenix assembly_1.0.dtd blockinfo_1.0.dtd mxinfo_1.0.dtd
donaldp 2002/09/06 16:58:32
Added: docs/dtds componentinfo_1_0.dtd type_1_0.dtd type_1_1.dtd
docs/dtds/phoenix assembly_1.0.dtd blockinfo_1.0.dtd
mxinfo_1.0.dtd
Removed: docs componentinfo_1_0.dtd type_1_0.dtd type_1_1.dtd
Log:
Move all the dtds into a central hierarchy.
Revision Changes Path
1.1 jakarta-avalon-site/docs/dtds/componentinfo_1_0.dtd
Index: componentinfo_1_0.dtd
===================================================================
<!--
This is the DTD defining the Avalon ComponentInfo 1.0
descriptor (XML) file format/syntax.
Author: Peter Donald <peter at apache.org>
A BlockInfo is an XML file used to describe Components and located side-by-side with
the Component .class file. It describes the services the Component requires to operate,
the services the Component is capable of offerring other Component, the context entrys
that Component requires and other support meta data.
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 component-info is the document root, it defines:
component the specifc details about this component
loggers the loggers used by this component
context the context required by this component
services the services offered by this component
dependencies the services that this component require to operate
-->
<!ELEMENT component-info (component, loggers?, context?, services?, dependencies?)>
<!--
!ATTLIST component-info id ID #IMPLIED
xmlns CDATA #FIXED "http://jakarta.apache.org/avalon/componentinfo_1_0.dtd"
-->
<!--
The component element describes the component, it defines:
name the human readable name of component type. Must be a string
containing alphanumeric characters, '.', '_' and starting
with a letter.
version the version of the component in (in the format #.#.#, #.# or # where
# is a integer
-->
<!ELEMENT component (name?,version,attributes?)>
<!ELEMENT name (#PCDATA) >
<!ELEMENT version (#PCDATA) >
<!--
The logger element defines the loggers that are available to component.
The element has one attribute specifying name of Logger. It contains:
attributes Optional attributes about logger
-->
<!ELEMENT logger (attributes?) >
<!ATTLIST logger name CDATA #IMPLIED >
<!--
The context element defines what values and type of context
is available to component.
It contains:
entrys Key value pairs that component uses
attributes Optional attributes about service
-->
<!ELEMENT context (entry*,attributes?) >
<!ATTLIST context type CDATA #IMPLIED >
<!--
The service element defines a service that the component
can provide to other component.
It contains:
service-ref the reference to service.
attributes Optional attributes about service
-->
<!ELEMENT service (service-ref,attributes?) >
<!--
The service element defines a reference to a service that the component
can provide to other component, or this component depends upon.
It defines:
type the name of the service. This must be equal to the class name of the
interface that defines the service.
version the version of the block in (in the format #.#.#, #.# or # where
# is a integer
-->
<!ELEMENT service-ref EMPTY >
<!ATTLIST service-ref
type CDATA #REQUIRED
version CDATA #IMPLIED >
<!--
The service dependency describes a service that the component
requires. It defines:
role the role of the service. This is the value that is used to lookup the
service in the ComponentManager. If not provided it defaults to the
value specified in the name attribute of service element
service-ref the service that is required
-->
<!ELEMENT dependency (role?,service-ref,attributes?) >
<!ATTLIST dependency optional CDATA #IMPLIED >
<!ELEMENT role (#PCDATA) >
<!--
The loggers element contains a list of loggers that component uses.
-->
<!ELEMENT loggers (logger*)>
<!--
The services element contains a list of services that this component supports.
It contains service elements.
-->
<!ELEMENT services (service*)>
<!--
The dependencies element contains a list of services that this component requires.
It contains dependency elements.
-->
<!ELEMENT dependencies (dependency*)>
<!--
The attributes element contains a list of attributes for feature.
-->
<!ELEMENT attributes (attribute*)>
<!--
The attribute element defines an attribute (an opaque key-value pair for a feature).
It defines:
key the key for attribute.
value the value of attribute.
-->
<!ELEMENT attribute (#PCDATA) >
<!ATTLIST attribute
key CDATA #REQUIRED
value CDATA #IMPLIED
>
<!--
The entry element defines entry in context.
It defines:
key the key for entry.
value the value of entry.
optional is entry optional
-->
<!ELEMENT entry EMPTY >
<!ATTLIST entry
key CDATA #REQUIRED
type CDATA #REQUIRED
optional CDATA #IMPLIED
>
1.1 jakarta-avalon-site/docs/dtds/type_1_0.dtd
Index: type_1_0.dtd
===================================================================
<!--
This is the DTD defining the Avalon Meta Model Type 1.0
descriptor (XML) file format/syntax.
Author: Stephen McConnell <mc...@apache.org>
Author: Peter Donald <pe...@apache.org>
An xinfo file is an XML file used to describe Component types and is located side-by-side with
the .class file of the component. It describes the services the component requires to operate
(its dependecies), the services the component is capable of offerring other component, the
context entrys that component requires, logging catagories that the compoent may use, and other
support meta data in the form of attributes.
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 component-info is the document root, it defines:
component the specifc details about this component
loggers the loggers used by this component
context the context required by this component
services the services offered by this component
dependencies the services that this component require to operate
stages the lifecycle stage extensions that this component is depenent on
extensions the lifecycle extensions that this component provides
-->
<!ELEMENT type (component, loggers?, context?, services?, dependencies?, stages?, extensions?)>
<!--
The component element describes the component, it defines:
name the human readable name of component type. Must be a string
containing alphanumeric characters, '.', '_' and starting
with a letter.
version the version of the component in (in the format #.#.#, #.# or # where
# is a integer
-->
<!ELEMENT component (name?,version,attributes?)>
<!ELEMENT name (#PCDATA) >
<!ELEMENT version (#PCDATA) >
<!--
The logger element defines the loggers that are available to component.
The element has one attribute specifying name of Logger. It contains:
attributes Optional attributes about logger
-->
<!ELEMENT logger (attributes?) >
<!ATTLIST logger name CDATA #IMPLIED >
<!--
The context element defines what values and type of context
is available to component.
It contains:
entrys Key value pairs that component uses
attributes Optional attributes about service
-->
<!ELEMENT context (entry*,attributes?) >
<!ATTLIST context type CDATA #IMPLIED >
<!--
The service element defines a service that the component
can provide to other component.
It contains:
reference the reference to service.
attributes Optional attributes about service
-->
<!ENTITY % ref "(service-ref|reference)">
<!ELEMENT service (%ref;,attributes?) >
<!--
The reference element defines a reference to a versioned interface.
It defines:
type the class of the interface. This must be equal to the class name of the
interface.
version the version of the interface in (in the format #.#.#, #.# or # where
# is a integer
-->
<!ELEMENT reference EMPTY >
<!ATTLIST reference
type CDATA #REQUIRED
version CDATA #IMPLIED >
<!--
The extension element defines a lifecycle extension stage supplied by a type:
name the extension name.
reference the version lifecycle interface supported
attributes Optional attributes about the extension
-->
<!ENTITY % stage.attribute "stage (CREATE|ACCESS|RELEASE|DESTROY|ALL|INNER|OUTER) 'ALL'">
<!ELEMENT extension (name,reference,attributes?)>
<!ATTLIST extension
%stage.attribute; >
<!--
The stage element defines a lifecycle extension stage that this component is dependent on.
It contains:
name the stage name.
interface the client stage interface
attributes Optional attributes about the stage
-->
<!ELEMENT stage (reference,attributes?)>
<!--
The stages element contains a list of stages that this component id dependent on.
It contains stage elements.
-->
<!ELEMENT stages (stage*)>
<!--
The extensions element contains a list of extensions that the component provides.
-->
<!ELEMENT extensions (extension*)>
<!--
The service dependency describes a service that the component
requires. It defines:
role the role of the service. This is the value that is used to lookup the
service in the ComponentManager. If not provided it defaults to the
value specified in the name attribute of service element
service-ref the service that is required
-->
<!ELEMENT dependency (role?,%ref;,attributes?) >
<!ATTLIST dependency optional CDATA #IMPLIED >
<!ELEMENT role (#PCDATA) >
<!--
The loggers element contains a list of loggers that component uses.
-->
<!ELEMENT loggers (logger*)>
<!--
The services element contains a list of services that this component supports.
It contains service elements.
-->
<!ELEMENT services (service*)>
<!--
The dependencies element contains a list of services that this component requires.
It contains dependency elements.
-->
<!ELEMENT dependencies (dependency*)>
<!--
The attributes element contains a list of attributes for feature.
-->
<!ELEMENT attributes (attribute*)>
<!--
The attribute element defines an attribute (an opaque key-value pair for a feature).
It defines:
key the key for attribute.
value the value of attribute.
-->
<!ELEMENT attribute EMPTY >
<!ATTLIST attribute
key CDATA #REQUIRED
value CDATA #REQUIRED
>
<!--
The entry element defines entry in context.
It defines:
key the key for entry.
value the value of entry.
optional is entry optional
-->
<!ELEMENT entry EMPTY >
<!ATTLIST entry
key CDATA #REQUIRED
type CDATA #REQUIRED
optional CDATA #IMPLIED
>
1.1 jakarta-avalon-site/docs/dtds/type_1_1.dtd
Index: type_1_1.dtd
===================================================================
<!--
This is the DTD defining the Avalon Meta Model Type 1.0
descriptor (XML) file format/syntax.
Author: Stephen McConnell <mc...@apache.org>
Author: Peter Donald <pe...@apache.org>
An xinfo file is an XML file used to describe component types and is located side-by-side with
the .class file of the component. It describes the services the component requires to operate
(its dependecies), the services the component is capable of offerring other component, the
context entrys that component requires, logging catagories that the compoent may use, stage
depedencies, supplied extension haddlers, and management control points and other support meta
data in the form of attributes.
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.
-->
<!--
A type element is the document root, it defines:
component the specifc details about this component
loggers the loggers used by this component
context the context required by this component
services the services offered by this component
dependencies the services that this component require to operate
stages the lifecycle stage extensions that this component is depenent on
extensions the lifecycle extensions that this component provides
controls the set of management control points
-->
<!ELEMENT type (component, loggers?, context?, services?, dependencies?, stages?, extensions?)>
<!--
The component element describes the component, it defines:
name the human readable name of component type. Must be a string
containing alphanumeric characters, '.', '_' and starting
with a letter.
version the version of the component in (in the format #.#.#, #.# or # where
# is a integer
-->
<!ELEMENT component (name?,version,attributes?)>
<!ELEMENT name (#PCDATA) >
<!ELEMENT version (#PCDATA) >
<!--
The logger element defines the loggers that are available to component.
The element has one attribute specifying name of Logger. It contains:
attributes Optional attributes about logger
-->
<!ELEMENT logger (attributes?) >
<!ATTLIST logger name CDATA #IMPLIED >
<!--
The context element defines what values and type of context
is available to component.
It contains:
entrys Key value pairs that component uses
attributes Optional attributes about service
-->
<!ELEMENT context (entry*,attributes?) >
<!ATTLIST context type CDATA #IMPLIED >
<!--
The service element defines a service that the component
can provide to other component.
It contains:
reference the reference to service.
attributes Optional attributes about service
-->
<!ENTITY % ref "(service-ref|reference)">
<!ELEMENT service (%ref;,attributes?) >
<!--
The reference element defines a reference to a versioned interface.
It defines:
type the class of the interface. This must be equal to the class name of the
interface.
version the version of the interface in (in the format #.#.#, #.# or # where
# is a integer
-->
<!ELEMENT reference EMPTY >
<!ATTLIST reference
type CDATA #REQUIRED
version CDATA #IMPLIED >
<!--
The extension element defines a lifecycle extension stage supplied by a type:
name the extension name.
reference the version lifecycle interface supported
attributes Optional attributes about the extension
-->
<!ENTITY % stage.attribute "stage (CREATE|ACCESS|RELEASE|DESTROY|ALL|INNER|OUTER) 'ALL'">
<!ELEMENT extension (name,reference,attributes?)>
<!ATTLIST extension
%stage.attribute; >
<!--
The control element defines an optional management access point that a component may provide.
It contains:
reference a reference to a version management interface
attributes Optional attributes about the management access point
-->
<!ELEMENT control (reference,attributes?)>
<!--
The controls element contains a list of control elements that this component proivides.
-->
<!ELEMENT controls (control*)>
<!--
The stage element defines a lifecycle extension stage that this component is dependent on.
It contains:
name the stage name.
interface the client stage interface
attributes Optional attributes about the stage
-->
<!ELEMENT stage (reference,attributes?)>
<!--
The stages element contains a list of stages that this component id dependent on.
It contains stage elements.
-->
<!ELEMENT stages (stage*)>
<!--
The extensions element contains a list of extensions that the component provides.
-->
<!ELEMENT extensions (extension*)>
<!--
The service dependency describes a service that the component
requires. It defines:
role the role of the service. This is the value that is used to lookup the
service in the ComponentManager. If not provided it defaults to the
value specified in the name attribute of service element
service-ref the service that is required
-->
<!ELEMENT dependency (role?,%ref;,attributes?) >
<!ATTLIST dependency optional CDATA #IMPLIED >
<!ELEMENT role (#PCDATA) >
<!--
The loggers element contains a list of loggers that component uses.
-->
<!ELEMENT loggers (logger*)>
<!--
The services element contains a list of services that this component supports.
It contains service elements.
-->
<!ELEMENT services (service*)>
<!--
The dependencies element contains a list of services that this component requires.
It contains dependency elements.
-->
<!ELEMENT dependencies (dependency*)>
<!--
The attributes element contains a list of attributes for feature.
-->
<!ELEMENT attributes (attribute*)>
<!--
The attribute element defines an attribute (an opaque key-value pair for a feature).
It defines:
key the key for attribute.
value the value of attribute.
-->
<!ELEMENT attribute EMPTY >
<!ATTLIST attribute
key CDATA #REQUIRED
value CDATA #REQUIRED
>
<!--
The entry element defines entry in context.
It defines:
key the key for entry.
value the value of entry.
optional is entry optional
-->
<!ELEMENT entry EMPTY >
<!ATTLIST entry
key CDATA #REQUIRED
type CDATA #REQUIRED
optional CDATA #IMPLIED
>
1.1 jakarta-avalon-site/docs/dtds/phoenix/assembly_1.0.dtd
Index: assembly_1.0.dtd
===================================================================
<!--
This is the DTD defining the Phoenix Assembly 1.0
descriptor (XML) file format/syntax.
Author: Peter Donald <peter at apache.org>
The assembly.xml file is used to define which blocks are instantiated and how
they are linked together in an application.
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 assembly is the document root, it defines:
block a block that exists in the application
block-listener a listener that exists in the application
-->
<!ELEMENT assembly (block|block-listener|listener)*>
<!ATTLIST assembly id ID #IMPLIED
xmlns CDATA #FIXED "http://jakarta.apache.org/avalon/dtds/phoenix/assembly_1_0.dtd" >
<!--
The block element declares a block exists in the application.
The element defines:
name the name of a block
class the class of block instance
provide declare that particular blocks that will provide
the block with particular services
proxy TODO:description
-->
<!ELEMENT block (provide*,proxy?)>
<!ATTLIST block class CDATA #REQUIRED>
<!ATTLIST block name CDATA #REQUIRED>
<!--
The provide element declares that a specific service is provided to the block
by another block. The provide element defines:
role the name of the service that is being provided (aka the role of service)
name the name of the block that will provide service
-->
<!ELEMENT provide EMPTY>
<!ATTLIST provide role CDATA #REQUIRED>
<!ATTLIST provide name CDATA #REQUIRED>
<!--
TODO:description
disable TODO:description
-->
<!ELEMENT proxy EMPTY>
<!ATTLIST proxy disable CDATA #REQUIRED>
<!--
The block element declares a listener exists in the application.
The element defines:
name the name of the listener
class the class of the listener instance
-->
<!ELEMENT listener EMPTY>
<!ATTLIST listener name CDATA #REQUIRED>
<!ATTLIST listener class CDATA #REQUIRED>
<!--
NOTE: This form is DEPRECATED.
The block element declares a block listener exists in the application.
The element defines:
name the name of the listener
class the class of the listener instance
-->
<!ELEMENT block-listener EMPTY>
<!ATTLIST block-listener name CDATA #REQUIRED>
<!ATTLIST block-listener class CDATA #REQUIRED>
1.1 jakarta-avalon-site/docs/dtds/phoenix/blockinfo_1.0.dtd
Index: blockinfo_1.0.dtd
===================================================================
<!--
This is the DTD defining the Phoenix BlockInfo 1.0
descriptor (XML) file format/syntax.
Author: Peter Donald <peter at apache.org>
A BlockInfo is an XML file used to describe Blocks and located side-by-side with
the Block .class file. It describes the services the Block requires to operate,
the services the Block is capable of offerring other Blocks and other support
meta data.
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 blockinfo is the document root, it defines:
block the specifc details about this block
services the services offered by this block
dependencies the services that this block require to operate
-->
<!ELEMENT blockinfo (block, services?, management-access-points?, dependencies?)>
<!ATTLIST blockinfo id ID #IMPLIED
xmlns CDATA #FIXED "http://jakarta.apache.org/avalon/dtds/phoenix/blockinfo_1_0.dtd" >
<!--
The block element describes the block, it defines:
name the human readable name of block type. Must be a string
containing alphanumeric characters, '.', '_' and starting
with a letter.
version the version of the block in (in the format #.#.#, #.# or # where
# is a integer
schema-type string representing the type of schema information available
to validate block configuration
-->
<!ELEMENT block (name?,version)>
<!ELEMENT name (#PCDATA) >
<!ELEMENT version (#PCDATA) >
<!ELEMENT schema-type (#PCDATA) >
<!--
The service element describes a service that the block
can provide to other blocks, or this block depends upon.
It defines:
name the name of the service. This must be equal to the class name of the
interface that defines the service.
version the version of the block in (in the format #.#.#, #.# or # where
# is a integer
-->
<!ELEMENT service EMPTY >
<!ATTLIST service
name CDATA #REQUIRED
version CDATA #IMPLIED
>
<!--
The service dependency describes a service that the block
requires. It defines:
role the role of the service. This is the value that is used to lookup the
service in the ComponentManager. If not provided it defaults to the
value specified in the name attribute of service element
service the service that is required
-->
<!ELEMENT dependency (role?,service) >
<!ELEMENT role (#PCDATA) >
<!--
The services element contains a list of services that this Block supports.
It contains service elements.
-->
<!ELEMENT services (service*)>
<!--
The services element contains a list of services that this
Block exports to the Management system. It contains service
elements.
-->
<!ELEMENT management-access-points (service*)>
<!--
The dependencies element contains a list of services that this Block requires.
It contains dependency elements.
-->
<!ELEMENT dependencies (dependency*)>
1.1 jakarta-avalon-site/docs/dtds/phoenix/mxinfo_1.0.dtd
Index: mxinfo_1.0.dtd
===================================================================
<!--
This is the DTD defining the Phoenix MxInfo 1.0
descriptor (XML) file format/syntax.
Author: Huw Roberts <huw*apache.org>
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*,proxy*)>
<!ATTLIST mxinfo id ID #IMPLIED
xmlns CDATA #FIXED "http://jakarta.apache.org/avalon/dtds/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 a proxy class to be used for management. The proxy class must have a constructor that takes an
java.lang.Object as its only parameter that is the object to managed.
It defines:
name the name of the proxy class. it will be instantiated and passed an instance of the class to be used for
management.
-->
<!ELEMENT proxy EMPTY >
<!ATTLIST proxy
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: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>