net.customware.license.confluence

Class LicensedConfluenceMacro

java.lang.Object

org.randombits.support.confluence.ConfluenceMacro

net.customware.license.confluence.LicensedConfluenceMacro

All Implemented Interfaces:

com.atlassian.confluence.macro.Macro

public abstract class LicensedConfluenceMacro
extends org.randombits.support.confluence.ConfluenceMacro

This is an extension of the ConfluenceMacro which checks for a valid license being installed before continuing with normal execution of the macro.

Implementors of this class should put their usual macro code in the executeVerified(MacroInfo) method instead of the usual execute(MacroInfo) method. This is called if the license is verified to be valid.

Author:

David Peterson

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.macro.Macro

com.atlassian.confluence.macro.Macro.BodyType, com.atlassian.confluence.macro.Macro.OutputType

Constructor Summary

Constructors

Constructor and Description
LicensedConfluenceMacro(org.randombits.support.core.env.EnvironmentAssistant environmentAssistant, com.atlassian.confluence.xhtml.api.XhtmlContent xhtmlContent, org.randombits.support.core.text.I18NAssistant i18nAssistant)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract de.schlichtherle.license.LicenseManager	createLicenseManager() This method is called to create the license manager.
protected String	execute(org.randombits.support.confluence.MacroInfo info)
protected String	executeUnverified(org.randombits.support.confluence.MacroInfo info, Exception e) This method is executed when verification fails.
protected abstract String	executeVerified(org.randombits.support.confluence.MacroInfo info) This method is called when the plugin has its license successfully verified - that is, the macro can be used.
protected de.schlichtherle.license.LicenseManager	getLicenseManager() Provides the license manager for this macro.

Methods inherited from class org.randombits.support.confluence.ConfluenceMacro

closeMacroInfo, createMacroInfo, execute, getEnvironmentAssistant, getXhtmlContent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.macro.Macro

getBodyType, getOutputType

Constructor Detail

LicensedConfluenceMacro

public LicensedConfluenceMacro(org.randombits.support.core.env.EnvironmentAssistant environmentAssistant,
                       com.atlassian.confluence.xhtml.api.XhtmlContent xhtmlContent,
                       org.randombits.support.core.text.I18NAssistant i18nAssistant)

Method Detail

execute

protected final String execute(org.randombits.support.confluence.MacroInfo info)
                        throws com.atlassian.confluence.macro.MacroExecutionException

Specified by:

execute in class org.randombits.support.confluence.ConfluenceMacro

Throws:

com.atlassian.confluence.macro.MacroExecutionException

executeUnverified

protected String executeUnverified(org.randombits.support.confluence.MacroInfo info,
                       Exception e)
                            throws com.atlassian.confluence.macro.MacroExecutionException

This method is executed when verification fails. It can be overridden if macro subclasses wish to change the default error handling behaviour.

The default behaviour is to simply display the exception error message in a highlighted box.

Parameters:

info - The macro info.

e - The exception thrown when verifying.

Returns:

The XHTML code for the error message.

Throws:

com.atlassian.renderer.v2.macro.MacroException - if there is a problem while rendering the macro.

com.atlassian.confluence.macro.MacroExecutionException

executeVerified

protected abstract String executeVerified(org.randombits.support.confluence.MacroInfo info)
                                   throws com.atlassian.confluence.macro.MacroExecutionException

This method is called when the plugin has its license successfully verified - that is, the macro can be used.

Parameters:

info - The macro info.

Returns:

The executed macro content.

Throws:

com.atlassian.renderer.v2.macro.MacroException - if there is a problem while executing the macro.

com.atlassian.confluence.macro.MacroExecutionException

getLicenseManager

protected de.schlichtherle.license.LicenseManager getLicenseManager()

Provides the license manager for this macro. If the macro requires the LicenseManager for some reason, this method should be called rather than the createLicenseManager() method, purely for performance reasons.

Returns:

the current license manager.

createLicenseManager

protected abstract de.schlichtherle.license.LicenseManager createLicenseManager()

This method is called to create the license manager. If the macro needs access to the license manager for any reason it should call getLicenseManager() instead of this method, for performance reasons.

Returns:

the new license manager.