Package org.apache.catalina.storeconfig
Class StoreFactoryBase
java.lang.Object
org.apache.catalina.storeconfig.StoreFactoryBase
- All Implemented Interfaces:
IStoreFactory
- Direct Known Subclasses:
CatalinaClusterSF
,ChannelSF
,ConnectorSF
,CredentialHandlerSF
,GlobalNamingResourcesSF
,InterceptorSF
,JarScannerSF
,LoaderSF
,ManagerSF
,NamingResourcesSF
,OpenSSLConfSF
,PersistentManagerSF
,RealmSF
,SenderSF
,SSLHostConfigSF
,StandardContextSF
,StandardEngineSF
,StandardHostSF
,StandardServerSF
,StandardServiceSF
,WatchedResourceSF
,WebResourceRootSF
,WrapperLifecycleSF
,WrapperListenerSF
StoreFactory saves special elements. Output was generate with StoreAppenders.
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final StringManager
The string manager for this package. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetInfo()
void
setRegistry
(StoreRegistry aRegistry) Set the registry.void
setStoreAppender
(StoreAppender storeAppender) Set the store appender.void
store
(PrintWriter aWriter, int indent, Object aElement) Store a server.xml element with attributes and children.void
storeChildren
(PrintWriter aWriter, int indent, Object aElement, StoreDescription elementDesc) Must Implement at subclass for custom store children handling.protected void
storeElement
(PrintWriter aWriter, int indent, Object aTagElement) Store only elements from storeChildren methods that are not a transient child.protected void
storeElementArray
(PrintWriter aWriter, int indent, Object[] elements) Save an array of elements.void
storeXMLHead
(PrintWriter aWriter) Store XML header.
-
Field Details
-
sm
The string manager for this package.
-
-
Constructor Details
-
StoreFactoryBase
public StoreFactoryBase()
-
-
Method Details
-
getInfo
- Returns:
- descriptive information about this Factory implementation and the corresponding version number, in the
format
<description>/<version>
.
-
getStoreAppender
- Specified by:
getStoreAppender
in interfaceIStoreFactory
- Returns:
- the writer
-
setStoreAppender
Description copied from interface:IStoreFactory
Set the store appender.- Specified by:
setStoreAppender
in interfaceIStoreFactory
- Parameters:
storeAppender
- the writer
-
setRegistry
Description copied from interface:IStoreFactory
Set the registry.- Specified by:
setRegistry
in interfaceIStoreFactory
- Parameters:
aRegistry
- the registry to be associated with
-
getRegistry
- Specified by:
getRegistry
in interfaceIStoreFactory
- Returns:
- the associated registry
-
storeXMLHead
Description copied from interface:IStoreFactory
Store XML header.- Specified by:
storeXMLHead
in interfaceIStoreFactory
- Parameters:
aWriter
- the writer to write to
-
store
Description copied from interface:IStoreFactory
Store a server.xml element with attributes and children.- Specified by:
store
in interfaceIStoreFactory
- Parameters:
aWriter
- the writer to write toindent
- the indentationaElement
- the element to write- Throws:
Exception
- if an error occurs
-
storeChildren
public void storeChildren(PrintWriter aWriter, int indent, Object aElement, StoreDescription elementDesc) throws Exception Must Implement at subclass for custom store children handling.- Parameters:
aWriter
- Current output writerindent
- Indentation levelaElement
- Current elementelementDesc
- The element description- Throws:
Exception
- Configuration storing error
-
storeElement
Store only elements from storeChildren methods that are not a transient child.- Parameters:
aWriter
- Current output writerindent
- Indentation levelaTagElement
- Current element- Throws:
Exception
- Configuration storing error
-
storeElementArray
protected void storeElementArray(PrintWriter aWriter, int indent, Object[] elements) throws Exception Save an array of elements.- Parameters:
aWriter
- Current output writerindent
- Indentation levelelements
- Array of elements- Throws:
Exception
- Configuration storing error
-