Package org.apache.catalina.webresources

Class AbstractResourceSet

java.lang.Object
org.apache.catalina.util.LifecycleBase
org.apache.catalina.webresources.AbstractResourceSet
All Implemented Interfaces:
Lifecycle, WebResourceSet
Direct Known Subclasses:
AbstractArchiveResourceSet, AbstractFileResourceSet
public abstract class AbstractResourceSet extends LifecycleBase implements WebResourceSet

  • Field Details

  • Constructor Details

    • AbstractResourceSet

      public AbstractResourceSet()

  • Method Details

    • checkPath

      protected final void checkPath(String path)

    • setRoot

      public final void setRoot(WebResourceRoot root)
      Specified by:
      setRoot in interface WebResourceSet

    • getRoot

      protected final WebResourceRoot getRoot()

    • getInternalPath

      protected final String getInternalPath()

    • setInternalPath

      public final void setInternalPath(String internalPath)

    • setWebAppMount

      public final void setWebAppMount(String webAppMount)

    • getWebAppMount

      protected final String getWebAppMount()

    • setBase

      public final void setBase(String base)

    • getBase

      protected final String getBase()

    • getClassLoaderOnly

      public boolean getClassLoaderOnly()
      Description copied from interface: WebResourceSet
      Should resources returned by this resource set only be included in any results when the lookup is explicitly looking for class loader resources. i.e. should these resources be excluded from look ups that are explicitly looking for static (non-class loader) resources.
      Specified by:
      getClassLoaderOnly in interface WebResourceSet
      Returns:
      true if these resources should only be used for class loader resource lookups, otherwise false

    • setClassLoaderOnly

      public void setClassLoaderOnly(boolean classLoaderOnly)
      Specified by:
      setClassLoaderOnly in interface WebResourceSet

    • getStaticOnly

      public boolean getStaticOnly()
      Description copied from interface: WebResourceSet
      Should resources returned by this resource set only be included in any results when the lookup is explicitly looking for static (non-class loader) resources. i.e. should these resources be excluded from look ups that are explicitly looking for class loader resources.
      Specified by:
      getStaticOnly in interface WebResourceSet
      Returns:
      true if these resources should only be used for static (non-class loader) resource lookups, otherwise false

    • setStaticOnly

      public void setStaticOnly(boolean staticOnly)
      Specified by:
      setStaticOnly in interface WebResourceSet

    • setManifest

      protected final void setManifest(Manifest manifest)

    • getManifest

      protected final Manifest getManifest()

    • startInternal

      protected final void startInternal() throws LifecycleException
      Description copied from class: LifecycleBase
      Sub-classes must ensure that the state is changed to LifecycleState.STARTING during the execution of this method. Changing state will trigger the Lifecycle.START_EVENT event. If a component fails to start it may either throw a LifecycleException which will cause it's parent to fail to start or it can place itself in the error state in which case LifecycleBase.stop() will be called on the failed component but the parent component will continue to start normally.
      Specified by:
      startInternal in class LifecycleBase
      Throws:
      LifecycleException - Start error occurred

    • stopInternal

      protected final void stopInternal() throws LifecycleException
      Description copied from class: LifecycleBase
      Sub-classes must ensure that the state is changed to LifecycleState.STOPPING during the execution of this method. Changing state will trigger the Lifecycle.STOP_EVENT event.
      Specified by:
      stopInternal in class LifecycleBase
      Throws:
      LifecycleException - Stop error occurred

    • destroyInternal

      protected final void destroyInternal() throws LifecycleException
      Description copied from class: LifecycleBase
      Sub-classes implement this method to perform any instance destruction required.
      Specified by:
      destroyInternal in class LifecycleBase
      Throws:
      LifecycleException - If the destruction fails