nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Scroll Word Exporter Java API in Confluence Plugin

John Reese_mxkf8s

Hello everyone, i'm posting here and on kt15 forum looking for help. Got stuck while trying to implement the API

Maybe someone can help me here, i appreciate any help that i can get

Been using this link to set it up https://bitbucket.org/K15t/scroll-exporter-api/src/master/ and now when trying to export through the API this happens.

java.lang.NullPointerException
ScrollApi.exportWithDescendantPages(ScrollApi.java:19);

And at line 19:

WordExportRequest exportRequest = wordExportService.createExportRequest(rootPageId);

I already added every dependency to my confluence plugin.

Anybody knows how to do this properly? What am i missing? Trying to automate exports through the Java API, the REST API works fine.

Accepted answers

All comments

Matthias Gaiser _K15t_

Hi @John Reese

welcome to the Atlassian community.

Based on the information you‘ve shared, it looks like the variable wordExportService is null.

Can you check how you’re initializing it? If the ScrollApi class is a SpringBean, the easiest way would be to add the annotations @Autowired @ComponentImport.

Does that help? If not, please share more context how you‘re initializing the wordExportService.

Cheers,
Matthias.

John Reese_mxkf8s

Hello and thank you!

Here it is

import com.atlassian.plugin.spring.scanner.annotation.imports.ComponentImport;
import com.k15t.scroll.exporter.api.word.*;
import org.springframework.beans.factory.annotation.Autowired;

@Autowired @ComponentImport private WordExportService wordExportService;
@Autowired @ComponentImport private WordTemplateService wordTemplateService;

So it's not really being initialized, i'm not even sure how to initialize it.

What do you mean by "Add annotations" should i add those annotations to the ScrollApi class?

Also no, my class is not a SpringBean, how do i make it a SpringBean? I'll look into it

Thank you!

Matthias Gaiser _K15t_

Thank you for sharing some more context, @John Reese.

Short answer
I recommend to let Confluence instantiate your class via Spring. You usually annotate your class with @Component or @Named and Spring will then autowire the dependencies accordingly.

It could somehow look like these lines:

import com.atlassian.plugin.spring.scanner.annotation.imports.ComponentImport;
import com.k15t.scroll.exporter.api.word.*;
import org.springframework.beans.factory.annotation.Autowired;


@Component
public class MyClass {
@Autowired @ComponentImport private WordExportService wordExportService;
@Autowired @ComponentImport private WordTemplateService wordTemplateService;

  public void exportWordFile() {
    ...
    WordExportRequest exportRequest = wordExportService.createExportRequest(rootPageId);
    ...
  }
}

Long answer
In order to get a deeper understanding, I recommend to read some background information about writing Confluence plugins which probably explain the concept better than I can. This page also links to a page for accessing Confluence Components from Plugin Modules. Accessing the Scroll API works analogue to the techniques described there for Confluence classes.
There's also another article with some more background information on Spring in Confluence.

You could also do some Confluence tutorials to learn more about accessing Confluence and the Scroll Exporter API.

John Reese_mxkf8s

Hello @Matthias Gaiser _K15t_ thanks for the reply

Thank your for the resources, did some of the tutorials and was able to add another functionality, however when doing the API calls i got stuck.

This is how it looks like now

import com.atlassian.plugin.spring.scanner.annotation.imports.ComponentImport;
import com.k15t.scroll.exporter.api.word.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.List;

@Component
public class ScrollApi {
@Autowired @ComponentImport private WordExportService wordExportService;
    @Autowired @ComponentImport private WordTemplateService wordTemplateService;

    public void exportWithDescendantPages(long rootPageId) throws IOException {
        WordExportRequest exportRequest = wordExportService.createExportRequest(rootPageId);
        WordExportResult exportResult = wordExportService.export(exportRequest);
    }
}

I used @Component from org.springframework.stereotype.Component

And got the same result, null pointer exception

From my plugin class it's called like this

public class PluginTest extends ConfluenceActionSupport implements PageAware {

...
...

public String execute() throws Exception{
      ...
      ScrollApi scrollApi = new ScrollApi();
      scrollApi.exportWithDescendantPages(page);
      ...
      return "success";
   }
}

Is it being called correctly? Or is there another way?

I also tried the @Named annotation but couldn't find it.

Once again thank you very much for your help

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

confluence

server

confluence-server

api

app

k15t

scroll-word-exporter