com.technia.tvc.core

Class TVCPluginAdapter

java.lang.Object

com.technia.tvc.core.TVCPluginAdapter

All Implemented Interfaces:

TVCPlugin, TVCPluginWithLifecycle

public abstract class TVCPluginAdapter
extends java.lang.Object
implements TVCPluginWithLifecycle

An abstract adapter class for TVCPlugins.

This class exists as a convenience for creating TVCPlugins, all methods in this class returns null, hence you can override those methods that you need.

As a minimum requirement, you need to implement the getName() method in order to return a unique name for your plugin.

There is also a convenient way to setup the logger from this plugin. The logger functionality can be used inside your custom code. This is simply done by calling the setupLogger() or setupLogger(String, String, Level) from your plugin constructor.

Since:

6.1.7

Constructor Summary

Constructors

Constructor and Description
TVCPluginAdapter()

Method Summary

Modifier and Type	Method and Description
void	destroy() This method does nothing
java.net.URL	getActionConfigURL() Returns null by default.
java.net.URL	getAjaxConfigURL() Returns null by default.
java.lang.String	getDescription() Returns null by default.
java.lang.String	getDisplayName() Returns same as getName() by default.
abstract java.lang.String	getName() Should return the name of this plugin.
java.lang.String	getStringResourceName() Returns null by default.
java.net.URL	getThemeConfigURL() Returns null by default.
java.net.URL	getTypeMappingsURL() Returns null by default.
void	init() This method does nothing
protected void	setupLogger() This method can be called in order to setup the logging, in the default way, for this plugin
protected void	setupLogger(java.lang.String logFormat, java.lang.String loggerName, com.technia.tvc.log4j.Level defaultLevel) Setups the logger based upon the arguments passed to this method.

Methods inherited from class java.lang.Object

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

Constructor Detail

TVCPluginAdapter

public TVCPluginAdapter()

Method Detail

setupLogger

protected void setupLogger()

This method can be called in order to setup the logging, in the default way, for this plugin

Calling this method, is identical as calling setupLogger(null, null, null);

Since:

6.1.7

setupLogger

protected void setupLogger(java.lang.String logFormat,
                           java.lang.String loggerName,
                           com.technia.tvc.log4j.Level defaultLevel)

Setups the logger based upon the arguments passed to this method.

Parameters:

logFormat - The format of the generated log statements. If null, the default log format will be used:

[name] [%t]%x %5p %d{HH:mm:ss,SSS} (%F:%L) - %m%n

Where name is the name of the plugin, as given by getName()

loggerName - The name of the logger. If null, the package name of the plugin will be used.

defaultLevel - The default logger level. If null, then DEBUG will be used if TVC is running in development mode, otherwise ERROR is used.

Since:

6.1.7

getName

public abstract java.lang.String getName()

Should return the name of this plugin.

Specified by:

getName in interface TVCPlugin

getDisplayName

public java.lang.String getDisplayName()

Returns same as getName() by default.

Specified by:

getDisplayName in interface TVCPlugin

See Also:

TVCPlugin.getName()

getDescription

public java.lang.String getDescription()

Returns null by default.

Specified by:

getDescription in interface TVCPlugin

See Also:

TVCPlugin.getDescription()

getActionConfigURL

public java.net.URL getActionConfigURL()

Returns null by default.

Specified by:

getActionConfigURL in interface TVCPlugin

See Also:

TVCPlugin.getActionConfigURL()

getAjaxConfigURL

public java.net.URL getAjaxConfigURL()

Returns null by default.

Specified by:

getAjaxConfigURL in interface TVCPlugin

See Also:

TVCPlugin.getAjaxConfigURL()

getTypeMappingsURL

public java.net.URL getTypeMappingsURL()

Returns null by default.

Specified by:

getTypeMappingsURL in interface TVCPlugin

See Also:

TVCPlugin.getTypeMappingsURL()

getStringResourceName

public java.lang.String getStringResourceName()

Returns null by default.

Specified by:

getStringResourceName in interface TVCPlugin

See Also:

TVCPlugin.getStringResourceName()

getThemeConfigURL

public java.net.URL getThemeConfigURL()

Returns null by default.

Since:

2011.2.0

init

public void init()

This method does nothing

Specified by:

init in interface TVCPluginWithLifecycle

destroy

public void destroy()

This method does nothing

Specified by:

destroy in interface TVCPluginWithLifecycle