Top Fields Constructors Methods
org.apache.catalina.webresources

public abstract Class AbstractResourceSet

extends LifecycleBase
implements WebResourceSet
Class Inheritance
All Implemented Interfaces
org.apache.catalina.WebResourceSet, org.apache.catalina.Lifecycle
Known Direct Subclasses
org.apache.catalina.webresources.AbstractArchiveResourceSet, org.apache.catalina.webresources.AbstractFileResourceSet
Imports
java.util.jar.Manifest, org.apache.catalina.LifecycleException, .LifecycleState, .WebResourceRoot, .WebResourceSet, org.apache.catalina.util.LifecycleBase, org.apache.tomcat.util.res.StringManager

Field Summary

Modifier and TypeField and Description
private String
base

private boolean
classLoaderOnly

private String
internalPath

private Manifest
manifest

private WebResourceRoot
root

protected static final StringManager
sm

Hides org.apache.catalina.util.LifecycleBase.sm.

private boolean
staticOnly

private String
webAppMount

Constructor Summary

AccessConstructor and Description
public
AbstractResourceSet()

Method Summary

Modifier and TypeMethod and Description
protected final void
checkPath(String path)

protected final void
destroyInternal()

Implements abstract org.apache.catalina.util.LifecycleBase.destroyInternal.

Sub-classes implement this method to perform any instance destruction required.

protected final String
getBase()

public boolean
getClassLoaderOnly()

Implements org.apache.catalina.WebResourceSet.getClassLoaderOnly.

Should resources returned by this resource set only be included in any results when the lookup is explicitly looking for class loader resources.

protected final String
getInternalPath()

protected final Manifest
getManifest()

protected final WebResourceRoot
getRoot()

public boolean
getStaticOnly()

Implements org.apache.catalina.WebResourceSet.getStaticOnly.

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.

protected final String
getWebAppMount()

public final void
setBase(String base)

public void
setClassLoaderOnly(boolean classLoaderOnly)

Implements org.apache.catalina.WebResourceSet.setClassLoaderOnly.

public final void
setInternalPath(String internalPath)

protected final void
setManifest(Manifest manifest)

public final void
setRoot(WebResourceRoot root)

Implements org.apache.catalina.WebResourceSet.setRoot.

public void
setStaticOnly(boolean staticOnly)

Implements org.apache.catalina.WebResourceSet.setStaticOnly.

public final void
setWebAppMount(String webAppMount)

protected final void
startInternal()

Implements abstract org.apache.catalina.util.LifecycleBase.startInternal.

Sub-classes must ensure that the state is changed to LifecycleState#STARTING during the execution of this method.

protected final void
stopInternal()

Implements abstract org.apache.catalina.util.LifecycleBase.stopInternal.

Sub-classes must ensure that the state is changed to LifecycleState#STOPPING during the execution of this method.

Inherited from org.apache.catalina.util.LifecycleBase:
addLifecycleListenerdestroyfindLifecycleListenersfireLifecycleEventgetStategetStateNamegetThrowOnFailureinitinitInternalremoveLifecycleListenersetStatesetStatesetThrowOnFailurestartstop

Field Detail

baseback to summary
private String base
classLoaderOnlyback to summary
private boolean classLoaderOnly
internalPathback to summary
private String internalPath
manifestback to summary
private Manifest manifest
rootback to summary
private WebResourceRoot root
smback to summary
protected static final StringManager sm

Hides org.apache.catalina.util.LifecycleBase.sm.

staticOnlyback to summary
private boolean staticOnly
webAppMountback to summary
private String webAppMount

Constructor Detail

AbstractResourceSetback to summary
public AbstractResourceSet()

Method Detail

checkPathback to summary
protected final void checkPath(String path)
destroyInternalback to summary
protected final void destroyInternal() throws LifecycleException

Implements abstract org.apache.catalina.util.LifecycleBase.destroyInternal.

Doc from org.apache.catalina.util.LifecycleBase.destroyInternal.

Sub-classes implement this method to perform any instance destruction required.

Annotations
@Override
Exceptions
LifecycleException:
If the destruction fails
getBaseback to summary
protected final String getBase()
getClassLoaderOnlyback to summary
public boolean getClassLoaderOnly()

Implements org.apache.catalina.WebResourceSet.getClassLoaderOnly.

Doc from org.apache.catalina.WebResourceSet.getClassLoaderOnly.

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.

Returns:boolean

true if these resources should only be used for class loader resource lookups, otherwise false

Annotations
@Override
getInternalPathback to summary
protected final String getInternalPath()
getManifestback to summary
protected final Manifest getManifest()
getRootback to summary
protected final WebResourceRoot getRoot()
getStaticOnlyback to summary
public boolean getStaticOnly()

Implements org.apache.catalina.WebResourceSet.getStaticOnly.

Doc from org.apache.catalina.WebResourceSet.getStaticOnly.

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.

Returns:boolean

true if these resources should only be used for static (non-class loader) resource lookups, otherwise false

Annotations
@Override
getWebAppMountback to summary
protected final String getWebAppMount()
setBaseback to summary
public final void setBase(String base)
setClassLoaderOnlyback to summary
public void setClassLoaderOnly(boolean classLoaderOnly)

Implements org.apache.catalina.WebResourceSet.setClassLoaderOnly.

Annotations
@Override
setInternalPathback to summary
public final void setInternalPath(String internalPath)
setManifestback to summary
protected final void setManifest(Manifest manifest)
setRootback to summary
public final void setRoot(WebResourceRoot root)

Implements org.apache.catalina.WebResourceSet.setRoot.

Annotations
@Override
setStaticOnlyback to summary
public void setStaticOnly(boolean staticOnly)

Implements org.apache.catalina.WebResourceSet.setStaticOnly.

Annotations
@Override
setWebAppMountback to summary
public final void setWebAppMount(String webAppMount)
startInternalback to summary
protected final void startInternal() throws LifecycleException

Implements abstract org.apache.catalina.util.LifecycleBase.startInternal.

Doc from org.apache.catalina.util.LifecycleBase.startInternal.

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 stop() will be called on the failed component but the parent component will continue to start normally.

Annotations
@Override
Exceptions
LifecycleException:
Start error occurred
stopInternalback to summary
protected final void stopInternal() throws LifecycleException

Implements abstract org.apache.catalina.util.LifecycleBase.stopInternal.

Doc from org.apache.catalina.util.LifecycleBase.stopInternal.

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.

Annotations
@Override
Exceptions
LifecycleException:
Stop error occurred