Package org.opencms.main

Interface I_CmsShellCommands

public interface I_CmsShellCommands
Provides scriptable access to a class from the CmsShell.

Since:
6.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    initShellCmsObject(CmsObject cms, CmsShell shell)
    Provides access to the shell CmsObject and the shell itself.
    void
    shellExit()
    May be called after shell exit, can e.g.
    void
    shellStart()
    May be called before shell startup, can e.g.

  • Method Details

    • initShellCmsObject

      void initShellCmsObject(CmsObject cms, CmsShell shell)
      Provides access to the shell CmsObject and the shell itself.

      Parameters:
      cms - the shell CmsObject
      shell - the CmsShell

    • shellExit

      void shellExit()
      May be called after shell exit, can e.g. be used to output a goodbye message.

      Please note: This method is not guaranteed to be called. For a shell that has more than one shell command object initialized, only the exit method of one of those will be called.

    • shellStart

      void shellStart()
      May be called before shell startup, can e.g. be used to output a welcome message.

      Please note: This method is not guaranteed to be called. For a shell that has more than one shell command object initialized, only the start method of one of those will be called.