| <?xml version="1.0" encoding="UTF-8"?> |
| |
| <!-- |
| JBoss, Home of Professional Open Source Copyright 2008, Red Hat |
| Middleware LLC, and individual contributors by the @authors tag. |
| See the copyright.txt in the distribution for a full listing of |
| individual contributors. Licensed under the Apache License, |
| Version 2.0 (the "License"); you may not use this file except in |
| compliance with the License. You may obtain a copy of the License |
| at http://www.apache.org/licenses/LICENSE-2.0 Unless required by |
| applicable law or agreed to in writing, software distributed under |
| the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES |
| OR CONDITIONS OF ANY KIND, either express or implied. See the |
| License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| |
| <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" |
| elementFormDefault="qualified" |
| targetNamespace="http://xmlns.jcp.org/xml/ns/javaee" |
| xmlns:javaee="http://xmlns.jcp.org/xml/ns/javaee" |
| version="1.1"> |
| |
| <xs:annotation> |
| <xs:documentation> |
| <![CDATA[[ |
| Contexts and Dependency Injection (CDI) defines |
| a set of complementary services that help improve the structure |
| of application code. beans.xml is used to enable CDI services |
| for the current bean archive as well as to enable named |
| interceptors, decorators and alternatives for the current bean |
| archive. |
| |
| |
| This is the XML Schema for the beans.xml deployment |
| descriptor for CDI 1.1. The deployment descriptor must be named |
| "META-INF/beans.xml" or "WEB-INF/beans.xml" in a war file. |
| All application deployment descriptors may indicate |
| the application schema by using the Java EE namespace: |
| |
| http://xmlns.jcp.org/xml/ns/javaee |
| |
| and may indicate the version of the schema by |
| using the version element as shown below: |
| |
| <beans xmlns="http://xmlns.jcp.org/xml/ns/javaee" |
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee |
| http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd" |
| version="1.1"> |
| ... |
| </beans> |
| |
| The deployment descriptor may indicate the published version of |
| the schema using the xsi:schemaLocation attribute for the Java EE |
| namespace with the following location: |
| |
| http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd |
| |
| ]]> |
| </xs:documentation> |
| </xs:annotation> |
| |
| <xs:element name="beans"> |
| <xs:annotation> |
| <xs:documentation> |
| Bean classes of enabled beans must be |
| deployed in bean archives. A library jar, EJB jar, |
| application client jar or rar archive is a bean archive if |
| it has a file named beans.xml in the META-INF directory. The |
| WEB-INF/classes directory of a war is a bean archive if |
| there is a file named beans.xml in the WEB-INF directory of |
| the war. A directory in the JVM classpath is a bean archive |
| if it has a file named beans.xml in the META-INF directory. |
| </xs:documentation> |
| </xs:annotation> |
| <xs:complexType> |
| <xs:choice minOccurs="0" maxOccurs="unbounded"> |
| <xs:element ref="javaee:interceptors" /> |
| <xs:element ref="javaee:decorators" /> |
| <xs:element ref="javaee:alternatives" /> |
| <xs:element ref="javaee:scan" /> |
| <xs:any namespace="##other" processContents="lax"/> |
| </xs:choice> |
| <xs:attribute name="version" default="1.1"> |
| <xs:annotation> |
| <xs:documentation> |
| The version of CDI this beans.xml is for. If the version is "1.1" (or |
| later), then the attribute bean-discovery-mode must be added. |
| </xs:documentation> |
| </xs:annotation> |
| <xs:simpleType> |
| <xs:restriction base="xs:token"> |
| <xs:pattern value="\.?[0-9]+(\.[0-9]+)*"/> |
| </xs:restriction> |
| </xs:simpleType> |
| </xs:attribute> |
| <xs:attribute name="bean-discovery-mode" use="required"> |
| <xs:annotation> |
| <xs:documentation> |
| It is strongly recommended you use "annotated". |
| |
| If the bean discovery mode is "all", then all types in this |
| archive will be considered. If the bean discovery mode is |
| "annotated", then only those types with bean defining annotations will be |
| considered. If the bean discovery mode is "none", then no |
| types will be considered. |
| </xs:documentation> |
| </xs:annotation> |
| <xs:simpleType> |
| <xs:restriction base="xs:string"> |
| <xs:enumeration value="annotated"> |
| <xs:annotation> |
| <xs:documentation> |
| Only those types with bean defining annotations will be |
| considered. |
| </xs:documentation> |
| </xs:annotation> |
| </xs:enumeration> |
| <xs:enumeration value="all"> |
| <xs:annotation> |
| <xs:documentation> |
| All types in this archive will be considered. |
| </xs:documentation> |
| </xs:annotation> |
| </xs:enumeration> |
| <xs:enumeration value="none"> |
| <xs:annotation> |
| <xs:documentation> |
| This archive will be ignored. |
| </xs:documentation> |
| </xs:annotation> |
| </xs:enumeration> |
| </xs:restriction> |
| </xs:simpleType> |
| </xs:attribute> |
| </xs:complexType> |
| </xs:element> |
| |
| <xs:element name="scan"> |
| <xs:annotation> |
| <xs:documentation> |
| |
| </xs:documentation> |
| </xs:annotation> |
| <xs:complexType> |
| <xs:sequence maxOccurs="unbounded" minOccurs="0"> |
| <xs:element name="exclude"> |
| <xs:annotation> |
| <xs:documentation> |
| |
| </xs:documentation> |
| </xs:annotation> |
| <xs:complexType> |
| <xs:choice maxOccurs="unbounded" minOccurs="0"> |
| <xs:element name="if-class-available"> |
| <xs:annotation> |
| <xs:documentation> |
| |
| </xs:documentation> |
| </xs:annotation> |
| <xs:complexType> |
| <xs:attribute name="name" type="xs:string" use="required"> |
| <xs:annotation> |
| <xs:documentation> |
| |
| </xs:documentation> |
| </xs:annotation> |
| </xs:attribute> |
| </xs:complexType> |
| </xs:element> |
| <xs:element name="if-system-property"> |
| <xs:annotation> |
| <xs:documentation> |
| |
| </xs:documentation> |
| </xs:annotation> |
| <xs:complexType> |
| <xs:attribute name="name" type="xs:string" use="required"> |
| <xs:annotation> |
| <xs:documentation> |
| |
| </xs:documentation> |
| </xs:annotation> |
| </xs:attribute> |
| <xs:attribute name="value" type="xs:string" use="optional"> |
| <xs:annotation> |
| <xs:documentation> |
| |
| </xs:documentation> |
| </xs:annotation> |
| </xs:attribute> |
| </xs:complexType> |
| </xs:element> |
| </xs:choice> |
| <xs:attribute name="name" use="required"> |
| <xs:annotation> |
| <xs:documentation> |
| |
| </xs:documentation> |
| </xs:annotation> |
| <xs:simpleType> |
| <xs:restriction base="xs:string"> |
| <xs:pattern value="([a-zA-Z_$][a-zA-Z\d_$]*\.)*([a-zA-Z_$][a-zA-Z\d_$]*|\*|\*\*)" /> |
| </xs:restriction> |
| </xs:simpleType> |
| </xs:attribute> |
| </xs:complexType> |
| </xs:element> |
| </xs:sequence> |
| </xs:complexType> |
| </xs:element> |
| |
| <xs:element name="interceptors"> |
| <xs:annotation> |
| <xs:documentation> |
| By default, a bean archive has no enabled |
| interceptors bound via interceptor bindings. An interceptor |
| must be explicitly enabled by listing its class under the |
| <interceptors> element of the beans.xml file of the |
| bean archive. The order of the interceptor declarations |
| determines the interceptor ordering. Interceptors which |
| occur earlier in the list are called first. If the same |
| class is listed twice under the <interceptors> |
| element, the container automatically detects the problem and |
| treats it as a deployment problem. |
| </xs:documentation> |
| </xs:annotation> |
| <xs:complexType> |
| <xs:choice minOccurs="0" maxOccurs="unbounded"> |
| <xs:element name="class" type="xs:string"> |
| <xs:annotation> |
| <xs:documentation> |
| Each child <class> element |
| must specify the name of an interceptor class. If |
| there is no class with the specified name, or if |
| the class with the specified name is not an |
| interceptor class, the container automatically |
| detects the problem and treats it as a deployment |
| problem. |
| </xs:documentation> |
| </xs:annotation> |
| </xs:element> |
| </xs:choice> |
| </xs:complexType> |
| </xs:element> |
| |
| <xs:element name="decorators"> |
| <xs:annotation> |
| <xs:documentation> |
| By default, a bean archive has no enabled |
| decorators. A decorator must be explicitly enabled by |
| listing its bean class under the <decorators> element |
| of the beans.xml file of the bean archive. The order of the |
| decorator declarations determines the decorator ordering. |
| Decorators which occur earlier in the list are called first. |
| If the same class is listed twice under the |
| <decorators> element, the container automatically |
| detects the problem and treats it as a deployment problem. |
| </xs:documentation> |
| </xs:annotation> |
| <xs:complexType> |
| <xs:choice minOccurs="0" maxOccurs="unbounded"> |
| <xs:element name="class" type="xs:string"> |
| <xs:annotation> |
| <xs:documentation> |
| Each child <class> element |
| must specify the name of a decorator class. If |
| there is no class with the specified name, or if |
| the class with the specified name is not a |
| decorator class, the container automatically |
| detects the problem and treats it as a deployment |
| problem. |
| </xs:documentation> |
| </xs:annotation> |
| </xs:element> |
| </xs:choice> |
| </xs:complexType> |
| </xs:element> |
| |
| <xs:element name="alternatives"> |
| <xs:annotation> |
| <xs:documentation> |
| An alternative is a bean that must be |
| explicitly declared in the beans.xml file if it should be |
| available for lookup, injection or EL resolution. By |
| default, a bean archive has no selected alternatives. An |
| alternative must be explicitly declared using the |
| <alternatives> element of the beans.xml file of the |
| bean archive. The <alternatives> element contains a |
| list of bean classes and stereotypes. An alternative is |
| selected for the bean archive if either: the alternative is |
| a managed bean or session bean and the bean class of the |
| bean is listed, or the alternative is a producer method, |
| field or resource, and the bean class that declares the |
| method or field is listed, or any @Alternative stereotype of |
| the alternative is listed. |
| </xs:documentation> |
| </xs:annotation> |
| <xs:complexType> |
| <xs:choice minOccurs="0" maxOccurs="unbounded"> |
| <xs:element name="class" type="xs:string"> |
| <xs:annotation> |
| <xs:documentation> |
| Each child <class> element |
| must specify the name of an alternative bean class. |
| If there is no class with the specified name, or if |
| the class with the specified name is not an |
| alternative bean class, the container automatically |
| detects the problem and treats it as a deployment |
| problem. If the same class is listed twice under |
| the <alternatives> element, the container |
| automatically detects the problem and treats it as |
| a deployment problem. |
| </xs:documentation> |
| </xs:annotation> |
| </xs:element> |
| |
| <xs:element name="stereotype" type="xs:string"> |
| <xs:annotation> |
| <xs:documentation> |
| Each child <stereotype> |
| element must specify the name of an @Alternative |
| stereotype annotation. If there is no annotation |
| with the specified name, or the annotation is not |
| an @Alternative stereotype, the container |
| automatically detects the problem and treats it as |
| a deployment problem. If the same stereotype is |
| listed twice under the <alternatives> |
| element, the container automatically detects the |
| problem and treats it as a deployment problem. |
| </xs:documentation> |
| </xs:annotation> |
| </xs:element> |
| </xs:choice> |
| </xs:complexType> |
| </xs:element> |
| |
| </xs:schema> |