com.technia.tvc.core

Interface TVCPlugin

All Known Subinterfaces:

TVCPluginWithLifecycle

All Known Implementing Classes:

TVCPluginAdapter

public interface TVCPlugin

Represents a plugin into TVC. A plugin defines it's own action configuration, ajax configuration and type mapping URLs.

A plugin is typically registered through the web.xml file:

     <init-param>
         <param-name>tvc.core.plugins</param-name>
         <param-value>com.company.MyTVCPlugin</param-value>
     </init-param>
 

Note that if you have several plugins, they should be comma separated.

You can also take advantage of the logging functionality within TVC, by simply in your constructor do as this code example:

      package com.company;

      import com.technia.tvc.core.TVCSystem;
      import com.technia.tvc.core.TVCLogManager;
      import com.technia.tvc.core.TVCPlugin;
      import com.technia.tvc.log4j.Logger;

      public class MyPlugin implements TVCPlugin {
          public MyPlugin() {
              String pattern = "[CUSTOM] [%t]%x %5p %d{HH:mm:ss,SSS} (%F:%L) - %m%n";
              TVCLogManager.addConsoleAppender("com.company", pattern);
              Logger l = Logger.getLogger("com.company");
              if (TVCSystem.getInstance().isDevelopmentMode()) {
                  l.setLevel(Level.DEBUG);
              } else {
                  l.setLevel(Level.ERROR);
              }
          }
          ...
      }
 

Since:

5.2.1

See Also:

TVCPluginAdapter

Method Summary

Modifier and Type	Method and Description
java.net.URL	getActionConfigURL() Returns the URL from which the plugin specific action configurations should be loaded.
java.net.URL	getAjaxConfigURL() Returns the URL from which the plugin specific ajax services should be loaded.
java.lang.String	getDescription() Returns a short human readable description of the plugin.
java.lang.String	getDisplayName() Returns the plugin's display name.
java.lang.String	getName() Returns the name of the plugin.
java.lang.String	getStringResourceName() Returns the name of the string resource for this component.
java.net.URL	getTypeMappingsURL() Returns the URL from which the plugin specific type mappings should be loaded.

Method Detail

getName

java.lang.String getName()

Returns the name of the plugin.

getDisplayName

java.lang.String getDisplayName()

Returns the plugin's display name.

getDescription

java.lang.String getDescription()

Returns a short human readable description of the plugin.

getActionConfigURL

java.net.URL getActionConfigURL()

Returns the URL from which the plugin specific action configurations should be loaded. Action configurations should be defined in an XML file.

getAjaxConfigURL

java.net.URL getAjaxConfigURL()

Returns the URL from which the plugin specific ajax services should be loaded. Ajax services should be defined in an XML file.

getTypeMappingsURL

java.net.URL getTypeMappingsURL()

Returns the URL from which the plugin specific type mappings should be loaded. Type mappings should be defined in a properties file.

getStringResourceName

java.lang.String getStringResourceName()

Returns the name of the string resource for this component.