Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

See also Notifications and Managing Subscriptions.

Advanced Use-case 1

This sample can be improved to restrict which users will receive an e-mail notification. For example, it might be required to get an approval from a particular group of users before moving from one state to another. However, this e-mail might not make sense to be delivered to John Smith or Joe Blogg. The following modification can be made to the code segment to restrict the recipients such that John Doe will receive this e-mail though John Smith or Joe Blogg would not.

Code Block
languagejava
package org.wso2.carbon.registry.samples.notifications;
 
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.xpath.AXIOMXPath;
import org.apache.axiom.soap.SOAPEnvelope;
import org.apache.axis2.AxisFault;
import org.apache.axis2.context.MessageContext;
import org.apache.axis2.engine.Handler;
import org.apache.axis2.handlers.AbstractHandler;
import org.apache.axis2.transport.mail.MailConstants;
import org.jaxen.JaxenException;
 
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
 
public class EmailTransformHandler extends AbstractHandler implements Handler {
    private String[] blacklist = {"john@smith.com", "joe@bloggs.co.uk"};
    private String name;
 
    public String getName() {
        return name;
    }
 
    public InvocationResponse invoke(MessageContext msgContext) throws AxisFault {
        String address = msgContext.getTo().getAddress();
        if (msgContext.getTo() != null && address.startsWith("mailto:")) {
            try {
                SOAPEnvelope envelope = msgContext.getEnvelope();
                AXIOMXPath xPath = new AXIOMXPath("//ns:text");
                xPath.addNamespace("ns", "http://ws.apache.org/commons/ns/payload");
                OMElement element = (OMElement) ((ArrayList) xPath.evaluate(envelope)).get(0);
                if (restrict(msgContext, address, element)) {
                    return InvocationResponse.ABORT;
                }
                element.setText(element.getText().replace("--", "This message was intercepted by " +
                        "EmailTransformHandler\n--"));
            } catch (JaxenException e) {
                e.printStackTrace();
            }
        }
        return InvocationResponse.CONTINUE;
    }
 
    private boolean restrict(MessageContext msgContext, String address, OMElement element) {
        final String checkItem = "Smoke Test Passed";
        final String state = "Testing";
        String subject = ((Map<String, String>) msgContext.getOptions().getProperty(
                MessageContext.TRANSPORT_HEADERS)).get(MailConstants.MAIL_HEADER_SUBJECT);
        return (subject.contains("CheckListItemChecked") && element.getText().contains(
                "CheckList item '" + checkItem + "' of LifeCycle State '" + state + "' was") &&
                Arrays.binarySearch(blacklist, address.substring("mailto:".length())) >= 0);
    }
 
    public void revoke(MessageContext msgContext) {
    }
 
    public void setName(String name) {
        this.name = name;
    }
}
Info
titleNote

In this example we have used the default ServiceLifeCycle we have made the restriction for the event triggered by checking of the Smoke Test Passed checklist item of the Testing state. We have assumed that the Promote button which takes you to the Production state will be restricted to the role to which John Doe belongs. For this to work the Transition Permissions must be properly set.

We have also assumed that the Smoke Test Passed checklist item will be the last to be checked in the Testing state and that the immediate next step would be the promotion to the Production state. Because only some users belonging to a particular role will get the option to promote, it is required to keep the corresponding users informed, but not spam the others. This can be done by subscribing all users and blacklisting the ones who do not require receiving the e-mails. See below to learn how to subscribe all users for the Check LC Item event.

Image Added

For this to work, each user should fill out their User Profile.

An Axis2 Handler must implement the org.apache.axis2.engine.Handler interface and can optionally extend the org.apache.axis2.handlers.AbstractHandler class. Read more about Axis2 Handlers to get a better understanding of their uses.

...