[CONF] Apache ServiceMix > servicemix-quartz

confluence Thu, 19 Aug 2010 10:27:23 -0700

     servicemix-quartz
    Page edited by             Jean-Baptiste Onofré
    
        

                         Changes (22)
                                 
    

            
            h1. servicemix-quartz 

            h1. ServiceMix Quartz 

             

            The servicemix-quartz ServiceMix Quartz component is a standard JBI Service Engine able to schedule and trigger jobs using the great [Quartz|http://www.opensymphony.com/quartz/] scheduler. 

             

            h2. Using servicemix-quartz as a standard JBI component 

            h2. Maven Archetype 

             

            You can use Maven servicemix-quartz-service-unit archetype to create a Quartz service unit: 

             

            h3. Installation 
 
Installing the servicemix-quartz component can be done in several ways: 
* drop the installer zip in an hotdeploy directory monitored by ServiceMix 
* using [ant tasks|Ant Tasks] 
 
Note that when using ant tasks, the component is not started, you will have to start it manually using ant tasks or a console. 
{info} 
To configure the internal Quartz Component (eg cluster, database, plugin), put quartz.properties into SERVICEMIX_HOME 
/conf (Root classpath) 
{info} 
 
h3. Service Unit packaging 
 
A service unit will typically consist in: 
 * an {{xbean.xml}} configuration file 
 
Content of xbean.xml file to be packaged as a SU 
{code:xml} 
<beans xmlns:quartz="http://servicemix.apache.org/quartz/1.0"> 
 
  ... add endpoints here ... 
 
</beans> 

            {code} 

            mvn archetype:create \ 
  -DarchetypeGroupId=org.apache.servicemix.tooling \ 

              -DarchetypeArtifactId=servicemix-quartz-service-unit \ 

            h2. Using servicemix-quartz in a ServiceMix xml configuration file 

              -DarchetypeVersion=2010.01 \ 
  -DgroupId=your.group.id \ 
  -DartifactId=your.artifact.id \ 

              -Dversion=your-service 

            {code:xml} 
<beans xmlns:sm="http://servicemix.apache.org/config/1.0" 
       xmlns:quartz="http://servicemix.apache.org/quartz/1.0"> 
 
  <sm:container ...> 
    <sm:activationSpecs> 
      <sm:activationSpec> 
        <sm:component> 
          <quartz:component> 
            <quartz:endpoints> 
 
              ... add quartz endpoints here ... 
 
            </quartz:endpoints> 
          </quartz:component> 
        </sm:component> 
      </sm:activationSpec> 
      ... 
    </sm:activationSpecs> 
  </sm:container> 
  ... 
 
</beans> 

            {code} 
 

            h2. Quartz endpoint 

            h2. Endpoint Configuration 

             

            The qQuartz endpoint can be used to fire message exchanges at a given (recurrent) time. 

             

            Examples: 
 
{code:lang=xml|title=Cron trigger endpoint} 

            {code:lang=xml|title=Quartz Cron Trigger Endpoint} 

            <quartz:endpoint service="test:service" endpoint="endpoint1" targetService="test:receiver1"> 
  <quartz:trigger> 

            ...

            {code} 
 

            {code:lang=xml|title=Simple trigger endpoint} 

            {code:lang=xml|title=Quartz Simple Trigger Endpoint} 

            <quartz:endpoint service="test:service" endpoint="endpoint2" targetService="test:receiver2"> 
  <quartz:trigger> 

            ...

            {code} 
 

            {code:lang=xml|title=Custom marshaler} 

            {code:lang=xml|title=Quartz Custom Marshaler} 

            <quartz:endpoint service="test:service" endpoint="endpoint3" targetService="test:receiver3"> 
  <quartz:jobDetail> 

            ...

        
                            Full Content
                    
        ServiceMix Quartz

The ServiceMix Quartz component is a standard JBI Service Engine able to schedule and trigger jobs using the great Quartz scheduler.

Maven Archetype

You can use Maven servicemix-quartz-service-unit archetype to create a Quartz service unit:


mvn archetype:create \
  -DarchetypeGroupId=org.apache.servicemix.tooling \
  -DarchetypeArtifactId=servicemix-quartz-service-unit \
  -DarchetypeVersion=2010.01 \
  -DgroupId=your.group.id \
  -DartifactId=your.artifact.id \
  -Dversion=your-service


Endpoint Configuration

The Quartz endpoint can be used to fire message exchanges at a given (recurrent) time.

Quartz Cron Trigger Endpoint

<quartz:endpoint service="test:service" endpoint="endpoint1" targetService="test:receiver1">
  <quartz:trigger>
    <quartz:cron cronExpression="0/5 * * * * ?" />
  </quartz:trigger>
</quartz:endpoint>



Quartz Simple Trigger Endpoint

<quartz:endpoint service="test:service" endpoint="endpoint2" targetService="test:receiver2">
  <quartz:trigger>
    <quartz:simple repeatCount="0" repeatInterval="1000" />
  </quartz:trigger>
</quartz:endpoint>



Quartz Custom Marshaler

<quartz:endpoint service="test:service" endpoint="endpoint3" targetService="test:receiver3">
  <quartz:jobDetail>
    <quartz:jobDetail>
      <quartz:jobDataAsMap>
        <quartz:property key="xml"><![CDATA[
          <hello>world</hello>
        ]]></quartz:property>
      </quartz:jobDataAsMap>
    </quartz:jobDetail>
  </quartz:jobDetail>
  <quartz:triggers>
    <quartz:simple repeatCount="0" repeatInterval="1000" />
    <quartz:cron cronExpression="0 * 1 * * ?" />
  </quartz:triggers>
  <quartz:marshaler>
    <bean class="org.apache.servicemix.quartz.CustomMarshaler" />
  </quartz:marshaler>
</quartz:endpoint>



The snippet above requires a CustomMarshaler implementation that can get the information from the job data map and add it to the NormalizedMessage.

Custom marshaler class

public class CustomMarshaler extends DefaultQuartzMarshaler {

    public void populateNormalizedMessage(NormalizedMessage message, JobExecutionContext context)
                                                               throws JobExecutionException, MessagingException {
        super.populateNormalizedMessage(message, context);
        //add your own content to the message here
        message.setContent(new StringSource((String) context.getJobDetail().getJobDataMap().get("xml"))); 
    }
}



    
        
        
            Change Notification Preferences
        
        View Online
        |
        View Changes
                |
        Add Comment
-h1. servicemix-quartz
+h1. ServiceMix Quartz
 The servicemix-quartz ServiceMix Quartz component is a standard JBI Service Engine able to schedule and trigger jobs using the great [Quartz|http://www.opensymphony.com/quartz/] scheduler.
-h2. Using servicemix-quartz as a standard JBI component
+h2. Maven Archetype
+You can use Maven servicemix-quartz-service-unit archetype to create a Quartz service unit:
-h3. Installation 
 
Installing the servicemix-quartz component can be done in several ways: 
* drop the installer zip in an hotdeploy directory monitored by ServiceMix 
* using [ant tasks|Ant Tasks] 
 
Note that when using ant tasks, the component is not started, you will have to start it manually using ant tasks or a console. 
{info} 
To configure the internal Quartz Component (eg cluster, database, plugin), put quartz.properties into SERVICEMIX_HOME 
/conf (Root classpath) 
{info} 
 
h3. Service Unit packaging 
 
A service unit will typically consist in: 
 * an {{xbean.xml}} configuration file 
 
Content of xbean.xml file to be packaged as a SU 
{code:xml} 
<beans xmlns:quartz="http://servicemix.apache.org/quartz/1.0"> 
 
  ... add endpoints here ... 
 
</beans>
 {code}
+mvn archetype:create \ 
  -DarchetypeGroupId=org.apache.servicemix.tooling \
   -DarchetypeArtifactId=servicemix-quartz-service-unit \
-h2. Using servicemix-quartz in a ServiceMix xml configuration file
+  -DarchetypeVersion=2010.01 \ 
  -DgroupId=your.group.id \ 
  -DartifactId=your.artifact.id \
   -Dversion=your-service
-{code:xml} 
<beans xmlns:sm="http://servicemix.apache.org/config/1.0" 
       xmlns:quartz="http://servicemix.apache.org/quartz/1.0"> 
 
  <sm:container ...> 
    <sm:activationSpecs> 
      <sm:activationSpec> 
        <sm:component> 
          <quartz:component> 
            <quartz:endpoints> 
 
              ... add quartz endpoints here ... 
 
            </quartz:endpoints> 
          </quartz:component> 
        </sm:component> 
      </sm:activationSpec> 
      ... 
    </sm:activationSpecs> 
  </sm:container> 
  ... 
 
</beans>
 {code}
-h2. Quartz endpoint
+h2. Endpoint Configuration
 The qQuartz endpoint can be used to fire message exchanges at a given (recurrent) time.
-Examples: 
 
{code:lang=xml|title=Cron trigger endpoint}
+{code:lang=xml|title=Quartz Cron Trigger Endpoint}
 <quartz:endpoint service="test:service" endpoint="endpoint1" targetService="test:receiver1"> 
  <quartz:trigger>
 ...
 {code}
-{code:lang=xml|title=Simple trigger endpoint}
+{code:lang=xml|title=Quartz Simple Trigger Endpoint}
 <quartz:endpoint service="test:service" endpoint="endpoint2" targetService="test:receiver2"> 
  <quartz:trigger>
 ...
 {code}
-{code:lang=xml|title=Custom marshaler}
+{code:lang=xml|title=Quartz Custom Marshaler}
 <quartz:endpoint service="test:service" endpoint="endpoint3" targetService="test:receiver3"> 
  <quartz:jobDetail>
 ...

[CONF] Apache ServiceMix > servicemix-quartz

servicemix-quartz

Page edited by Jean-Baptiste Onofré

Changes (22)

Full Content

ServiceMix Quartz

Maven Archetype

Endpoint Configuration

Reply via email to