Appendix A. Spring Data Redis Schema(s)
Prev | Part III. Appendixes |

## Appendix A. Spring Data Redis Schema(s)

Core schema

    <?xml version="1.0" encoding="UTF-8"?>

    <xsd:schema xmlns="http://www.springframework.org/schema/redis"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:tool="http://www.springframework.org/schema/tool"
        targetNamespace="http://www.springframework.org/schema/redis"
        elementFormDefault="qualified"
        attributeFormDefault="unqualified">

      <xsd:import namespace="http://www.springframework.org/schema/tool" schemaLocation="http://www.springframework.org/schema/tool/spring-tool.xsd"/>

      <xsd:annotation>
        <xsd:documentation><![CDATA[
    Defines the configuration elements for the Spring Data Redis support.
    Allows for configuring Redis listener containers in XML 'shortcut' style.
        ]]></xsd:documentation>
      </xsd:annotation>

      <xsd:element name="listener-container">
        <xsd:annotation>
          <xsd:documentation><![CDATA[
    Container of Redis listeners. All listeners will be hosted by the same container.
          ]]></xsd:documentation>
          <xsd:appinfo>
            <tool:annotation>
              <tool:exports type="org.springframework.data.redis.listener.RedisMessageListenerContainer"/>
            </tool:annotation>
          </xsd:appinfo>
        </xsd:annotation>
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element name="listener" type="listenerType" minOccurs="0" maxOccurs="unbounded"/>
          </xsd:sequence>
          <xsd:attribute name="connection-factory" type="xsd:string" default="redisConnectionFactory">
            <xsd:annotation>
              <xsd:documentation><![CDATA[
    A reference to the Redis ConnectionFactory bean.
    Default is "redisConnectionFactory".
              ]]></xsd:documentation>
              <xsd:appinfo>
                <tool:annotation kind="ref">
                  <tool:expected-type type="org.springframework.data.redis.connection.ConnectionFactory"/>
                </tool:annotation>
              </xsd:appinfo>
            </xsd:annotation>
          </xsd:attribute>
          <xsd:attribute name="task-executor" type="xsd:string">
            <xsd:annotation>
              <xsd:documentation><![CDATA[
    A reference to a Spring TaskExecutor (or standard JDK 1.5 Executor) for executing
    Redis listener invokers. Default is a SimpleAsyncTaskExecutor.
              ]]></xsd:documentation>
              <xsd:appinfo>
                <tool:annotation kind="ref">
                  <tool:expected-type type="java.util.concurrent.Executor"/>
                </tool:annotation>
              </xsd:appinfo>
            </xsd:annotation>
          </xsd:attribute>
          <xsd:attribute name="subscription-task-executor" type="xsd:string">
            <xsd:annotation>
              <xsd:documentation><![CDATA[
    A reference to a Spring TaskExecutor (or standard JDK 1.5 Executor) for listening
    to Redis messages. By default reuses the 'task-executor' value.
              ]]></xsd:documentation>
              <xsd:appinfo>
                <tool:annotation kind="ref">
                  <tool:expected-type type="java.util.concurrent.Executor"/>
                </tool:annotation>
              </xsd:appinfo>
            </xsd:annotation>
          </xsd:attribute>
          <xsd:attribute name="topic-serializer" type="xsd:string">
            <xsd:annotation>
              <xsd:documentation><![CDATA[
    A reference to the RedisSerializer strategy for converting Redis channels/patterns to
    serialized format. Default is a StringRedisSerializer.
              ]]></xsd:documentation>
              <xsd:appinfo>
                <tool:annotation kind="ref">
                  <tool:expected-type type="org.springframework.data.redis.serializer.RedisSerializer"/>
                </tool:annotation>
              </xsd:appinfo>
            </xsd:annotation>
          </xsd:attribute>
          <xsd:attribute name="phase" type="xsd:string">
            <xsd:annotation>
              <xsd:documentation><![CDATA[
    The lifecycle phase within which this container should start and stop. The lower
    the value the earlier this container will start and the later it will stop. The
    default is Integer.MAX_VALUE meaning the container will start as late as possible
    and stop as soon as possible.
              ]]></xsd:documentation>
            </xsd:annotation>
          </xsd:attribute>
        </xsd:complexType>
      </xsd:element>

      <xsd:complexType name="listenerType">
        <xsd:attribute name="ref" type="xsd:string" use="required">
          <xsd:annotation>
            <xsd:documentation><![CDATA[
      The bean name of the listener object, implementing
      the MessageListener interface or defining the specified listener method.
      Required.
            ]]></xsd:documentation>
            <xsd:appinfo>
              <tool:annotation kind="ref"/>
            </xsd:appinfo>
          </xsd:annotation>
        </xsd:attribute>
        <xsd:attribute name="topic" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation><![CDATA[
    The topics(s) to which the listener is subscribed. Can be (in Redis terminology) a
    channel or/and a pattern. Multiple values can be specified by separating them with
    spaces. Patterns can be specified by using the '*' character.
            ]]></xsd:documentation>
          </xsd:annotation>
        </xsd:attribute>
        <xsd:attribute name="method" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation><![CDATA[
    The name of the listener method to invoke. If not specified,
    the target bean is supposed to implement the MessageListener
    interface or provide a method named 'handleMessage'.
            ]]></xsd:documentation>
          </xsd:annotation>
        </xsd:attribute>
        <xsd:attribute name="serializer" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation><![CDATA[
    A reference to the RedisSerializer strategy for converting Redis Messages to
    listener method arguments. Default is a StringRedisSerializer.
            ]]></xsd:documentation>
            <xsd:appinfo>
              <tool:annotation kind="ref">
                <tool:expected-type type="org.springframework.data.redis.serializer.RedisSerializer"/>
              </tool:annotation>
            </xsd:appinfo>
          </xsd:annotation>
        </xsd:attribute>
      </xsd:complexType>

      <xsd:element name="collection">
        <xsd:annotation>
          <xsd:documentation><![CDATA[
    Factory creating collections on top of Redis keys.
          ]]></xsd:documentation>
          <xsd:appinfo>
            <tool:annotation>
              <tool:exports type="org.springframework.data.redis.support.collections.RedisCollectionFactoryBean"/>
            </tool:annotation>
          </xsd:appinfo>
        </xsd:annotation>
        <xsd:complexType>
    	  <xsd:attribute name="id" type="xsd:ID">
    		<xsd:annotation>
    			<xsd:documentation><![CDATA[
    The name of the Redis collection.]]></xsd:documentation>
    		</xsd:annotation>
    	  </xsd:attribute>
          <xsd:attribute name="key" type="xsd:string" use="optional">
            <xsd:annotation>
              <xsd:documentation><![CDATA[
    Redis key of the created collection. Defaults to bean id.
              ]]></xsd:documentation>
            </xsd:annotation>
          </xsd:attribute>
          <xsd:attribute name="template" type="xsd:string" default="redisTemplate">
            <xsd:annotation>
              <xsd:documentation><![CDATA[
    A reference to a RedisTemplate bean.Default is "redisTemplate".
              ]]></xsd:documentation>
              <xsd:appinfo>
                <tool:annotation kind="ref">
                  <tool:expected-type type="org.springframework.data.redis.core.RedisTemplate"/>
                </tool:annotation>
              </xsd:appinfo>
            </xsd:annotation>
          </xsd:attribute>
          <xsd:attribute name="type" default="LIST" use="optional">
            <xsd:annotation>
              <xsd:documentation><![CDATA[
    The collection type (default is list).
    If the key exists, its type takes priority. The type is used to disambiguate the collection type (map vs properties) or
    specify one in case the key is missing.]]></xsd:documentation>
            </xsd:annotation>
            <xsd:simpleType>
            	<xsd:restriction base="xsd:string">
            		<xsd:enumeration value="LIST"/>
            		<xsd:enumeration value="SET"/>
            		<xsd:enumeration value="ZSET"/>
            		<xsd:enumeration value="MAP"/>
            		<xsd:enumeration value="PROPERTIES"/>
            	</xsd:restriction>
            </xsd:simpleType>
          </xsd:attribute>
        </xsd:complexType>
      </xsd:element>
    </xsd:schema>

Prev | Up |
Part III. Appendixes | Home |