com.atlassian.confluence.renderer.v2.macros

Class BaseHttpRetrievalMacro

java.lang.Object

com.atlassian.renderer.v2.macro.BaseMacro

com.atlassian.confluence.renderer.v2.macros.BaseHttpRetrievalMacro

All Implemented Interfaces:

com.atlassian.renderer.v2.macro.Macro

public abstract class BaseHttpRetrievalMacro
extends com.atlassian.renderer.v2.macro.BaseMacro

Field Summary

Fields inherited from interface com.atlassian.renderer.v2.macro.Macro

RAW_PARAMS_KEY

Constructor Summary

Constructors

Constructor and Description
BaseHttpRetrievalMacro()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	cleanupUrl(String url)
String	execute(Map parameters, String body, com.atlassian.renderer.RenderContext renderContext)
String	failed(String url, HttpResponse response)
com.atlassian.renderer.v2.RenderMode	getBodyRenderMode()
protected ConfluenceUser	getRemoteUser()
boolean	hasBody()
String	notFound(String url)
String	notPermitted(String url)
void	setHttpRetrievalService(HttpRetrievalService httpRetrievalService)
void	setUserAccessor(UserAccessor userAccessor)
abstract String	successfulResponse(Map parameters, com.atlassian.renderer.RenderContext renderContext, String url, HttpResponse response)

Methods inherited from class com.atlassian.renderer.v2.macro.BaseMacro

getTokenType, getWysiwygBodyType, isInline, suppressMacroRenderingDuringWysiwyg, suppressSurroundingTagDuringWysiwygRendering

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseHttpRetrievalMacro

public BaseHttpRetrievalMacro()

Method Detail

hasBody

public boolean hasBody()

getBodyRenderMode

public com.atlassian.renderer.v2.RenderMode getBodyRenderMode()

execute

public String execute(Map parameters,
             String body,
             com.atlassian.renderer.RenderContext renderContext)
               throws com.atlassian.renderer.v2.macro.MacroException

Throws:

com.atlassian.renderer.v2.macro.MacroException

successfulResponse

public abstract String successfulResponse(Map parameters,
                        com.atlassian.renderer.RenderContext renderContext,
                        String url,
                        HttpResponse response)
                                   throws com.atlassian.renderer.v2.macro.MacroException

Throws:

com.atlassian.renderer.v2.macro.MacroException

notFound

public String notFound(String url)

notPermitted

public String notPermitted(String url)

failed

public String failed(String url,
            HttpResponse response)

cleanupUrl

protected String cleanupUrl(String url)

setHttpRetrievalService

public void setHttpRetrievalService(HttpRetrievalService httpRetrievalService)

getRemoteUser

protected ConfluenceUser getRemoteUser()

setUserAccessor

public void setUserAccessor(UserAccessor userAccessor)