diff options
Diffstat (limited to 'sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org')
7 files changed, 590 insertions, 0 deletions
diff --git a/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/Monitor.java b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/Monitor.java new file mode 100644 index 0000000000..6ee6e705cc --- /dev/null +++ b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/Monitor.java @@ -0,0 +1,162 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.tuscany.sca.monitor; + +import java.util.List; +import org.apache.tuscany.sca.monitor.Problem.Severity; + +/** + * A monitor for the watching for validation problems + * + * @version $Rev$ $Date$ + */ +public abstract class Monitor { + /** + * Reports a build problem. + * + * @param problem + */ + public abstract void problem(Problem problem); + + /** + * Returns a list of reported problems. + * + * @return the list of problems. The list may be empty + */ + public abstract List<Problem> getProblems(); + + /** + * Create a new problem. + * + * @param sourceClassName the class name reporting the problem + * @param bundleName the name of the message bundle to use + * @param severity the severity of the problem + * @param problemObject the model object for which the problem is being reported + * @param messageId the id of the problem message + * @param cause the exception which caused the problem + * @return + */ + public abstract Problem createProblem(String sourceClassName, + String bundleName, + Severity severity, + Object problemObject, + String messageId, + Exception cause); + + /** + * Create a new problem. + * + * @param sourceClassName the class name reporting the problem + * @param bundleName the name of the message bundle to use + * @param severity the severity of the problem + * @param problemObject the model object for which the problem is being reported + * @param messageId the id of the problem message + * @param messageParams the parameters of the problem message + * @return + */ + public abstract Problem createProblem(String sourceClassName, + String bundleName, + Severity severity, + Object problemObject, + String messageId, + Object... messageParams); + + /** + * A utility function for raising a warning. It creates the problem and + * adds it to the monitor + * + * @param monitor + * @param reportingObject + * @param messageBundle + * @param messageId + * @param messageParameters + */ + public static void warning (Monitor monitor, + Object reportingObject, + String messageBundle, + String messageId, + String... messageParameters){ + if (monitor != null) { + Problem problem = + monitor.createProblem(reportingObject.getClass().getName(), + messageBundle, + Severity.WARNING, + null, + messageId, + (Object[])messageParameters); + monitor.problem(problem); + } + } + + /** + * A utility function for raising an error. It creates the problem and + * adds it to the monitor + * + * @param monitor + * @param reportingObject + * @param messageBundle + * @param messageId + * @param messageParameters + */ + public static void error (Monitor monitor, + Object reportingObject, + String messageBundle, + String messageId, + String... messageParameters){ + if (monitor != null) { + Problem problem = + monitor.createProblem(reportingObject.getClass().getName(), + messageBundle, + Severity.ERROR, + null, + messageId, + (Object[])messageParameters); + monitor.problem(problem); + } + } + + /** + * A utility function for raising an error. It creates the problem and + * adds it to the monitor + * + * @param monitor + * @param reportingObject + * @param messageBundle + * @param messageId + * @param exception + */ + public static void error (Monitor monitor, + Object reportingObject, + String messageBundle, + String messageId, + Exception cause){ + if (monitor != null) { + Problem problem = + monitor.createProblem(reportingObject.getClass().getName(), + messageBundle, + Severity.ERROR, + null, + messageId, + cause); + monitor.problem(problem); + } + } + +} diff --git a/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/MonitorFactory.java b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/MonitorFactory.java new file mode 100644 index 0000000000..38c3bbd991 --- /dev/null +++ b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/MonitorFactory.java @@ -0,0 +1,35 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.tuscany.sca.monitor; + +/** + * A factory for validation monitors + * + * @version $Rev$ $Date$ + */ +public interface MonitorFactory { + + /** + * Create a new monitor + * + * @return a new monitor + */ + Monitor createMonitor(); + +} diff --git a/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/MonitorRuntimeException.java b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/MonitorRuntimeException.java new file mode 100644 index 0000000000..90cbe99688 --- /dev/null +++ b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/MonitorRuntimeException.java @@ -0,0 +1,55 @@ +/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.tuscany.sca.monitor;
+
+
+/**
+ * Denotes an exception that has been logged and recorded in the monitor.
+ *
+ * @version $Rev$ $Date$
+ */
+public class MonitorRuntimeException extends RuntimeException {
+ private static final long serialVersionUID = 8972044333077591932L;
+
+ public MonitorRuntimeException() {
+ super();
+ }
+
+ /**
+ * @param message
+ * @param cause
+ */
+ public MonitorRuntimeException(String message, Throwable cause) {
+ super(message, cause);
+ }
+
+ /**
+ * @param message
+ */
+ public MonitorRuntimeException(String message) {
+ super(message);
+ }
+
+ /**
+ * @param cause
+ */
+ public MonitorRuntimeException(Throwable cause) {
+ super(cause);
+ }
+}
diff --git a/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/Problem.java b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/Problem.java new file mode 100644 index 0000000000..83a2d63eae --- /dev/null +++ b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/Problem.java @@ -0,0 +1,49 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.tuscany.sca.monitor; + + +/** + * Records an validation problem. + * + * @version $Rev$ $Date$ + */ +public interface Problem { + + public enum Severity { + INFO, + WARNING, + ERROR + } + + String getSourceClassName(); + + String getBundleName(); + + Severity getSeverity(); + + Object getProblemObject(); + + String getMessageId(); + + Exception getCause(); + + Object[] getMessageParams(); +} diff --git a/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/DefaultMonitorFactoryImpl.java b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/DefaultMonitorFactoryImpl.java new file mode 100644 index 0000000000..274b4faefd --- /dev/null +++ b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/DefaultMonitorFactoryImpl.java @@ -0,0 +1,41 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.tuscany.sca.monitor.impl; + +import org.apache.tuscany.sca.monitor.Monitor; +import org.apache.tuscany.sca.monitor.MonitorFactory; + + +/** + * A factory for creating validation monitors + * + * @version $Rev$ $Date$ + */ +public class DefaultMonitorFactoryImpl implements MonitorFactory { + + private Monitor monitor = null; + + public Monitor createMonitor() { + if (monitor == null){ + monitor = new DefaultMonitorImpl(); + } + return monitor ; + } +} diff --git a/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/DefaultMonitorImpl.java b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/DefaultMonitorImpl.java new file mode 100644 index 0000000000..7df34d0c74 --- /dev/null +++ b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/DefaultMonitorImpl.java @@ -0,0 +1,116 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.tuscany.sca.monitor.impl; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.logging.Level; +import java.util.logging.Logger; +import org.apache.tuscany.sca.monitor.Monitor; +import org.apache.tuscany.sca.monitor.Problem; +import org.apache.tuscany.sca.monitor.Problem.Severity; + +/** + * A monitor for the watching for validation problems + * + * @version $Rev$ $Date$ + */ +public class DefaultMonitorImpl extends Monitor { + private static final Logger logger = Logger.getLogger(DefaultMonitorImpl.class.getName()); + + // Cache all the problem reported to monitor for further analysis + private List<Problem> problemCache = new ArrayList<Problem>(); + + public void problem(Problem problem) { + + Logger problemLogger = Logger.getLogger(problem.getSourceClassName(), problem.getBundleName()); + + if (problemLogger == null){ + logger.severe("Can't get logger " + problem.getSourceClassName()+ " with bundle " + problem.getBundleName()); + } + + if (problem.getSeverity() == Severity.INFO) { + problemCache.add(problem); + problemLogger.logp(Level.INFO, problem.getSourceClassName(), null, + problem.getMessageId(), problem.getMessageParams()); + } + else if (problem.getSeverity() == Severity.WARNING) { + problemCache.add(problem); + problemLogger.logp(Level.WARNING, problem.getSourceClassName(), null, + problem.getMessageId(), problem.getMessageParams()); + } + else if (problem.getSeverity() == Severity.ERROR) { + if (problem.getCause() != null) { + problemCache.add(problem); + problemLogger.logp(Level.SEVERE, problem.getSourceClassName(), + null, problem.getMessageId(), problem.getCause().toString()); + + } else { + problemCache.add(problem); + problemLogger.logp(Level.SEVERE, problem.getSourceClassName(), null, + problem.getMessageId(), problem.getMessageParams()); + } + } + } + + public List<Problem> getProblems(){ + return problemCache; + } + + public Problem createProblem(String sourceClassName, String bundleName, + Severity severity, Object problemObject, String messageId, + Exception cause) { + return new ProblemImpl(sourceClassName, bundleName, severity, + problemObject, messageId, cause); + } + + public Problem createProblem(String sourceClassName, String bundleName, + Severity severity, Object problemObject, String messageId, + Object... messageParams) { + return new ProblemImpl(sourceClassName, bundleName, severity, + problemObject, messageId, messageParams); + } + + public Problem getLastLoggedProblem(){ + return problemCache.get(problemCache.size() - 1); + } + + public boolean isMessageLogged(String messageId) { + for (Problem problem : problemCache){ + if (problem.getMessageId().equals(messageId)){ + return true; + } + } + + return false; + } + + public Problem getProblem(String messageId) { + for (Problem problem : problemCache){ + if (problem.getMessageId().equals(messageId)){ + return problem; + } + } + + return null; + } +} diff --git a/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/ProblemImpl.java b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/ProblemImpl.java new file mode 100644 index 0000000000..5a0aaeddd0 --- /dev/null +++ b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/ProblemImpl.java @@ -0,0 +1,132 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.tuscany.sca.monitor.impl; + +import java.util.logging.Formatter; +import java.util.logging.Level; +import java.util.logging.LogRecord; +import java.util.logging.Logger; +import java.util.logging.SimpleFormatter; + +import org.apache.tuscany.sca.monitor.Problem; + +/** + * Reports a composite assembly problem. + * + * @version $Rev$ $Date$ + */ +public class ProblemImpl implements Problem { + + private String sourceClassName; + private String bundleName; + private Severity severity; + private Object problemObject; + private String messageId; + private Object[] messageParams; + private Exception cause; + + /** + * Construct a new problem + * + * @param sourceClassName the class name reporting the problem + * @param bundleName the name of the message bundle to use + * @param severity the severity of the problem + * @param problemObject the model object for which the problem is being reported + * @param messageId the id of the problem message + * @param messageParams the parameters of the problem message + */ + public ProblemImpl(String sourceClassName, String bundleName, Severity severity, Object problemObject, String messageId, Object... messageParams ) { + this.sourceClassName = sourceClassName; + this.bundleName = bundleName; + this.severity = severity; + this.problemObject = problemObject; + this.messageId = messageId; + this.messageParams = messageParams; + } + + /** + * Construct a new problem + * + * @param sourceClassName the class name reporting the problem + * @param bundleName the name of the message bundle to use + * @param severity the severity of the problem + * @param problemObject the model object for which the problem is being reported + * @param messageId the id of the problem message + * @param cause the exception which caused the problem + */ + public ProblemImpl(String sourceClassName, String bundleName, Severity severity, Object problemObject, String messageId, Exception cause) { + this.sourceClassName = sourceClassName; + this.bundleName = bundleName; + this.severity = severity; + this.problemObject = problemObject; + this.messageId = messageId; + this.cause = cause; + } + + public String getSourceClassName() { + return sourceClassName; + } + + public String getBundleName() { + return bundleName; + } + + public Severity getSeverity() { + return severity; + } + + public Object getProblemObject() { + return problemObject; + } + + public String getMessageId() { + return messageId; + } + + public Object[] getMessageParams() { + return messageParams; + } + + public Exception getCause() { + return cause; + } + + @Override + public String toString() { + Logger logger = Logger.getLogger(sourceClassName, bundleName); + + LogRecord record = new LogRecord(Level.INFO, messageId); + + if (cause == null){ + record.setParameters(messageParams); + + } else { + Object[] params = new String[1]; + params[0] = cause.toString(); + record.setParameters(params); + } + record.setResourceBundle(logger.getResourceBundle()); + record.setSourceClassName(sourceClassName); + + Formatter formatter = new SimpleFormatter(); + + return formatter.formatMessage(record); + } +} |