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
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
Lifecycle.SingleUse
-
-
Field Summary
Fields Modifier and Type Field Description protected static StringManagersm-
Fields inherited from interface org.apache.catalina.Lifecycle
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
-
-
Constructor Summary
Constructors Constructor Description AbstractResourceSet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidcheckPath(java.lang.String path)protected voiddestroyInternal()Sub-classes implement this method to perform any instance destruction required.protected java.lang.StringgetBase()booleangetClassLoaderOnly()Should resources returned by this resource set only be included in any results when the lookup is explicitly looking for class loader resources.protected java.lang.StringgetInternalPath()protected java.util.jar.ManifestgetManifest()protected WebResourceRootgetRoot()booleangetStaticOnly()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.protected java.lang.StringgetWebAppMount()voidsetBase(java.lang.String base)voidsetClassLoaderOnly(boolean classLoaderOnly)voidsetInternalPath(java.lang.String internalPath)protected voidsetManifest(java.util.jar.Manifest manifest)voidsetRoot(WebResourceRoot root)voidsetStaticOnly(boolean staticOnly)voidsetWebAppMount(java.lang.String webAppMount)protected voidstartInternal()Sub-classes must ensure that the state is changed toLifecycleState.STARTINGduring the execution of this method.protected voidstopInternal()Sub-classes must ensure that the state is changed toLifecycleState.STOPPINGduring the execution of this method.-
Methods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, initInternal, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.catalina.Lifecycle
addLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
-
Methods inherited from interface org.apache.catalina.WebResourceSet
gc, getBaseUrl, getResource, isReadOnly, list, listWebAppPaths, mkdir, setReadOnly, write
-
-
-
-
Field Detail
-
sm
protected static final StringManager sm
-
-
Method Detail
-
checkPath
protected final void checkPath(java.lang.String path)
-
setRoot
public final void setRoot(WebResourceRoot root)
- Specified by:
setRootin interfaceWebResourceSet
-
getRoot
protected final WebResourceRoot getRoot()
-
getInternalPath
protected final java.lang.String getInternalPath()
-
setInternalPath
public final void setInternalPath(java.lang.String internalPath)
-
setWebAppMount
public final void setWebAppMount(java.lang.String webAppMount)
-
getWebAppMount
protected final java.lang.String getWebAppMount()
-
setBase
public final void setBase(java.lang.String base)
-
getBase
protected final java.lang.String getBase()
-
getClassLoaderOnly
public boolean getClassLoaderOnly()
Description copied from interface:WebResourceSetShould 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:
getClassLoaderOnlyin interfaceWebResourceSet- Returns:
trueif these resources should only be used for class loader resource lookups, otherwisefalse
-
setClassLoaderOnly
public void setClassLoaderOnly(boolean classLoaderOnly)
- Specified by:
setClassLoaderOnlyin interfaceWebResourceSet
-
getStaticOnly
public boolean getStaticOnly()
Description copied from interface:WebResourceSetShould 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:
getStaticOnlyin interfaceWebResourceSet- Returns:
trueif these resources should only be used for static (non-class loader) resource lookups, otherwisefalse
-
setStaticOnly
public void setStaticOnly(boolean staticOnly)
- Specified by:
setStaticOnlyin interfaceWebResourceSet
-
setManifest
protected final void setManifest(java.util.jar.Manifest manifest)
-
getManifest
protected final java.util.jar.Manifest getManifest()
-
startInternal
protected final void startInternal() throws LifecycleExceptionDescription copied from class:LifecycleBaseSub-classes must ensure that the state is changed toLifecycleState.STARTINGduring the execution of this method. Changing state will trigger theLifecycle.START_EVENTevent. If a component fails to start it may either throw aLifecycleExceptionwhich will cause it's parent to fail to start or it can place itself in the error state in which caseLifecycleBase.stop()will be called on the failed component but the parent component will continue to start normally.- Specified by:
startInternalin classLifecycleBase- Throws:
LifecycleException- Start error occurred
-
stopInternal
protected final void stopInternal() throws LifecycleExceptionDescription copied from class:LifecycleBaseSub-classes must ensure that the state is changed toLifecycleState.STOPPINGduring the execution of this method. Changing state will trigger theLifecycle.STOP_EVENTevent.- Specified by:
stopInternalin classLifecycleBase- Throws:
LifecycleException- Stop error occurred
-
destroyInternal
protected final void destroyInternal() throws LifecycleExceptionDescription copied from class:LifecycleBaseSub-classes implement this method to perform any instance destruction required.- Specified by:
destroyInternalin classLifecycleBase- Throws:
LifecycleException- If the destruction fails
-
-