Class IncludeNotFound

  • All Implemented Interfaces:
    EventHandler, IncludeEventHandler, ContextAware, RuntimeServicesAware

    public class IncludeNotFound
    extends java.lang.Object
    implements IncludeEventHandler, RuntimeServicesAware, ContextAware
    Simple event handler that checks to see if an included page is available. If not, it includes a designated replacement page instead.

    By default, the name of the replacement page is "notfound.vm", however this page name can be changed by setting the Velocity property eventhandler.include.notfound, for example:

     eventhandler.include.notfound = error.vm
     

    The name of the missing resource is put into the Velocity context, under the key "missingResource", so that the "notfound" template can report the missing resource with a Velocity reference, like: $missingResource

    Since:
    1.5
    Version:
    $Id: IncludeNotFound.java 809816 2009-09-01 05:14:27Z nbubna $
    Author:
    Will Glass-Husain
    • Constructor Summary

      Constructors 
      Constructor Description
      IncludeNotFound()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String includeEvent​(java.lang.String includeResourcePath, java.lang.String currentResourcePath, java.lang.String directiveName)
      Chseck to see if included file exists, and display "not found" page if it doesn't.
      void setContext​(Context context)
      Initialize the EventHandler.
      void setRuntimeServices​(RuntimeServices rs)
      Called automatically when event cartridge is initialized.
      • Methods inherited from class java.lang.Object

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