com.ibm.commerce.foundation.client.facade.bod.servlet.struts

Class BusinessObjectDocumentPlugInImpl

  • java.lang.Object
    • com.ibm.commerce.foundation.client.facade.bod.servlet.struts.BusinessObjectDocumentPlugInImpl
  • All Implemented Interfaces:
    org.apache.struts.action.PlugIn


    public class BusinessObjectDocumentPlugInImpl
    extends java.lang.Object
    implements org.apache.struts.action.PlugIn
    This struts plug-in class registers the URL to Business Object Document configuration to transform URL requests to Business Object Document requests. This plug-in leverages the struts plug-in framework to invoke the transformation utility to load the specified files.
    • Constructor Summary

      Constructors 
      Constructor and Description
      BusinessObjectDocumentPlugInImpl()
      Creates an instance of the business object document struts plug-in.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void destroy()
      This method is defined by the interface but does not perform any operation.
      void init(org.apache.struts.action.ActionServlet actionServlet, org.apache.struts.config.ModuleConfig moduleConfig)
      This method initialized the plug-in by parsing the common separated list of files and call the utility to load the configuration.
      void setAlternateApplicationErrorResourceBundle(java.lang.String configuration)
      This method sets the extension common exceptions resource bundle base name.
      void setConfig(java.lang.String configuration)
      This method sets the configuration files to register that contains the URL to Business Object Document transformation.
      void setPrimaryApplicationErrorResourceBundle(java.lang.String configuration)
      This method sets the base common exceptions resource bundle base name.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • BusinessObjectDocumentPlugInImpl

        public BusinessObjectDocumentPlugInImpl()
        Creates an instance of the business object document struts plug-in.
    • Method Detail

      • setConfig

        public void setConfig(java.lang.String configuration)
        This method sets the configuration files to register that contains the URL to Business Object Document transformation. This method sets the list of files to initialize.
        Parameters:
        configuration - A list of files that defines the URL to Business Object Document transformation.
      • setPrimaryApplicationErrorResourceBundle

        public void setPrimaryApplicationErrorResourceBundle(java.lang.String configuration)
        This method sets the base common exceptions resource bundle base name.
        Parameters:
        configuration - The base common exceptions resource bundle base name.
      • setAlternateApplicationErrorResourceBundle

        public void setAlternateApplicationErrorResourceBundle(java.lang.String configuration)
        This method sets the extension common exceptions resource bundle base name.
        Parameters:
        configuration - The extension common exceptions resource bundle base name.
      • destroy

        public void destroy()
        This method is defined by the interface but does not perform any operation.
        Specified by:
        destroy in interface org.apache.struts.action.PlugIn
        See Also:
        PlugIn.destroy()
      • init

        public void init(org.apache.struts.action.ActionServlet actionServlet,
                         org.apache.struts.config.ModuleConfig moduleConfig)
                  throws javax.servlet.ServletException
        This method initialized the plug-in by parsing the common separated list of files and call the utility to load the configuration.
        Specified by:
        init in interface org.apache.struts.action.PlugIn
        Parameters:
        actionServlet - The associated action servlet.
        moduleConfig - The module configuration.
        Throws:
        javax.servlet.ServletException - A problem while parsing and loading the configuration files.
        See Also:
        PlugIn.init(org.apache.struts.action.ActionServlet, org.apache.struts.config.ModuleConfig)