Package org.apache.catalina.storeconfig
Class StoreConfig
- java.lang.Object
-
- org.apache.catalina.storeconfig.StoreConfig
-
- All Implemented Interfaces:
IStoreConfig
public class StoreConfig extends java.lang.Object implements IStoreConfig
Store Server/Service/Host/Context at file or PrintWriter. Default server.xml is at $catalina.base/conf/server.xml
-
-
Field Summary
Fields Modifier and Type Field Description protected static StringManager
sm
-
Constructor Summary
Constructors Constructor Description StoreConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StoreRegistry
getRegistry()
Get Configuration RegistryServer
getServer()
Get associated serverjava.lang.String
getServerFilename()
Get server.xml locationvoid
setRegistry(StoreRegistry aRegistry)
Set Configuration Registryvoid
setServer(Server aServer)
Set associated servervoid
setServerFilename(java.lang.String string)
Set new server.xml location.void
store(java.io.PrintWriter aWriter, int indent, Context aContext)
Store the specified Context properties.void
store(java.io.PrintWriter aWriter, int indent, Host aHost)
Store the specified Host properties.void
store(java.io.PrintWriter writer, int indent, Server aServer)
Store the specified Server properties.void
store(java.io.PrintWriter aWriter, int indent, Service aService)
Store the specified Service properties.boolean
store(Context aContext)
Store the specified Context properties.boolean
store(Server aServer)
Write the configuration information for this entireServer
out to the server.xml configuration file.void
storeConfig()
Store the current StoreFactory Server.void
storeContext(java.lang.String aContextName, boolean backup, boolean externalAllowed)
Store a Context from ObjectName.void
storeServer(java.lang.String aServerName, boolean backup, boolean externalAllowed)
Store Server from Object Name (Catalina:type=Server).
-
-
-
Field Detail
-
sm
protected static final StringManager sm
-
-
Method Detail
-
getServerFilename
public java.lang.String getServerFilename()
Get server.xml location- Returns:
- The server file name
-
setServerFilename
public void setServerFilename(java.lang.String string)
Set new server.xml location.- Parameters:
string
- The server.xml location
-
getRegistry
public StoreRegistry getRegistry()
Description copied from interface:IStoreConfig
Get Configuration Registry- Specified by:
getRegistry
in interfaceIStoreConfig
- Returns:
- aRegistry that handle the store operations
-
setServer
public void setServer(Server aServer)
Description copied from interface:IStoreConfig
Set associated server- Specified by:
setServer
in interfaceIStoreConfig
- Parameters:
aServer
- the associated server
-
getServer
public Server getServer()
Description copied from interface:IStoreConfig
Get associated server- Specified by:
getServer
in interfaceIStoreConfig
- Returns:
- aServer the associated server
-
setRegistry
public void setRegistry(StoreRegistry aRegistry)
Description copied from interface:IStoreConfig
Set Configuration Registry- Specified by:
setRegistry
in interfaceIStoreConfig
- Parameters:
aRegistry
- aregistry that handle the store operations
-
storeConfig
public void storeConfig()
Description copied from interface:IStoreConfig
Store the current StoreFactory Server.- Specified by:
storeConfig
in interfaceIStoreConfig
-
storeServer
public void storeServer(java.lang.String aServerName, boolean backup, boolean externalAllowed) throws javax.management.MalformedObjectNameException
Store Server from Object Name (Catalina:type=Server).- Parameters:
aServerName
- Server ObjectNamebackup
-true
to backup existing configuration files before rewriting themexternalAllowed
-true
to allow saving webapp configuration for webapps that are not inside the host's app directory- Throws:
javax.management.MalformedObjectNameException
- Bad MBean name
-
storeContext
public void storeContext(java.lang.String aContextName, boolean backup, boolean externalAllowed) throws javax.management.MalformedObjectNameException
Store a Context from ObjectName.- Parameters:
aContextName
- MBean ObjectNamebackup
-true
to backup existing configuration files before rewriting themexternalAllowed
-true
to allow saving webapp configuration for webapps that are not inside the host's app directory- Throws:
javax.management.MalformedObjectNameException
- Bad MBean name
-
store
public boolean store(Server aServer)
Description copied from interface:IStoreConfig
Write the configuration information for this entireServer
out to the server.xml configuration file.- Specified by:
store
in interfaceIStoreConfig
- Parameters:
aServer
- Server instance- Returns:
true
if the store operation was successful
-
store
public boolean store(Context aContext)
Description copied from interface:IStoreConfig
Store the specified Context properties.- Specified by:
store
in interfaceIStoreConfig
- Parameters:
aContext
- Object to be stored- Returns:
true
if the store operation was successful
-
store
public void store(java.io.PrintWriter aWriter, int indent, Context aContext) throws java.lang.Exception
Description copied from interface:IStoreConfig
Store the specified Context properties.- Specified by:
store
in interfaceIStoreConfig
- Parameters:
aWriter
- PrintWriter to which we are storingindent
- Number of spaces to indent this elementaContext
- Object to be stored- Throws:
java.lang.Exception
- Store error occurred
-
store
public void store(java.io.PrintWriter aWriter, int indent, Host aHost) throws java.lang.Exception
Description copied from interface:IStoreConfig
Store the specified Host properties.- Specified by:
store
in interfaceIStoreConfig
- Parameters:
aWriter
- PrintWriter to which we are storingindent
- Number of spaces to indent this elementaHost
- Object to be stored- Throws:
java.lang.Exception
- Store error occurred
-
store
public void store(java.io.PrintWriter aWriter, int indent, Service aService) throws java.lang.Exception
Description copied from interface:IStoreConfig
Store the specified Service properties.- Specified by:
store
in interfaceIStoreConfig
- Parameters:
aWriter
- PrintWriter to which we are storingindent
- Number of spaces to indent this elementaService
- Object to be stored- Throws:
java.lang.Exception
- Store error occurred
-
store
public void store(java.io.PrintWriter writer, int indent, Server aServer) throws java.lang.Exception
Description copied from interface:IStoreConfig
Store the specified Server properties.- Specified by:
store
in interfaceIStoreConfig
- Parameters:
writer
- PrintWriter to which we are storingindent
- Number of spaces to indent this elementaServer
- Object to be stored- Throws:
java.lang.Exception
- Store error occurred
-
-