com.atlassian.confluence.renderer.radeox.macros.include
Class HtmlIncludeMacro

java.lang.Object
  org.radeox.macro.BaseMacro
      com.atlassian.renderer.macro.BaseMacro
          com.atlassian.confluence.renderer.radeox.macros.AbstractHtmlGeneratingMacro
              com.atlassian.confluence.renderer.radeox.macros.include.AbstractHttpRetrievalMacro
                  com.atlassian.confluence.renderer.radeox.macros.include.HtmlIncludeMacro

All Implemented Interfaces:

Comparable, org.radeox.macro.Macro

public class HtmlIncludeMacro
extends AbstractHttpRetrievalMacro

A macro to include remote HTML pages into Confluence

Field Summary

Fields inherited from class com.atlassian.confluence.renderer.radeox.macros.include.AbstractHttpRetrievalMacro

HTTP_INCLUDE_STACK_HEADER, HTTP_INCLUDE_STACK_MAX_DEPTH

Fields inherited from class org.radeox.macro.BaseMacro

initialContext, paramDescription

Constructor Summary

HtmlIncludeMacro()

Method Summary

protected String	fetchPageContent(String url, org.radeox.macro.parameter.MacroParameter macroParameter)
String	getHtml(org.radeox.macro.parameter.MacroParameter macroParameter)
String	getName()
String[]	getParamDescription()

Methods inherited from class com.atlassian.confluence.renderer.radeox.macros.include.AbstractHttpRetrievalMacro

cleanUrlParentheses, errorContent, retrieveRemoteUrl

Methods inherited from class com.atlassian.confluence.renderer.radeox.macros.AbstractHtmlGeneratingMacro

buildBaseUrl, execute, getPageContext, getRemoteUser, hasLoneParameter, parseParameterForKey

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

getDescription, getResourcePath, setDescription, setResourcePath

Methods inherited from class org.radeox.macro.BaseMacro

compareTo, setInitialContext, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.radeox.macro.Macro

setInitialContext

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

HtmlIncludeMacro

public HtmlIncludeMacro()

Method Detail

getName

public String getName()

Specified by:

getName in interface org.radeox.macro.Macro

Specified by:

getName in class org.radeox.macro.BaseMacro

getParamDescription

public String[] getParamDescription()

Specified by:

getParamDescription in interface org.radeox.macro.Macro

Overrides:

getParamDescription in class org.radeox.macro.BaseMacro

getHtml

public String getHtml(org.radeox.macro.parameter.MacroParameter macroParameter)
               throws IllegalArgumentException,
                      IOException

Specified by:

getHtml in class AbstractHtmlGeneratingMacro

Throws:

IllegalArgumentException

IOException

fetchPageContent

protected String fetchPageContent(String url,
                                  org.radeox.macro.parameter.MacroParameter macroParameter)
                           throws IOException

Throws:

IOException