Petals Documentation > Petals ESB > Petals Components > Components User Guide > Petals-BC-Mail > Petals-BC-Mail 4.0.0+

Petals-BC-Mail 4.0.0+

This version must be installed on Petals ESB 5.1.0+

Exposing a SMTP transfer as a service. (Provides mode)

PROVIDE SERVICE: Import into the JBI environment an email account as a service, or use a generic SendMail service:

Petals Mail binding component allows JBI consumers to send mails to an email account. A JBI endpoint is registered into the JBI environment, and is linked to an smtp server, with an email address defined. When MailBC receives a message exchange from Petals platform, the content of the message is sent to the defined email address.

Sending mails

  • Step 1: A JBI Consumer sends a Message Exchange to the Mail Binding Component.
  • Step 2: Mail Binding Component processes the Message Exchange: transforms it into a mail message and retrieve targeted External Provider Service (email address) linked to the endpoint set in the Message Exchange.
  • Step 3: Mail Binding Component sends this new mail to the targeted External Provider Service (Business Service, simple email account...).
Table of contents
Contributors

Native service

The component can expose directly a generic service without deploying a service unit to send mails.

To allow the component to provide this generic service, the component must have the WSDL named 'component.wsdl'. To deactivate the generic service supplied by the component, simply remove the file 'component.wsdl' from the component archive.

This service offer two modes:

  • In-payload mode: The service allows the consumer to send a specific XML message to the component with-all the information needed in the payload to send an email.

The IN message looks like :

<ns0:mail xmlns:ns0="http://petals.ow2.org/components/mail/version-3.0">
         <ns0:host>localhost</ns0:host>
         <ns0:port>25</ns0:port>
         <ns0:user>user</ns0:user>
         <ns0:password>pwd</ns0:password>
         <ns0:scheme>smtp</ns0:scheme>
         <ns0:from>from@from.com</ns0:from>
         <ns0:reply>reply@reply.com</ns0:reply>
         <ns0:to>to@to.com</ns0:to>
         <ns0:subject>subject</ns0:subject>
         <ns0:helohost>helo</ns0:helohost>
         <ns0:send-mode>content-and-attachments</ns0:send-mode>
         <ns0:content-type>text/plain</ns0:content-type>
         <ns0:body>My email content</ns0:body>
</ns0:mail>
  • WS-Addressing mode: The service allows the consumer to send a JBI message to the component by setting WS-Addressing properties in the IN message with all the information needed to send an email. The content of the mail (body) is in the payload of the message.

The IN message looks like:

<?xml version="1.0" encoding="UTF-8"?>
<mail xmlns="http://petals.ow2.org/components/mail/version-3.0">
   <body>My Mail Content</body>
</mail>

The possible properties are the following:

IN Property Description Default Required
{http://www.w3.org/2005/08/addressing}To email address of the recipient - Yes
{http://www.w3.org/2005/08/addressing}From email address of the sender - Yes
{http://www.w3.org/2005/08/addressing}ReplyTo email address for the reply - no
{http://www.w3.org/2005/08/addressing}Action the subject of the mail petals-bc-mail no
{http://petals.ow2.org/components/mail/version-3}Host the host used for connection - Yes
{http://petals.ow2.org/components/mail/version-3}Port the port used for connection 25 No
{http://petals.ow2.org/components/mail/version-3}User the username used for authentication - No
{http://petals.ow2.org/components/mail/version-3}Password the password used for authentication. Can be null or empty - No
{http://petals.ow2.org/components/mail/version-3}Scheme the connection protocol (smtp) smtp No
{http://petals.ow2.org/components/mail/version-3}HeloHost HELO host for SMTP - No
{http://petals.ow2.org/components/mail/version-3}SendMode Send either the source, the attachments or both of the payload content-and-attachments No
{http://petals.ow2.org/components/mail/version-3}ContentType The mail mime type text/plain no

Integration service

Petals BC Mail can be configured to provide an integration service provider deploying a service unit. A part of the service contract of this integration service provider is commanded by Petals BC Mail:

  • abstract part (port-type and messages) of the WSDL is completely commanded by Petals BC Mail,
  • you can choose your own names for the concrete part (binding and service).

Once the service unit is deployed, you just have to send message exchange with an IN message as following to send an email:

<?xml version="1.0" encoding="UTF-8"?>
<mail xmlns="http://petals.ow2.org/components/mail/version-3.0">
   <body>My Mail Content</body>
</mail>

Usage

warning
InOnly message exchange patterns are allowed.

If the email content is a markup language, it's recommended to use CDATA section or to escape illegal XML character:

Example of IN message with CDATA section:

<mail xmlns="http://petals.ow2.org/components/mail/version-3.0">
   <body><![CDATA[<element>my content</element>]]></body>
</mail>

Example of IN message with escaped illegal XML character:

<mail xmlns="http://petals.ow2.org/components/mail/version-3.0">
   <body>&lt;element&gt;my content&lt;/element&gt;</body>
</mail>

Configuration

Service Unit descriptor

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi version="1.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns:jbi="http://java.sun.com/xml/ns/jbi"
         xmlns:mail="http://petals.ow2.org/components/mail/version-3.0"
         xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-4.0"
         xmlns:generatedNs="http://test">

    <jbi:services binding-component="true">
        <jbi:provides
            interface-name="generatedNs:SendMail"
            service-name="generatedNs:SendMailService"
            endpoint-name="SendMailServiceEndpoint">

            <!-- CDK specific elements -->
            <petalsCDK:wsdl>sendMail.wsdl</petalsCDK:wsdl>

            <!-- Component specific elements -->
            <mail:scheme>smtp</mail:scheme>
            <mail:host>smtp.host.com</mail:host>
            <mail:port>25</mail:port>
            <mail:user>user</mail:user>
            <mail:password>password</mail:password>
            <mail:from>from email address</mail:from>
            <mail:reply>reply email address</mail:reply>
            <mail:to>recipient address</mail:to>
            <mail:subject>mail subject</mail:subject>
            <mail:send-mode>content-and-attachments</mail:send-mode>
            <mail:content-type>text/plain</mail:content-type>
        </jbi:provides>
    </jbi:services>
</jbi:jbi>
Configuration of a Service Unit to provide a service (JBI)

Parameter Description
Default
Required
provides Describe the JBI service that will be exposed into the JBI bus. Interface (QName), Service (QName) and Endpoint (String) attributes are required. - Yes

Configuration of a Service Unit to provide a service (CDK)

Parameter Description
 Default
 Required
timeout Timeout in milliseconds of a synchronous send. This parameter is used by the method sendSync (Exchange exchange) proposes by the CDK Listeners classes.
Set it to 0 for an infinite timeout. 		30000 No
exchange-properties This sections defines the list of properties to set to the JBI exchange when processing a service. - No
message-properties This sections defines the list of properties to set to the JBI message when processing a service. - No
validate-wsdl Activate the validation of the WSDL when deploying a service unit. true No
wsdl
Path to the WSDL document describing services and operations exposed by the provided JBI endpoints defined in the SU.
The value of this parameter is :
  • an URL
  • a file relative to the root of the SU package
    If not specified, a basic WSDL description is automaticaly provided by the CDK.
- No
forward-attachments
Defines if attachment will be forwarded from IN message to OUT message.
false No
forward-message-properties
Defines if the message properties will be forwarded from IN message to OUT message. false No
forward-security-subject
Defines if the security subject will be forwarded from IN message to OUT message. false No

Configuration of a Service Unit to provide a service (Mail)

Parameter Description Default Required
scheme the connection protocol (smtp) - Yes
username the username used for authentication - No
password the password used for authentication. Can be null or empty - No
host the host used for connection - Yes
port the port used for connection 25 No
to email address of the recipient - Yes
from email address of the sender - Yes
reply email address for the reply - No
subject the subject of the mail petals-bc-mail No
helohost HELO host for SMTP - No
send-mode Send either the source, the attachments or both of the payload content-and-attachments No
content-type The mail mime type text/plain no

Interceptor

Example of an interceptor configuration:

<?xml version="1.0" encoding="UTF-8"?>
<!--...-->
<petalsCDK:su-interceptors>
  <petalsCDK:send>
    <petalsCDK:interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
      <petalsCDK:param name="myParamName2">myParamValue2</petalsCDK:param>
    </petalsCDK:interceptor>
  </petalsCDK:send>
  <petalsCDK:accept>
    <petalsCDK:interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    </petalsCDK:interceptor>
  </petalsCDK:accept>
  <petalsCDK:send-response>
    <petalsCDK:Interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    </petalsCDK:Interceptor>
  </petalsCDK:send-response>
  <petalsCDK:accept-response>
    <petalsCDK:Interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    </petalsCDK:Interceptor>
  </petalsCDK:accept-response>
</petalsCDK:su-interceptors>
<!--...-->

Interceptors configuration for SU (CDK)

Parameter Description Default Required
send Interceptor dedicated to send phase, for an exchange sent by a consumer - No
accept Interceptor dedicated to receive phase, for an exchange received by a provider - No
send-response Interceptor dedicated to send phase, for an exchange (a response) received by a consumer - No
accept-response Interceptor dedicated to receive phase, for an exchange sent (a response) by a provider - No
interceptor - name Logical name of the interceptor instance. It can be referenced to add extended parameters by a SU Interceptor configuration. - Yes
param[] - name The name of the parameter to use for the interceptor for this SU - No
param[] The value of the parameter to use for the interceptor for this SU - No

Service Unit content

The Service Unit has to contain the following elements, packaged in an archive :

  • The META-INF/jbi.xml descriptor file, has described above,
  • An optional wsdl file describing the related service
su-mail.zip
   + META-INF
     - jbi.xml
     - service.xml

Pivot service

Petals BC Mail can be configured to provide an pivot service provider deploying a service unit. With pivot service provider you are able to define it your own WSDL to better match your needs.

Using a pivot service is better than native or integration service because you will be more agile, you will be able to change the implementation of your pivot service (replacing Petals BC Mail) with impacts on your service consumers. It is not possible with native and integration services.

Usage

warning
InOnly message exchange patterns are allowed.

The mail sent depends on:

  • annotations that you have put in your WSDL. Annotations provides a way to get values of parameters to send mail from your incoming payload.
  • and parameters available at SU descriptor level.

Configuration

WSDL annotations

Several WSDL annotations are available. They should be put in the binding section of your WSDL:

   <wsdl:binding name="emailNotifyVacationBinding" type="notifyService:emailNotifyVacation"
       xmlns:bcmail="http://petals.ow2.org/bc/mail/annotations/1.0" >
      ...
      <wsdl:operation name="newVacationRequest">
         <bcmail:subject>Your new vacation request #${/*[local-name()='newVacationRequest']/*[local-name()='vacationRequestId']} was submitted for validation</bcmail:subject>
         <bcmail:body><![CDATA[
                  <p>
                     You have submitted a new vacation request for validation:
                     <ul>
                        <li>reference: #${/*[local-name()='newVacationRequest']/*[local-name()='vacationRequestId']},</li>
                        <li>first day: ${/*[local-name()='newVacationRequest']/*[local-name()='start-date']},</li>
                        <li>duration: ${/*[local-name()='newVacationRequest']/*[local-name()='day-number']} day(s),</li>
                        <li>reason: ${/*[local-name()='newVacationRequest']/*[local-name()='reason']}</li>
                     </ul>
                  </p>]]>
         </bcmail:body>
         <bcmail:to>//*[local-name()='newVacationRequest']/*[local-name()='recipient']/text()</bcmail:to>
         <bcmail:header>
            <bcmail:name>X-VacationRequestId</bcmail:name>
            <bcmail:value>${/*[local-name()='newVacationRequest']/*[local-name()='vacationRequestId']}</bcmail:value>
         </bcmail:header>
         <bcmail:header>
            <bcmail:name>X-VacationRequestStartDate</bcmail:name>
            <bcmail:value>${substring-before(/*[local-name()='newVacationRequest']/*[local-name()='start-date'], 'T')}</bcmail:value>
         </bcmail:header>
         <bcmail:header>
            <bcmail:name>X-VacationRequestDayNumber</bcmail:name>
            <bcmail:value>${/*[local-name()='newVacationRequest']/*[local-name()='day-number']}</bcmail:value>
         </bcmail:header>
         <wsdl:input>...</wsdl:input>
      </wsdl:operation>
   </wsdl:binding>

All annotations are member of namespace 'http://petals.ow2.org/bc/mail/annotations/1.0'. Annotations override content of the SU descripto. Available annotations are:

Name Description Required Default value
subject Mail subject. To be able to put data extracted from the incoming message, you can use XPath expression placeholders as '${<xpath-expression>}' in the content of this annotation. No
body Mail body. To be able to put data extracted from the incoming message, you can use XPath expression placeholders as '${<xpath-expression>}' in the content of this annotation. No
to Recipient of the mail defined as a XPath expression. Only one recipient is accepted. Yes
options Use to set options on mail. Options are available as attributes:
  • dsn-on-delay: Enable Delivery Status Notification (DSN) on delay,
  • dsn-on-failure: Enable DSN on mail sent with failure,
  • dsn-on-success: Enable DSN on mail sent succesfully,
  • dsn-on-never: Disable DSN,
  • dsn-content: Define the content of DSN: full (entire body) or headers (only headers).
 No
header Use to add headers in your mail. The header name is defined through the sub-tag 'name', and its value through 'value'. The value can contains XPath expression placeholders as '${<xpath-expression>}'. No

Service Unit descriptor

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi version="1.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns:jbi="http://java.sun.com/xml/ns/jbi"
         xmlns:mail="http://petals.ow2.org/components/mail/version-3.0"
         xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-4.0"
         xmlns:generatedNs="http://test">

    <jbi:services binding-component="true">
        <jbi:provides
            interface-name="generatedNs:SendMail"
            service-name="generatedNs:SendMailService"
            endpoint-name="SendMailServiceEndpoint">

            <!-- CDK specific elements -->
            <petalsCDK:wsdl>sendMail.wsdl</petalsCDK:wsdl>

            <!-- Component specific elements -->
            <mail:scheme>smtp</mail:scheme>
            <mail:host>smtp.host.com</mail:host>
            <mail:port>25</mail:port>
            <mail:user>user</mail:user>
            <mail:password>password</mail:password>
            <mail:from>from email address</mail:from>
            <mail:reply>reply email address</mail:reply>
            <mail:to>recipient address</mail:to>
            <mail:subject>mail subject</mail:subject>
            <mail:send-mode>content-and-attachments</mail:send-mode>
            <mail:content-type>text/plain</mail:content-type>
        </jbi:provides>
    </jbi:services>
</jbi:jbi>

Parameter Description Default Required
scheme the connection protocol (smtp) - Yes
username the username used for authentication - No
password the password used for authentication. Can be null or empty - No
host the host used for connection - Yes
port the port used for connection 25 No
to email address of the recipient - Yes
from email address of the sender - Yes
reply email address for the reply - No
subject the subject of the mail petals-bc-mail No
helohost HELO host for SMTP - No
send-mode Send either the source, the attachments or both of the payload content-and-attachments No
content-type The mail mime type text/plain no

Service Unit content

The Service Unit has to contain the following elements, packaged in an archive :

  • The META-INF/jbi.xml descriptor file, has described above,
  • You own WSDL file describing the related service
su-mail.zip
   + META-INF
     - jbi.xml
     - service.wsdl

Invoking service on incoming email

Receiving mails

Petals Mail binding component (MailBC) allows to receive mails from external consumer and to bind them to message exchanges intinded to internal jbi components. To receive new mails, MailBC can be linked to specific mail stores. It will check these stores periodicaly to retrieve new mails. If it finds a new mail in a store, it will process it (map this mail to a message exchange) and send it to the targeted jbi endpoint. Then the mail is removed from the store. So, all mails (read or unread) in a store are considered as new mail.

  • Step 1: An External Consumer Entity (Business Service or simple mail client) sends an email to the registered Mail Store (a classical email account).
  • Step 2: Mail Binding Component periodicaly checks for new mails and imports them.
  • Step 3and 4 : Mail Binding Component processes this new mails : transforms them into Message Exchanges, sends them to targeted jbi components (step 4) and finally delete them from the mail Store.

Service Unit descriptor

Petals Mail binding component can be configured by deploying a new service unit to it. The jbi descriptor (jbi.xml file) of this service unit must contains a consumes node describing the link between an external mail store and an internal jbi endpoint. Here is an exemple of jbi descriptor activating a new "consumed service" :

<?xml version="1.0" encoding="UTF-8"?>
<!-- JBI descriptor for PEtALS' "petals-bc-mail" (Mail), version 3.0 -->
<jbi:jbi version="1.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns:jbi="http://java.sun.com/xml/ns/jbi"
         xmlns:mail="http://petals.ow2.org/components/mail/version-3.0"
         xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-4.0"
         xmlns:generatedNs="http://test">

    <!-- Import a Service into PEtALS or Expose a PEtALS Service => use a BC. -->
    <jbi:services binding-component="true">

        <!-- Expose a PEtALS Service => consumes a Service. -->
        <jbi:consumes
            interface-name="generatedNs:Interface"
            service-name="generatedNs:Service"
            endpoint-name="Endpoint">

            <!-- CDK specific elements -->
            <petalsCDK:operation>operation</petalsCDK:operation>
            <petalsCDK:mep>InOnly</petalsCDK:mep>

            <!-- Component specific elements -->
            <mail:scheme>pop3</mail:scheme>
            <mail:host>pop.host.com</mail:host>
            <mail:port>110</mail:port>
            <mail:user>user</mail:user>
            <mail:password>password</mail:password>
            <mail:folder>INBOX</mail:folder>
            <mail:delete>true</mail:delete>
            <mail:period>60000</mail:period>
            <mail:isxmlcontent>false</mail:isxmlcontent>
        </jbi:consumes>
    </jbi:services>
</jbi:jbi>
Configuration of a Service Unit to consume a service (JBI)

Parameter Description Default Required
consumes Refer JBI service to invoke into the JBI bus.
You can define an explicit endpoint: interface (QName) / Service (QName) / Endpoint (String) attributes.
Or define implicit endpoint, to let the container routing according to QOS configurations (HA...):
-by Interface attribute (QName)
-by Service attribute (QName) 		- Yes


Configuration of a Service Unit to consume a service (CDK)

Parameter Description Default Required
mep Message exchange pattern abbreviation. This parameter can be used in conjunction with the method of the CDK Listeners: createMessageExchange(Extensions extensions).
This method returns a CDK Exchange corresponding to the type of the specified pattern. 		- Yes
operation Operation to call on a service. This parameter can be used in conjunction with the sending methods of the Listeners. If no operation is specified in the Message Exchange to send, this parameter will be used. - No
timeout Timeout in milliseconds of a synchronous send. This parameter can be used in conjunction with the sendSync(Exchange exchange) method of the Listeners. Set 0 for an infinite timeout. 30000 No


Configuration of a Service Unit to consume a service (Mail)

Parameter Description Default Required
scheme the connection protocol (imap or pop3) - Yes
username the username used for authentication - No
password the password used for authentication. Can be null or empty - No
host the host used for connection - Yes
port the port used for connection
  • imap : 143
  • pop3 : 110
 No
folder the folder to check for new mails INBOX No
delete Expunge deleted messages (read messages are marked as DELETED, default is TRUE) true No
period the checking period time 60 000 ms No
isxmlcontent Assume mail content is XML. If false, mail content will be wrapped in an <body /> element. false No

Interceptor

Example of an interceptor configuration:

<?xml version="1.0" encoding="UTF-8"?>
<!--...-->
<petalsCDK:su-interceptors>
  <petalsCDK:send>
    <petalsCDK:interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
      <petalsCDK:param name="myParamName2">myParamValue2</petalsCDK:param>
    </petalsCDK:interceptor>
  </petalsCDK:send>
  <petalsCDK:accept>
    <petalsCDK:interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    </petalsCDK:interceptor>
  </petalsCDK:accept>
  <petalsCDK:send-response>
    <petalsCDK:Interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    </petalsCDK:Interceptor>
  </petalsCDK:send-response>
  <petalsCDK:accept-response>
    <petalsCDK:Interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    </petalsCDK:Interceptor>
  </petalsCDK:accept-response>
</petalsCDK:su-interceptors>
<!--...-->

Interceptors configuration for SU (CDK)

Parameter Description Default Required
send Interceptor dedicated to send phase, for an exchange sent by a consumer - No
accept Interceptor dedicated to receive phase, for an exchange received by a provider - No
send-response Interceptor dedicated to send phase, for an exchange (a response) received by a consumer - No
accept-response Interceptor dedicated to receive phase, for an exchange sent (a response) by a provider - No
interceptor - name Logical name of the interceptor instance. It can be referenced to add extended parameters by a SU Interceptor configuration. - Yes
param[] - name The name of the parameter to use for the interceptor for this SU - No
param[] The value of the parameter to use for the interceptor for this SU - No

Service Unit content

The Service Unit has to contain the following elements, packaged in an archive :

  • The META-INF/jbi.xml descriptor file, has described above
su-mail.zip
   + META-INF
     - jbi.xml

Usage

When a new email is in the INBOX folder of the configured email account, the content of the mail is forwarded to the JBI Service defined in the Consumes section of the Service Unit.

The component sends exchange with the InOnly pattern only.

Component Configuration

Configuration of the component, CDK part

Parameter Description Default Scope
acceptor-pool-size The size of the thread pool used to accept Message Exchanges from the NMR. Once a message is accepted, its processing is delegated to the processor pool thread. 1
 Runtime
acceptor-retry-number Number of tries to submit a message exchange to a processor for processing before to declare that it cannot be processed. 40
 Installation
acceptor-retry-wait Base duration, in milliseconds, to wait between two processing submission tries. At each try, the new duration is the previous one plus this base duration. 250
 Installation
acceptor-stop-max-wait The max duration (in milliseconds) before, on component stop, each acceptor is stopped by force. 500
 Runtime
processor-pool-size The size of the thread pool used to process Message Exchanges. Once a message is accepted, its processing is delegated to one of the thread of this pool. 10 Runtime
processor-max-pool-size The maximum size of the thread pool used to process Message Exchanges. The difference between this size and the processor-pool-size represents the dynamic threads that can be created and destroyed during overhead processing time.
50
 Runtime
processor-keep-alive-time When the number of processors is greater than the core, this is the maximum time that excess idle processors will wait for new tasks before terminating, in seconds.
300
 Runtime
processor-stop-max-wait The max duration (in milliseconds) of message exchange processing on stop phase (for all processors).
 15000
 Runtime
time-beetween-async-cleaner-runs The time (in milliseconds) between two runs of the asynchronous message exchange cleaner.
 2000
 Installation
properties-file Name of the file containing properties used as reference by other parameters. Parameters reference the property name using a placeholder in the following pattern ${myPropertyName}. At runtime, the expression is replaced by the value of the property.

The properties file can be reloaded using the JMX API of the component. The runtime configuration MBean provides an operation to reload these place holders. Check the service unit parameters that support this reloading.

The value of this parameter is :
  • an URL
  • a file relative to the PEtALS installation path
  • an absolute file path
  • an empty value to stipulate a non-using file.
 - Installation
monitoring-sampling-period Period, in seconds, of a sample used by response time probes of the monitoring feature.
 300
 Installation

Definition of CDK parameter scope :

  • Installation: The parameter can be set during the installation of the component, by using the installation MBean (see JBI specifications for details about the installation sequence). If the parameter is optional and has not been defined during the development of the component, it is not available at installation time.
  • Runtime: The paramater can be set during the installation of the component and during runtime. The runtime configuration can be changed using the CDK custom MBean named RuntimeConfiguration. If the parameter is optional and has not been defined during the development of the component, it is not available at installation and runtime times.

Interceptor

Interceptors can be defined to inject some post or pre processing in the component during service processing.

Using interceptor is very sensitive and must be manipulate only by power users. An non properly coded interceptor engaged in a component can lead to uncontrolled behaviors, out of the standard process.

Example of an interceptor configuration:

<?xml version="1.0" encoding="UTF-8"?>
<!--...-->
<petalsCDK:component-interceptors>
  <petalsCDK:interceptor active="true" class="org.ow2.petals.myInterceptor" name="myInterceptorName">
    <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    <petalsCDK:param name="myParamName2">myParamValue2</petalsCDK:param>
  </petalsCDK:interceptor>
</petalsCDK:component-interceptors>
<!--...-->

Interceptors configuration for Component (CDK)

Parameter Description Default Required
interceptor - class Name of the interceptor class to implement. This class must extend the abstract class org.ow2.petals.component.common.interceptor.Interceptor. This class must be loadable from the component classloader, or in a dependent Shared Library classloader. - Yes
interceptor - name Logical name of the interceptor instance. It can be referenced to add extended parameters by a SU Interceptor configuration. - Yes
interceptor - active If true, the Interceptor instance is activated for every SU deployed on the component.
If false, the Interceptor can be activated:
-by the InterceptorManager Mbean at runtime, to activate the interceptor for every deployed SU.
-by a SU configuration 		- Yes
param[] - name The name of the parameter to use for the interceptor. - No
param[] The value of the parameter to use for the interceptor. - No

Monitoring the component

Using metrics

Several probes providing metrics are included in the component, and are available through the JMX MBean 'org.ow2.petals:type=custom,name=monitoring_<component-id>', where <component-id> is the unique JBI identifier of the component.

Common metrics

The following metrics are provided through the Petals CDK, and are common to all components:

Metrics, as MBean attribute Description Detail of the value Configurable
MessageExchangeAcceptorThreadPoolMaxSize The maximum number of threads of the message exchange acceptor thread pool integer value, since the last startup of the component yes, through acceptor-pool-size
MessageExchangeAcceptorThreadPoolCurrentSize The current number of threads of the message exchange acceptor thread pool. Should be always equals to MessageExchangeAcceptorThreadPoolMaxSize. instant integer value no
MessageExchangeAcceptorCurrentWorking The current number of working message exchange acceptors. instant long value no
MessageExchangeAcceptorMaxWorking The max number of working message exchange acceptors. long value, since the last startup of the component no
MessageExchangeAcceptorAbsoluteDurations The aggregated durations of the working message exchange acceptors since the last startup of the component. n-tuple value containing, in nanosecond:
  • the maximum duration,
  • the average duration,
  • the minimum duration.
 no
MessageExchangeAcceptorRelativeDurations The aggregated durations of the working message exchange acceptors on the last sample. n-tuple value containing, in nanosecond:
  • the maximum duration,
  • the average duration,
  • the minimum duration,
  • the 10-percentile duration (10% of the durations are lesser than this value),
  • the 50-percentile duration (50% of the durations are lesser than this value),
  • the 90-percentile duration (90% of the durations are upper than this value).
 no
MessageExchangeProcessorAbsoluteDurations The aggregated durations of the working message exchange processor since the last startup of the component. n-tuple value containing, in milliseconds:
  • the maximum duration,
  • the average duration,
  • the minimum duration.
 no
MessageExchangeProcessorRelativeDurations The aggregated durations of the working message exchange processor on the last sample. n-tuple value containing, in milliseconds:
  • the maximum duration,
  • the average duration,
  • the minimum duration,
  • the 10-percentile duration (10% of the durations are lesser than this value),
  • the 50-percentile duration (50% of the durations are lesser than this value),
  • the 90-percentile duration (90% of the durations are upper than this value).
 no
MessageExchangeProcessorThreadPoolActiveThreadsCurrent The current number of active threads of the message exchange processor thread pool instant integer value no
MessageExchangeProcessorThreadPoolActiveThreadsMax The maximum number of threads of the message exchange processor thread pool that was active integer value, since the last startup of the component no
MessageExchangeProcessorThreadPoolIdleThreadsCurrent The current number of idle threads of the message exchange processor thread pool instant integer value no
MessageExchangeProcessorThreadPoolIdleThreadsMax The maximum number of threads of the message exchange processor thread pool that was idle integer value, since the last startup of the component no
MessageExchangeProcessorThreadPoolMaxSize The maximum size, in threads, of the message exchange processor thread pool instant integer value yes, through http-thread-pool-size-max
MessageExchangeProcessorThreadPoolMinSize The minimum size, in threads, of the message exchange processor thread pool instant integer value yes, through http-thread-pool-size-min
MessageExchangeProcessorThreadPoolQueuedRequestsCurrent The current number of enqueued requests waiting to be processed by the message exchange processor thread pool instant integer value no
MessageExchangeProcessorThreadPoolQueuedRequestsMax The maximum number of enqueued requests waiting to be processed by the message exchange processor thread pool since the last startup of the component instant integer value no
ServiceProviderInvocations The number of service provider invocations grouped by:
  • interface name, as QName, the invoked service provider,
  • service name, as QName, the invoked service provider,
  • invoked operation, as QName,
  • message exchange pattern,
  • and execution status (PENDING, ERROR, FAULT, SUCCEEDED).
 integer counter value since the last startup of the component no
ServiceProviderInvocationsResponseTimeAbs The aggregated response times of the service provider invocations since the last startup of the component grouped by:
  • interface name, as QName, the invoked service provider,
  • service name, as QName, the invoked service provider,
  • invoked operation, as QName,
  • message exchange pattern,
  • and execution status (PENDING, ERROR, FAULT, SUCCEEDED).
 n-tuple value containing, in millisecond:
  • the maximum response time,
  • the average response time,
  • the minimum response time.
 no
ServiceProviderInvocationsResponseTimeRel The aggregated response times of the service provider invocations on the last sample, grouped by:
  • interface name, as QName, the invoked service provider,
  • service name, as QName, the invoked service provider,
  • invoked operation, as QName,
  • message exchange pattern,
  • and execution status (PENDING, ERROR, FAULT, SUCCEEDED).
 n-tuple value containing, in millisecond:
  • the maximum response time,
  • the average response time,
  • the minimum response time,
  • the 10-percentile response time (10% of the response times are lesser than this value),
  • the 50-percentile response time (50% of the response times are lesser than this value),
  • the 90-percentile response time (90% of the response times are lesser than this value).
 no

Dedicated metrics

No dedicated metric is available.

Receiving alerts

Several alerts are notified by the component through notification of the JMX MBean 'org.ow2.petals:type=custom,name=monitoring_<component-id>', where <component-id> is the unique JBI identifier of the component.

To integrate these alerts with Nagios, see Receiving Petals ESB defects in Nagios.

Common alerts

Defect JMX Notification
A message exchange acceptor thread is dead
  • type: org.ow2.petals.component.framework.process.message.acceptor.pool.thread.dead
  • no user data
No more thread is available in the message exchange acceptor thread pool
  • type: org.ow2.petals.component.framework.process.message.acceptor.pool.exhausted
  • no user data
No more thread is available to run a message exchange processor
  • type: org.ow2.petals.component.framework.process.message.processor.thread.pool.exhausted
  • no user data

Dedicated alerts

No dedicated alert is available.

Labels

components-bc-family components-bc-family Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.