Help needed with BlueprintPageCreateEvent listener

steve-killelay

Hi,

I've been puzzling over this for a couple of days now and cannot seem to figure out why this is not working.

I've been using this tutorial to write a custom collection of templates into a single blueprint. Not-with-standing the age of this tutorial and that it's not entirely up-to-date for the latest SDK; I've pretty much got everything I need sorted, so I'm confident the pom and atlassian-plugin.xml are well structured.

My only issue is that I cannot get the listener to fire on the BlueprintPageCreateEvent.

Here's the framework of my listener - 

package com.itg.plugins.confluence.iso.impl;

import com.atlassian.confluence.plugins.createcontent.api.events.BlueprintPageCreateEvent;
import com.atlassian.event.api.EventListener;
import com.atlassian.event.api.EventPublisher;
import com.atlassian.plugin.ModuleCompleteKey;
import com.atlassian.plugin.spring.scanner.annotation.imports.ComponentImport;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.atlassian.confluence.pages.Page;
import com.atlassian.confluence.pages.PageManager;
import com.atlassian.confluence.spaces.Space;
import com.atlassian.confluence.spaces.SpaceManager;
import com.atlassian.confluence.spaces.SpacesQuery;
import java.util.List;



public class IsoDocumentTemplateListener {
 private static final ModuleCompleteKey MY_BLUEPRINT_KEY = new ModuleCompleteKey("com.itg.plugins.confluence.iso", "iso-documentation");
 private static final Logger log = LoggerFactory.getLogger(IsoDocumentTemplateListener.class);
 private SpaceManager manager;
 private SpacesQuery query;


 public IsoDocumentTemplateListener(EventPublisher eventPublisher) {
 eventPublisher.register(this);
 }

@EventListener
 public void onBlueprintCreateEvent(BlueprintPageCreateEvent event){

 ModuleCompleteKey moduleCompleteKey = event.getBlueprintKey();

 if (MY_BLUEPRINT_KEY.equals(moduleCompleteKey)){
 //Do stuff here!



 }
 }
}   

I'm using atlas SDK v6.3.7, building to confluence version 6.0.2 and JRE 1.8 (64 bit).

 

Any help you can provide would be welcome

Hasnae

Hei there

You need to ensure your event listener is treated as a component; there are two ways you can achieve this :

• update your atlassian-plugin.xml with a component definition

<component 
      name="My event listener" 
class="my.event.listener.ClassImpl"
      key="myEventListener" application="confluence"
/>

• rely on the atlassian spring annotations

@Component
public class SampleEventListener implements InitializingBean, DisposableBean {

private final EventPublisher eventPublisher;

    @Autowired
    public SampleEventListener(@ComponentImport final EventPublisher eventPublisher) {
this.eventPublisher = eventPublisher;
    }

@EventListener
    public void onBlueprintCreateEvent(final BlueprintPageCreateEvent event){
final ContentBlueprint blueprint = event.getBlueprint();
        System.out.println(blueprint);
    }

@Override
    public void destroy() {
this.eventPublisher.unregister(this);
    }

@Override
    public void afterPropertiesSet() {
this.eventPublisher.register(this);
    }
}

 

Also to reduce side effects on confluence, you need to ensure that your event listener is unregistered when the application needs it to. So the common practice within Confluence teams is to implement the InitializingBean and DisposableBean interfaces for event listeners.

Doing so will ensure events are captured by your event listener

You can find a sample implementation on this repo https://bitbucket.org/viqueen/confluence-community/commits/5ba8c641101333ad5af07adfa0fed6ff31ab7f75

Hopefully this helps you