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:

Macro

public abstract class BaseHttpRetrievalMacro
extends BaseMacro

Field Summary

static org.apache.log4j.Category

log

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

RAW_PARAMS_KEY

Constructor Summary

BaseHttpRetrievalMacro()

Method Summary

protected String	cleanupUrl(String url)
String	execute(Map parameters, String body, RenderContext renderContext)
String	failed(String url, HttpResponse response)
RenderMode	getBodyRenderMode()
protected User	getRemoteUser()
boolean	hasBody()
boolean	isInline()
String	notFound(String url)
String	notPermitted(String url)
void	setHttpRetrievalService(HttpRetrievalService httpRetrievalService)
void	setUserAccessor(UserAccessor userAccessor)
abstract String	successfulResponse(Map parameters, RenderContext renderContext, String url, HttpResponse response)

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

getTokenType, suppressMacroRenderingDuringWysiwyg, suppressSurroundingTagDuringWysiwygRendering

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.log4j.Category log

Constructor Detail

BaseHttpRetrievalMacro

public BaseHttpRetrievalMacro()

Method Detail

isInline

public boolean isInline()

Specified by:

isInline in interface Macro

Overrides:

isInline in class BaseMacro

hasBody

public boolean hasBody()

getBodyRenderMode

public RenderMode getBodyRenderMode()

execute

public String execute(Map parameters,
                      String body,
                      RenderContext renderContext)
               throws MacroException

Throws:

MacroException

successfulResponse

public abstract String successfulResponse(Map parameters,
                                          RenderContext renderContext,
                                          String url,
                                          HttpResponse response)
                                   throws MacroException

Throws:

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 User getRemoteUser()

setUserAccessor

public void setUserAccessor(UserAccessor userAccessor)