Author: markt
Date: Sun Dec 14 18:02:24 2014
New Revision: 1645480
URL: http://svn.apache.org/r1645480
Log:
Back-port various StoreConfig improvements:
- Consistently handle missing StoreConfig MBean for Server and Context case.
- Improve integration with Manager application
- Partial revert of r1645466 since MBean should be hard-coded
- Remove dependency on StandardServer
Modified:
tomcat/tc8.0.x/trunk/ (props changed)
tomcat/tc8.0.x/trunk/java/org/apache/catalina/core/LocalStrings.properties
tomcat/tc8.0.x/trunk/java/org/apache/catalina/core/StandardServer.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/manager/LocalStrings.properties
tomcat/tc8.0.x/trunk/java/org/apache/catalina/manager/ManagerServlet.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/storeconfig/LocalStrings.properties
tomcat/tc8.0.x/trunk/java/org/apache/catalina/storeconfig/StoreConfigLifecycleListener.java
tomcat/tc8.0.x/trunk/test/org/apache/catalina/mbeans/TestRegistration.java
tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml
Propchange: tomcat/tc8.0.x/trunk/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Sun Dec 14 18:02:24 2014
@@ -1 +1 @@
-/tomcat/trunk:1636524,1637156,1637176,1637188,1637331,1637684,1637695,1638720-1638725,1639653,1640010,1640083-1640084,1640088,1640275,1640322,1640347,1640361,1640365,1640403,1640410,1640652,1640655-1640658,1640688,1640700-1640883,1640903,1640976,1640978,1641000,1641026,1641038-1641039,1641051-1641052,1641058,1641064,1641300,1641369,1641374,1641380,1641486,1641634,1641656-1641692,1641704,1641707-1641718,1641720-1641722,1641735,1641981,1642233,1642280,1642554,1642564,1642595,1642606,1642668,1642679,1642697,1642699,1642766,1643002,1643045,1643054-1643055,1643066,1643121,1643128,1643206,1643209-1643210,1643216,1643249,1643270,1643283,1643309-1643310,1643323,1643365-1643366,1643370-1643371,1643465,1643474,1643536,1643570,1643634,1643649,1643651,1643654,1643675,1643731,1643733-1643734,1643761,1643766,1643814,1643937,1643963,1644017,1644169,1644201-1644203,1644321,1644323,1644516,1644523,1644529,1644535,1644730,1644768,1644784-1644785,1644790,1644793,1644815,1644884,1644886,1644890,1644892
,1644910,1644924,1644929-1644930,1644935,1644989,1645011,1645247,1645355,1645357,1645455,1645465
+/tomcat/trunk:1636524,1637156,1637176,1637188,1637331,1637684,1637695,1638720-1638725,1639653,1640010,1640083-1640084,1640088,1640275,1640322,1640347,1640361,1640365,1640403,1640410,1640652,1640655-1640658,1640688,1640700-1640883,1640903,1640976,1640978,1641000,1641026,1641038-1641039,1641051-1641052,1641058,1641064,1641300,1641369,1641374,1641380,1641486,1641634,1641656-1641692,1641704,1641707-1641718,1641720-1641722,1641735,1641981,1642233,1642280,1642554,1642564,1642595,1642606,1642668,1642679,1642697,1642699,1642766,1643002,1643045,1643054-1643055,1643066,1643121,1643128,1643206,1643209-1643210,1643216,1643249,1643270,1643283,1643309-1643310,1643323,1643365-1643366,1643370-1643371,1643465,1643474,1643536,1643570,1643634,1643649,1643651,1643654,1643675,1643731,1643733-1643734,1643761,1643766,1643814,1643937,1643963,1644017,1644169,1644201-1644203,1644321,1644323,1644516,1644523,1644529,1644535,1644730,1644768,1644784-1644785,1644790,1644793,1644815,1644884,1644886,1644890,1644892
,1644910,1644924,1644929-1644930,1644935,1644989,1645011,1645247,1645355,1645357,1645455,1645465,1645469,1645471,1645473,1645475
Modified:
tomcat/tc8.0.x/trunk/java/org/apache/catalina/core/LocalStrings.properties
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/core/LocalStrings.properties?rev=1645480&r1=1645479&r2=1645480&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/core/LocalStrings.properties
(original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/core/LocalStrings.properties
Sun Dec 14 18:02:24 2014
@@ -166,8 +166,9 @@ standardHost.invalidErrorReportValveClas
standardHost.noContext=No Context configured to process this request
standardHost.notContext=Child of a Host must be a Context
standardHost.nullName=Host name is required
-standardServer.shutdownViaPort=A valid shutdown command was received via the
shutdown port. Stopping the Server instance.
standardServer.accept.timeout=The socket listening for the shutdown command
experienced an unexpected timeout [{0}] milliseconds after the call to
accept(). Is this an instance of bug 56684?
+standardServer.shutdownViaPort=A valid shutdown command was received via the
shutdown port. Stopping the Server instance.
+standardServer.storeConfig.notAvailable=No StoreConfig implementation was
registered as an MBean named [{0}] so no configuration could be saved. A
suitable MBean is normally registered via the StoreConfigLifecyleListener.
standardService.connector.initFailed=Failed to initialize connector [{0}]
standardService.connector.pauseFailed=Failed to pause connector [{0}]
standardService.connector.startFailed=Failed to start connector [{0}]
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/core/StandardServer.java
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/core/StandardServer.java?rev=1645480&r1=1645479&r2=1645480&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/core/StandardServer.java
(original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/core/StandardServer.java Sun
Dec 14 18:02:24 2014
@@ -689,8 +689,18 @@ public final class StandardServer extend
* if an exception is reported by the persistence mechanism
*/
public synchronized void storeConfig() throws Exception {
- ObjectName sname = new ObjectName(getDomain() + ":type=StoreConfig");
- mserver.invoke(sname, "storeConfig", null, null);
+ try {
+ // Note: Hard-coded domain used since this object is per Server/JVM
+ ObjectName sname = new ObjectName("Catalina:type=StoreConfig");
+ if (mserver.isRegistered(sname)) {
+ mserver.invoke(sname, "storeConfig", null, null);
+ } else {
+
log.error(sm.getString("standardServer.storeConfig.notAvailable", sname));
+ }
+ } catch (Throwable t) {
+ ExceptionUtils.handleThrowable(t);
+ log.error(t);
+ }
}
@@ -706,21 +716,20 @@ public final class StandardServer extend
* by the persistence mechanism
*/
public synchronized void storeContext(Context context) throws Exception {
-
- ObjectName sname = null;
try {
- sname = new ObjectName(getDomain() + ":type=StoreConfig");
- if(mserver.isRegistered(sname)) {
- mserver.invoke(sname, "store",
- new Object[] {context},
- new String [] { "java.lang.String"});
- } else
- log.error("StoreConfig mbean not registered" + sname);
+ // Note: Hard-coded domain used since this object is per Server/JVM
+ ObjectName sname = new ObjectName("Catalina:type=StoreConfig");
+ if (mserver.isRegistered(sname)) {
+ mserver.invoke(sname, "store",
+ new Object[] {context},
+ new String [] { "java.lang.String"});
+ } else {
+
log.error(sm.getString("standardServer.storeConfig.notAvailable", sname));
+ }
} catch (Throwable t) {
ExceptionUtils.handleThrowable(t);
log.error(t);
}
-
}
Modified:
tomcat/tc8.0.x/trunk/java/org/apache/catalina/manager/LocalStrings.properties
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/manager/LocalStrings.properties?rev=1645480&r1=1645479&r2=1645480&view=diff
==============================================================================
---
tomcat/tc8.0.x/trunk/java/org/apache/catalina/manager/LocalStrings.properties
(original)
+++
tomcat/tc8.0.x/trunk/java/org/apache/catalina/manager/LocalStrings.properties
Sun Dec 14 18:02:24 2014
@@ -111,6 +111,8 @@ managerServlet.sslConnectorCiphers=OK -
managerServlet.started=OK - Started application at context path {0}
managerServlet.startFailed=FAIL - Application at context path {0} could not be
started
managerServlet.stopped=OK - Stopped application at context path {0}
+managerServlet.storeConfig.invalidMBean=FAIL - Unable to find the StoreConfig
Mbean. [{0}] is not a valid name for an MBean.
+managerServlet.storeConfig.noMBean=FAIL - No StoreConfig MBean registered at
[{0}]. Registration is typically performed by the StoreConfigLifecycleListener.
managerServlet.threaddump=OK - JVM thread dump
managerServlet.undeployed=OK - Undeployed application at context path {0}
managerServlet.unknownCommand=FAIL - Unknown command {0}
Modified:
tomcat/tc8.0.x/trunk/java/org/apache/catalina/manager/ManagerServlet.java
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/manager/ManagerServlet.java?rev=1645480&r1=1645479&r2=1645480&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/manager/ManagerServlet.java
(original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/manager/ManagerServlet.java
Sun Dec 14 18:02:24 2014
@@ -30,6 +30,7 @@ import java.util.Map;
import java.util.Set;
import javax.management.MBeanServer;
+import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;
import javax.naming.Binding;
import javax.naming.NamingEnumeration;
@@ -53,7 +54,6 @@ import org.apache.catalina.Session;
import org.apache.catalina.Wrapper;
import org.apache.catalina.connector.Connector;
import org.apache.catalina.core.StandardHost;
-import org.apache.catalina.core.StandardServer;
import org.apache.catalina.startup.ExpandWar;
import org.apache.catalina.util.ContextName;
import org.apache.catalina.util.RequestUtil;
@@ -575,22 +575,32 @@ public class ManagerServlet extends Http
/**
* Store server configuration.
*
- * @param path Optional context path to save
+ * @param writer Destination for any user message(s) during this
operation
+ * @param path Optional context path to save
+ * @param smClient i18n support for current client's locale
*/
- protected synchronized void save(PrintWriter writer, String path,
- StringManager smClient) {
+ protected synchronized void save(PrintWriter writer, String path,
StringManager smClient) {
- Server server = ((Engine)host.getParent()).getService().getServer();
+ ObjectName storeConfigOname;
+ try {
+ // Note: Hard-coded domain used since this object is per Server/JVM
+ storeConfigOname = new ObjectName("Catalina:type=StoreConfig");
+ } catch (MalformedObjectNameException e) {
+ // Should never happen. The name above is valid.
+ log(sm.getString("managerServlet.exception"), e);
+ writer.println(smClient.getString("managerServlet.exception",
e.toString()));
+ return;
+ }
- if (!(server instanceof StandardServer)) {
- writer.println(smClient.getString("managerServlet.saveFail",
- server));
+ if (!mBeanServer.isRegistered(storeConfigOname)) {
+ writer.println(smClient.getString(
+ "managerServlet.storeConfig.noMBean", storeConfigOname));
return;
}
if ((path == null) || path.length() == 0 || !path.startsWith("/")) {
try {
- ((StandardServer) server).storeConfig();
+ mBeanServer.invoke(storeConfigOname, "storeConfig", null,
null);
writer.println(smClient.getString("managerServlet.saved"));
} catch (Exception e) {
log("managerServlet.storeConfig", e);
@@ -610,7 +620,9 @@ public class ManagerServlet extends Http
return;
}
try {
- ((StandardServer) server).storeContext(context);
+ mBeanServer.invoke(storeConfigOname, "store",
+ new Object[] {context},
+ new String [] { "java.lang.String"});
writer.println(smClient.getString("managerServlet.savedContext",
path));
} catch (Exception e) {
@@ -620,7 +632,6 @@ public class ManagerServlet extends Http
return;
}
}
-
}
Modified:
tomcat/tc8.0.x/trunk/java/org/apache/catalina/storeconfig/LocalStrings.properties
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/storeconfig/LocalStrings.properties?rev=1645480&r1=1645479&r2=1645480&view=diff
==============================================================================
---
tomcat/tc8.0.x/trunk/java/org/apache/catalina/storeconfig/LocalStrings.properties
(original)
+++
tomcat/tc8.0.x/trunk/java/org/apache/catalina/storeconfig/LocalStrings.properties
Sun Dec 14 18:02:24 2014
@@ -13,7 +13,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-factory.storeTag=store tag {0} ( Object: {1} )
-factory.storeNoDescriptor=Descriptor for element class {0} not configured!
config.storeServerError=Error storing server
config.storeContextError=Error storing context {0}
+factory.storeTag=store tag {0} ( Object: {1} )
+factory.storeNoDescriptor=Descriptor for element class {0} not configured!
+storeConfigListener.notServer=The listener was added to component other than
the Server and will therefore be ignored
\ No newline at end of file
Modified:
tomcat/tc8.0.x/trunk/java/org/apache/catalina/storeconfig/StoreConfigLifecycleListener.java
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/storeconfig/StoreConfigLifecycleListener.java?rev=1645480&r1=1645479&r2=1645480&view=diff
==============================================================================
---
tomcat/tc8.0.x/trunk/java/org/apache/catalina/storeconfig/StoreConfigLifecycleListener.java
(original)
+++
tomcat/tc8.0.x/trunk/java/org/apache/catalina/storeconfig/StoreConfigLifecycleListener.java
Sun Dec 14 18:02:24 2014
@@ -22,19 +22,23 @@ import javax.management.ObjectName;
import org.apache.catalina.Lifecycle;
import org.apache.catalina.LifecycleEvent;
import org.apache.catalina.LifecycleListener;
-import org.apache.catalina.core.StandardServer;
+import org.apache.catalina.Server;
import org.apache.catalina.mbeans.MBeanUtils;
import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;
import org.apache.tomcat.util.modeler.ManagedBean;
import org.apache.tomcat.util.modeler.Registry;
+import org.apache.tomcat.util.res.StringManager;
/**
- * Load and Register StoreConfig MBean
<i>Catalina:type=StoreConfig,resource="url"</i>
+ * Loads and registers a StoreConfig MBean with the name
+ * <i>Catalina:type=StoreConfig</i>. This listener should only be used with a
+ * {@link Server}.
*/
public class StoreConfigLifecycleListener implements LifecycleListener {
- private static Log log = LogFactory
- .getLog(StoreConfigLifecycleListener.class);
+
+ private static Log log =
LogFactory.getLog(StoreConfigLifecycleListener.class);
+ private static StringManager sm =
StringManager.getManager(StoreConfigLifecycleListener.class);
/**
* The configuration information registry for our managed beans.
@@ -57,8 +61,10 @@ public class StoreConfigLifecycleListene
@Override
public void lifecycleEvent(LifecycleEvent event) {
if (Lifecycle.AFTER_START_EVENT.equals(event.getType())) {
- if (event.getSource() instanceof StandardServer) {
- createMBean((StandardServer) event.getSource());
+ if (event.getSource() instanceof Server) {
+ createMBean((Server) event.getSource());
+ } else {
+ log.warn(sm.getString("storeConfigListener.notServer"));
}
} else if (Lifecycle.AFTER_STOP_EVENT.equals(event.getType())) {
if (oname != null) {
@@ -72,7 +78,7 @@ public class StoreConfigLifecycleListene
* create StoreConfig MBean and load StoreRgistry MBeans name is
* <i>Catalina:type=StoreConfig </i>
*/
- protected void createMBean(StandardServer server) {
+ protected void createMBean(Server server) {
StoreLoader loader = new StoreLoader();
try {
Class<?> clazz = Class.forName(getStoreConfigClass(), true, this
@@ -82,7 +88,7 @@ public class StoreConfigLifecycleListene
// default Loading
loader.load();
else
- // load a spezial file registry (url)
+ // load a special file registry (url)
loader.load(getStoreRegistry());
// use the loader Registry
storeConfig.setRegistry(loader.getRegistry());
@@ -92,7 +98,8 @@ public class StoreConfigLifecycleListene
return;
}
try {
- oname = new ObjectName(server.getDomain() + ":type=StoreConfig" );
+ // Note: Hard-coded domain used since this object is per Server/JVM
+ oname = new ObjectName("Catalina:type=StoreConfig" );
registry.registerComponent(storeConfig, oname, "StoreConfig");
} catch (Exception ex) {
log.error("createMBean register MBean", ex);
Modified:
tomcat/tc8.0.x/trunk/test/org/apache/catalina/mbeans/TestRegistration.java
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/test/org/apache/catalina/mbeans/TestRegistration.java?rev=1645480&r1=1645479&r2=1645480&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/test/org/apache/catalina/mbeans/TestRegistration.java
(original)
+++ tomcat/tc8.0.x/trunk/test/org/apache/catalina/mbeans/TestRegistration.java
Sun Dec 14 18:02:24 2014
@@ -42,7 +42,6 @@ import org.apache.catalina.realm.Combine
import org.apache.catalina.realm.NullRealm;
import org.apache.catalina.startup.Tomcat;
import org.apache.catalina.startup.TomcatBaseTest;
-import org.apache.catalina.storeconfig.StoreConfigLifecycleListener;
import org.apache.tomcat.util.modeler.Registry;
/**
@@ -77,7 +76,6 @@ public class TestRegistration extends To
"Tomcat:type=Server",
"Tomcat:type=Service",
"Tomcat:type=StringCache",
- "Tomcat:type=StoreConfig",
"Tomcat:type=Valve,name=StandardEngineValve",
};
}
@@ -160,9 +158,6 @@ public class TestRegistration extends To
assertEquals("Unexpected: " + onames, 0, onames.size());
final Tomcat tomcat = getTomcatInstance();
-
- tomcat.getServer().addLifecycleListener(new
StoreConfigLifecycleListener());
-
final File contextDir = new File(getTemporaryDirectory(), "webappFoo");
addDeleteOnTearDown(contextDir);
if (!contextDir.mkdirs() && !contextDir.isDirectory()) {
Modified: tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml?rev=1645480&r1=1645479&r2=1645480&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml Sun Dec 14 18:02:24 2014
@@ -170,9 +170,10 @@
been re-written by the RewriteValve. (markt)
</fix>
<fix>
- Don't hard-code the domain of the StoreConfig MBean to
- <code>Catalina</code> but use the domain name configured for the
- associated server. (markt)
+ Various StoreConfig improvements including removing a dependency on the
+ <code>StandardServer</code> implementation, improve consistency of
+ behaviour when MBean is not registered and improve error messages when
+ accessed via the Manager application. (markt)
</fix>
</changelog>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
