All Downloads are FREE. Search and download functionalities are using the official Maven repository.

schema.connector_2_0.xsd Maven / Gradle / Ivy

There is a newer version: 3.0.10.Final
Show newest version


    
        Copyright (c) 2009, 2020 Oracle and/or its affiliates.
            All rights reserved. This program and the accompanying materials are made
            available under the terms of the Eclipse Public License v. 2.0, which is
            available at http://www.eclipse.org/legal/epl-2.0. This Source Code may
            also be made available under the following Secondary Licenses when the
            conditions for such availability set forth in the Eclipse Public License v.
            2.0 are satisfied: GNU General Public License, version 2 with the GNU
            Classpath Exception, which is available at
            https://www.gnu.org/software/classpath/license.html.
            SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH
            Classpath-exception-2.0
    
    
        
            
      ...
      

      The instance documents may indicate the published version of
      the schema using the xsi:schemaLocation attribute for Jakarta EE
      namespace with the following location:

      https://jakarta.ee/xml/ns/jakartaee/connector_2_0.xsd

      ]]>
        
    
    
        The following conventions apply to all Jakarta EE
            deployment descriptor elements unless indicated otherwise. - In elements
            that specify a pathname to a file within the same JAR file, relative
            filenames (i.e., those not starting with "/") are considered relative to
            the root of the JAR file's namespace. Absolute filenames (i.e., those
            starting with "/") also specify names in the root of the JAR file's
            namespace. In general, relative names are preferred. The exception is .war
            files where absolute names are preferred for consistency with the Servlet
            API.
    
    
    
    
        
            The connector element is the root element of the
                deployment descriptor for the resource adapter. This element includes
                general information - vendor name, resource adapter version, icon - about
                the resource adapter module. It also includes information specific to the
                implementation of the resource adapter library as specified through the
                element resourceadapter.
        
    
    
    
        
            The activationspecType specifies an activation
                specification. The information includes fully qualified Java class name
                of an activation specification and a set of required configuration
                property names.
        
        
            
                
                    
                        com.wombat.ActivationSpecImpl
                  

            ]]>
                    
                
            
            
                
                    The required-config-property element is deprecated
                        since Connectors 1.6 specification. The resource adapter
                        implementation is recommended to use the @NotNull Bean Validation
                        annotation or its XML validation descriptor equivalent to indicate
                        that a configuration property is required to be specified by the
                        deployer. See the Jakarta Connectors specification for more
                        information.
                
            
            
        
        
    
    
    
        
            The adminobjectType specifies information about an
                administered object. Administered objects are specific to a messaging
                style or message provider. This contains information on the Java type of
                the interface implemented by an administered object, its Java class name
                and its configuration properties.
        
        
            
                
                    
                        jakarta.jms.Destination
                

            ]]>
                    
                
            
            
                
                    
                        com.wombat.DestinationImpl
                  

            ]]>
                    
                
            
            
        
        
    
    
    
        
            The authentication-mechanismType specifies an
                authentication mechanism supported by the resource adapter. Note that
                this support is for the resource adapter and not for the underlying EIS
                instance. The optional description specifies any resource adapter
                specific requirement for the support of security contract and
                authentication mechanism. Note that BasicPassword mechanism type should
                support the jakarta.resource.spi.security.PasswordCredential interface.
                The Kerbv5 mechanism type should support the org.ietf.jgss.GSSCredential
                interface or the deprecated
                jakarta.resource.spi.security.GenericCredential
                interface.
        
        
            
            
                
                    
                        BasicPassword
            

            Kerbv5
            

            Any additional security mechanisms are outside the
            scope of the Jakarta Connectors architecture specification.

            ]]>
                    
                
            
            
        
        
    
    
    
        
            
                ServerName

        ]]>
            
        
        
            
        
    
    
    
        
            
                java.lang.String

        ]]>
            
        
        
            
                
                
                
                
                
                
                
                
                
            
        
    
    
    
        
            The config-propertyType contains a declaration of a
                single configuration property that may be used for providing
                configuration information. The declaration consists of an optional
                description, name, type and an optional value of the configuration
                property. If the resource adapter provider does not specify a value than
                the deployer is responsible for providing a valid value for a
                configuration property. Any bounds or well-defined values of properties
                should be described in the description element.
        
        
            
            
            
            
                
                    
                        WombatServer

            ]]>
                    
                
            
            
                
                    The element config-property-ignore is used to
                        specify whether the configuration tools must ignore considering the
                        configuration property during auto-discovery of Configuration
                        properties. See the Jakarta Connectors specification for more
                        details. If unspecified, the container must not ignore the
                        configuration property during auto-discovery. This element must be
                        one of the following, "true" or "false".
                
            
            
                
                    The element
                        config-property-supports-dynamic-updates is used to specify whether
                        the configuration property allows its value to be updated, by
                        application server's configuration tools, during the lifetime of the
                        JavaBean instance. See the Jakarta Connectors specification for more
                        details. If unspecified, the container must not dynamically
                        reconfigure the property. This element must be one of the following,
                        "true" or "false".
                
            
            
                
                    The element config-property-confidential is used
                        to specify whether the configuration property is confidential and
                        recommends application server's configuration tools to use special
                        visual aids for editing them. See the Jakarta Connectors
                        specification for more details. If unspecified, the container must
                        not treat the property as confidential. This element must be one of
                        the following, "true" or "false".
                
            
        
        
    
    
    
        
            The connection-definitionType defines a set of
                connection interfaces and classes pertaining to a particular connection
                type. This also includes configurable properties for
                ManagedConnectionFactory instances that may be produced out of this
                set.
        
        
            
                
                    
                        
                  com.wombat.ManagedConnectionFactoryImpl
            

            ]]>
                    
                
            
            
            
                
                    
                        com.wombat.ConnectionFactory
            

            OR

            jakarta.resource.cci.ConnectionFactory
            

            ]]>
                    
                
            
            
                
                    
                        com.wombat.ConnectionFactoryImpl
            

            ]]>
                    
                
            
            
                
                    
                        jakarta.resource.cci.Connection
                  

            ]]>
                    
                
            
            
                
                    
                        com.wombat.ConnectionImpl
                  

            ]]>
                    
                
            
        
        
    
    
    
        
            The connectorType defines a resource
                adapter.
        
        
            
                
                    The element module-name specifies the name of the
                        resource adapter. If there is no module-name specified, the
                        module-name is determined as defined in Section EE.8.1.1 and EE.8.1.2
                        of the Java Platform, Enterprise Edition (Jakarta EE) Specification,
                        version 6.
                
            
            
            
                
                    The element vendor-name specifies the name of
                        resource adapter provider vendor. If there is no vendor-name
                        specified, the application server must consider the default "" (empty
                        string) as the name of the resource adapter provider
                        vendor.
                
            
            
                
                    The element eis-type contains information about
                        the type of the EIS. For example, the type of an EIS can be product
                        name of EIS independent of any version info. This helps in
                        identifying EIS instances that can be used with this resource
                        adapter. If there is no eis-type specified, the application server
                        must consider the default "" (empty string) as the type of the
                        EIS.
                
            
            
                
                    The element resourceadapter-version specifies a
                        string-based version of the resource adapter from the resource
                        adapter provider. If there is no resourceadapter-version specified,
                        the application server must consider the default "" (empty string) as
                        the version of the resource adapter.
                
            
            
            
            
                
                    The element required-work-context specifies a
                        fully qualified class name that implements WorkContext interface,
                        that the resource adapter requires the application server to
                        support.
                
            
        
        
            
                The version indicates the version of the schema to
                    be used by the deployment tool. This element doesn't have a default,
                    and the resource adapter developer/deployer is required to specify it.
                    The element allows the deployment tool to choose which schema to
                    validate the descriptor against.
            
        
        
            
                The metadata-complete attribute defines whether the
                    deployment descriptor for the resource adapter module is complete, or
                    whether the class files available to the module and packaged with the
                    resource adapter should be examined for annotations that specify
                    deployment information. If metadata-complete is set to "true", the
                    deployment tool of the application server must ignore any annotations
                    that specify deployment information, which might be present in the
                    class files of the application.If metadata-complete is not specified or
                    is set to "false", the deployment tool must examine the class files of
                    the application for annotations, as specified by this specification. If
                    the deployment descriptor is not included or is included but not marked
                    metadata-complete, the deployment tool will process annotations.
                    Application servers must assume that metadata-complete is true for
                    resource adapter modules with deployment descriptor version lower than
                    1.6.
            
        
        
    
    
    
        
            The credential-interfaceType specifies the interface
                that the resource adapter implementation supports for the representation
                of the credentials. This element(s) that use this type, i.e.
                credential-interface, should be used by application server to find out
                the Credential interface it should use as part of the security contract.
                The possible values are: jakarta.resource.spi.security.PasswordCredential
                org.ietf.jgss.GSSCredential
                jakarta.resource.spi.security.GenericCredential
        
        
            
                
                
                
            
        
    
    
    
        
            The inbound-resourceadapterType specifies information
                about an inbound resource adapter. This contains information specific to
                the implementation of the resource adapter library as specified through
                the messageadapter element.
        
        
            
                
                    
                        The messagelistener-type element content must be
                            unique in the messageadapter. Several messagelisteners can not use
                            the same messagelistener-type.
                    
                    
                    
                
            
        
        
    
    
    
        
            The licenseType specifies licensing requirements for
                the resource adapter module. This type specifies whether a license is
                required to deploy and use this resource adapter, and an optional
                description of the licensing terms (examples: duration of license, number
                of connection restrictions). It is used by the license
                element.
        
        
            
            
                
                    The element license-required specifies whether a
                        license is required to deploy and use the resource adapter. This
                        element must be one of the following, "true" or
                        "false".
                
            
        
        
    
    
    
        
            The messageadapterType specifies information about the
                messaging capabilities of the resource adapter. This contains information
                specific to the implementation of the resource adapter library as
                specified through the messagelistener element.
        
        
            
        
        
    
    
    
        
            The messagelistenerType specifies information about a
                specific message listener supported by the messaging resource adapter. It
                contains information on the Java type of the message listener interface
                and an activation specification.
        
        
            
                
                    
                        jakarta.jms.MessageListener
                

            ]]>
                    
                
            
            
        
        
    
    
    
        
            The outbound-resourceadapterType specifies information
                about an outbound resource adapter. The information includes fully
                qualified names of classes/interfaces required as part of the connector
                architecture specified contracts for connection management, level of
                transaction support provided, one or more authentication mechanisms
                supported and additional required security permissions. If any of the
                outbound resource adapter elements (transaction-support,
                authentication-mechanism, reauthentication-support) is specified through
                this element or metadata annotations, and no connection-definition is
                specified as part of this element or through annotations, the application
                server must consider this an error and fail deployment. If there is no
                authentication-mechanism specified as part of this element or metadata
                annotations, then the resource adapter does not support any standard
                security authentication mechanisms as part of security contract. The
                application server ignores the security part of the system contracts in
                this case. If there is no transaction-support specified as part of this
                element or metadata annotation, then the application server must consider
                that the resource adapter does not support either the resource manager
                local or Jakarta Transactions transactions and must consider the
                transaction support as NoTransaction. Note that resource adapters may
                specify the level of transaction support to be used at runtime for a
                ManagedConnectionFactory through the TransactionSupport interface. If
                there is no reauthentication-support specified as part of this element or
                metadata annotation, then the application server must consider that the
                resource adapter does not support re-authentication of
                ManagedConnections.
        
        
            
            
            
            
                
                    The element reauthentication-support specifies
                        whether the resource adapter implementation supports
                        re-authentication of existing Managed- Connection instance. Note that
                        this information is for the resource adapter implementation and not
                        for the underlying EIS instance. This element must have either a
                        "true" or "false" value.
                
            
        
        
    
    
    
        
            
                
        Destination
        

        ]]>
            
        
        
            
            
        
        
    
    
    
        
            The resourceadapterType specifies information about
                the resource adapter. The information includes fully qualified resource
                adapter Java class name, configuration properties, information specific
                to the implementation of the resource adapter library as specified
                through the outbound-resourceadapter and inbound-resourceadapter
                elements, and an optional set of administered
                objects.
        
        
            
                
                    The element resourceadapter-class specifies the
                        fully qualified name of a Java class that implements the
                        jakarta.resource.spi.ResourceAdapter interface. This Java class is
                        provided as part of resource adapter's implementation of connector
                        architecture specified contracts. The implementation of this class is
                        required to be a JavaBean.
                
            
            
            
                
                    
                        The connectionfactory-interface element content
                            must be unique in the outbound-resourceadapter. Multiple
                            connection-definitions can not use the same
                            connectionfactory-type.
                    
                    
                    
                
            
            
            
                
                    
                        The adminobject-interface and adminobject-class
                            element content must be unique in the resourceadapterType. Several
                            admin objects can not use the same adminobject-interface and
                            adminobject-class.
                    
                    
                    
                    
                
            
            
        
        
    
    
    
        
            The security-permissionType specifies a security
                permission that is required by the resource adapter code. The security
                permission listed in the deployment descriptor are ones that are
                different from those required by the default permission set as specified
                in the connector specification. The optional description can mention
                specific reason that resource adapter requires a given security
                permission.
        
        
            
            
                
                    The element security-permission-spec specifies a
                        security permission based on the Security policy file syntax. Refer
                        to the following URL for Sun's implementation of the security
                        permission specification:
                        http://docs.oracle.com/javase/6/docs/technotes/guides/security/PolicyFiles.html
                
            
        
        
    




© 2015 - 2024 Weber Informatics LLC | Privacy Policy