access query string parameter in plugin macro

[Roger Weinheimer]

Can a plugin macro on a page access a query string parameter included in the request URL for the page?

Example:

http://exampledomain.com/display/spacekey/Home?myquerystringparameter=X

in macro sited on Home page, run the following code.

public class MyMacro implements Macro {

	@Override
    public String execute(Map<String, String> parameters, String bodyContent, ConversionContext conversionContext) throws MacroExecutionException
    {
	// some API to consume query string parameter?
        Object myQueryStringParam = someAPI('myquerystringparameter');
        ...

My question is what API, if any, can I use to consume the query string parameter?

[Eugen Mayer · Accepted solution]

import com.opensymphony.webwork.ServletActionContext;
import javax.servlet.http.HttpServletRequest;

// then use this
HttpServletRequest request = ServletActionContext.getRequest();
string param = request.getParameter("myquerystringparamter"));

Thats pretty straighforward.

[Roger Weinheimer]

Perfect. Thanks.

[Xavier Martin]

In what language is that code written? I mean, what macro do I have to select and then paste that code into its body? Thanks.

[Bob Swift OSS (Bob Swift Atlassian Apps)]

They are talking about a formal java macro built in a plugin. You should be able to use the same technique in a Groovy Macro.

[Xavier Martin]

Great! At last! You only have to add a groovy macro and then paste this code:

def p=request.getParameter("p")
println(p)

"Save" and then, if you call that page adding this to the URL:

?p=v

...a "v" is shown.

Thanks Bob!

[Bob Swift OSS (Bob Swift Atlassian Apps)]

Good. Nice idea to take advantage of the request pre-defined variable to make it easier when used in groovy.

[Thomas Kalsberger, MSc]

hi!

have a look at the free plugins from randombits. they contain lots of very usefull features and are highly recommended

e.g. from confluence support plugin which you can get from here:

https://marketplace.atlassian.com/plugins/org.randombits.support.support-core

check out this:

https://svn.atlassian.com/svn/public/contrib/confluence/libraries/org.randombits.confluence/confluence-support/tags/1.1/src/java/org/randombits/confluence/support/MacroInfo.java

cheers,

Thomas