From e5b7380c874745c989d1816b8f552504f038e1bc Mon Sep 17 00:00:00 2001 From: lresende Date: Thu, 26 Sep 2013 20:33:20 +0000 Subject: 2.0 branch for possible maintenance release git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@1526672 13f79535-47bb-0310-9956-ffa450edef68 --- .../tuscany/sca/monitor/DefaultMonitorFactory.java | 60 ++++ .../org/apache/tuscany/sca/monitor/Monitor.java | 389 +++++++++++++++++++++ .../apache/tuscany/sca/monitor/MonitorFactory.java | 61 ++++ .../org/apache/tuscany/sca/monitor/Problem.java | 54 +++ .../tuscany/sca/monitor/ValidationException.java | 40 +++ .../tuscany/sca/monitor/impl/MonitorImpl.java | 150 ++++++++ .../tuscany/sca/monitor/impl/ProblemImpl.java | 181 ++++++++++ 7 files changed, 935 insertions(+) create mode 100644 sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/DefaultMonitorFactory.java create mode 100644 sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/Monitor.java create mode 100644 sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/MonitorFactory.java create mode 100644 sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/Problem.java create mode 100644 sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/ValidationException.java create mode 100644 sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/MonitorImpl.java create mode 100644 sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/ProblemImpl.java (limited to 'sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca') diff --git a/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/DefaultMonitorFactory.java b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/DefaultMonitorFactory.java new file mode 100644 index 0000000000..8a99fa4c7c --- /dev/null +++ b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/DefaultMonitorFactory.java @@ -0,0 +1,60 @@ +/* + * 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 org.apache.tuscany.sca.monitor.impl.MonitorImpl; + +/** + * A factory for creating validation monitors + * + * @version $Rev$ $Date$ + */ +public class DefaultMonitorFactory implements MonitorFactory { + private ThreadLocal contextMonitor = new InheritableThreadLocal(); + + public Monitor createMonitor() { + return new MonitorImpl(); + } + + public Monitor getContextMonitor() { + return contextMonitor.get(); + } + + public Monitor getContextMonitor(boolean create) { + Monitor monitor = contextMonitor.get(); + if (monitor == null) { + monitor = new MonitorImpl(); + setContextMonitor(monitor); + } + return monitor; + } + + public Monitor removeContextMonitor() { + Monitor old = contextMonitor.get(); + contextMonitor.remove(); + return old; + } + + public Monitor setContextMonitor(Monitor value) { + Monitor old = contextMonitor.get(); + contextMonitor.set(value); + return old; + } +} diff --git a/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/Monitor.java b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/Monitor.java new file mode 100644 index 0000000000..91f6bc9a9f --- /dev/null +++ b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/Monitor.java @@ -0,0 +1,389 @@ +/* + * 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 java.util.logging.Logger; + +import org.apache.tuscany.sca.monitor.Problem.Severity; + +/** + * A monitor for the watching for validation problems + * + * @version $Rev$ $Date$ + * @tuscany.spi.extension.inheritfrom + */ +public abstract class Monitor { + private static class ContextFinder extends SecurityManager { + private final static ContextFinder instance = new ContextFinder(); + + // This is sensitive to the calling stack + private static Class getContextClass() { + Class[] classes = instance.getClassContext(); + // 0: ContextFinder (getClassContext) + // 1: ContextFinder (getContextClass) + // 2: Monitor (getSourceClassName) + // 3: Monitor (error/warning) + return classes[4]; + } + + } + private final static Logger logger = Logger.getLogger(Monitor.class.getName()); + + /** + * 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, + Object... messageParameters){ + String contextClassName = getSourceClassName(reportingObject); + if (monitor != null) { + Problem problem = + monitor.createProblem(contextClassName, + messageBundle, + Severity.ERROR, + reportingObject, + messageId, + messageParameters); + monitor.problem(problem); + } else { + logNullMonitor(messageId, contextClassName); + } + } + + /** + * 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, + Throwable cause){ + String contextClassName = getSourceClassName(reportingObject); + if (monitor != null) { + Problem problem = + monitor.createProblem(contextClassName, + messageBundle, + Severity.ERROR, + reportingObject, + messageId, + cause); + monitor.problem(problem); + } else { + logNullMonitor(messageId, contextClassName); + } + } + + /** + * 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, + Throwable cause, + Object... messageParameters) { + String contextClassName = getSourceClassName(reportingObject); + if (monitor != null) { + Problem problem = + monitor.createProblem(contextClassName, + messageBundle, + Severity.ERROR, + reportingObject, + messageId, + cause, + messageParameters); + monitor.problem(problem); + } else { + logNullMonitor(messageId, contextClassName); + } + } + + private static String getSourceClassName(Object reportingObject) { + String contextClassName = null; + if (reportingObject != null) { + contextClassName = reportingObject.getClass().getName(); + } else { + contextClassName = ContextFinder.getContextClass().getName(); + } + return contextClassName; + } + + private static void logNullMonitor(String messageId, String contextClassName) { + logger.warning("Attempt to report error with id " + + messageId + + " from class " + + contextClassName + + " but the monitor object was null"); + } + + /** + * 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, + Object... messageParameters){ + String contextClassName = getSourceClassName(reportingObject); + if (monitor != null) { + Problem problem = + monitor.createProblem(contextClassName, + messageBundle, + Severity.WARNING, + reportingObject, + messageId, + messageParameters); + monitor.problem(problem); + } else { + logNullMonitor(messageId, contextClassName); + } + } + + // ===================================================== + // TUSCANY-3132 - new approach to monitoring errors + // + + /** + * 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 warning (Monitor monitor, + Object reportingObject, + String messageBundle, + String messageId, + Throwable cause){ + String contextClassName = getSourceClassName(reportingObject); + if (monitor != null) { + Problem problem = + monitor.createProblem(contextClassName, + messageBundle, + Severity.WARNING, + reportingObject, + messageId, + cause); + monitor.problem(problem); + } else { + logNullMonitor(messageId, contextClassName); + } + } + + /** + * 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 warning (Monitor monitor, + Object reportingObject, + String messageBundle, + String messageId, + Throwable cause, + Object... messageParameters) { + String contextClassName = getSourceClassName(reportingObject); + if (monitor != null) { + Problem problem = + monitor.createProblem(contextClassName, + messageBundle, + Severity.WARNING, + reportingObject, + messageId, + cause, + messageParameters); + monitor.problem(problem); + } else { + logNullMonitor(messageId, contextClassName); + } + } + + /** + * 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); + + /** + * 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, + Throwable cause); + + /** + * Get the name of the artifact for which errors are Monitored + * @return the name of the Artifact or null if no artifact name has been set + */ + public abstract String getArtifactName(); + + /** + * Returns the last logged problem. + * + * @return + */ + public abstract Problem getLastProblem(); + + /** + * Returns a list of reported problems. + * + * @return the list of problems. The list may be empty + */ + public abstract List getProblems(); + + /** + * Remove the most recent context string from the + * context stack + * @return The object popped + */ + public abstract Object popContext(); + + /** + * Reports a build problem. + * + * @param problem + */ + public abstract void problem(Problem problem); + + /** + * Add a context string to the context stack + * @param context the context string to add + */ + public abstract void pushContext(Object context); + + /** + * Clear context and problems + */ + public abstract void reset(); + /** + * Set the name of an artifact for which errors are Monitored + * @param artifactName the artifact name + */ + public abstract void setArtifactName(String artifactName); + + // ===================================================== + + /** + * Checks the Monitor for any Problems with s severity of ERROR and + * if one is found then throw a ValidationException. + * This will also call reset() on this Monitor. + */ + public void analyzeProblems() throws ValidationException { + try { + for (Problem problem : getProblems()) { + if ((problem.getSeverity() == Severity.ERROR)) { + if (problem.getCause() != null) { + throw new ValidationException(problem.getCause()); + } else { + throw new ValidationException(problem.toString()); + } + } + } + } finally { + reset(); + } + } + + public boolean isErrorDetected() { + + boolean errorDetected = false; + + for (Problem problem : getProblems()) { + if ((problem.getSeverity() == Severity.ERROR)) { + errorDetected = true; + break; + } + } + + return errorDetected; + } + + /** + * Helper method to retrieve a localized message from a given bundle with a given + * message ID string + * + * @Param loggerName - the name of the logger to use + * @param messageBundleName - the name of the bundle to use + * @param messageID - the ID of the message to retrieve + * @return the message string + */ + public abstract String getMessageString(String loggerName, String messageBundleName, String messageID); +} diff --git a/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/MonitorFactory.java b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/MonitorFactory.java new file mode 100644 index 0000000000..12ac7eba7b --- /dev/null +++ b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/MonitorFactory.java @@ -0,0 +1,61 @@ +/* + * 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(); + + /** + * Get the monitor instance on the thread + * @return the monitor instance on the thread + */ + Monitor getContextMonitor(); + + /** + * Get the monitor instance on the thread + * @param create if it true, then create a new instance if no monitor is on the thread + * @return the monitor instance on the thread + */ + Monitor getContextMonitor(boolean create); + + /** + * Remove the monitor on the thread + * @return The existing instance + */ + Monitor removeContextMonitor(); + + /** + * Set the monitor onto the thread + * @param value The new instance + * @return The old instance + */ + Monitor setContextMonitor(Monitor monitor); +} diff --git a/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/Problem.java b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/Problem.java new file mode 100644 index 0000000000..c05fa632fb --- /dev/null +++ b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/Problem.java @@ -0,0 +1,54 @@ +/* + * 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$ + * @tuscany.spi.extension.asclient + */ +public interface Problem { + + /** + * + * @tuscany.spi.extension + * + */ + public enum Severity { + INFO, WARNING, ERROR + } + + String getSourceClassName(); + + String getResourceBundleName(); + + Severity getSeverity(); + + String getContext(); + + Object getProblemObject(); + + String getMessageId(); + + Throwable getCause(); + + Object[] getMessageParams(); +} diff --git a/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/ValidationException.java b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/ValidationException.java new file mode 100644 index 0000000000..368893dd68 --- /dev/null +++ b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/ValidationException.java @@ -0,0 +1,40 @@ +/* + * 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; + +public class ValidationException extends Exception { + private static final long serialVersionUID = 1L; + + public ValidationException() { + super(); + } + + public ValidationException(String message, Throwable cause) { + super(message, cause); + } + + public ValidationException(String message) { + super(message); + } + + public ValidationException(Throwable cause) { + super(cause); + } +} diff --git a/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/MonitorImpl.java b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/MonitorImpl.java new file mode 100644 index 0000000000..eb022a9616 --- /dev/null +++ b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/MonitorImpl.java @@ -0,0 +1,150 @@ +/* + * 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.List; +import java.util.Stack; +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 MonitorImpl extends Monitor { + private static final Logger logger = Logger.getLogger(MonitorImpl.class.getName()); + + // stack of context information that is printed alongside each problem + private Stack contextStack = new Stack(); + + // Cache all the problem reported to monitor for further analysis + private List problemCache = new ArrayList(); + + // Name of an artifact for which problems are being Monitored + private String artifactName = null; + + public void problem(Problem problem) { + + Logger problemLogger = Logger.getLogger(problem.getSourceClassName(), problem.getResourceBundleName()); + + if (problemLogger == null) { + logger.severe("Can't get logger " + problem.getSourceClassName() + + " with bundle " + + problem.getResourceBundleName()); + } + + if (problem.getSeverity() == Severity.INFO) { + problemCache.add(problem); + problemLogger.logp(Level.INFO, problem.getSourceClassName(), problem.getContext(), problem.getMessageId(), problem + .getMessageParams()); + } else if (problem.getSeverity() == Severity.WARNING) { + problemCache.add(problem); + problemLogger.logp(Level.WARNING, problem.getSourceClassName(), problem.getContext(), problem.getMessageId(), problem + .getMessageParams()); + } else if (problem.getSeverity() == Severity.ERROR) { + if (problem.getCause() != null) { + problemCache.add(problem); + problemLogger.logp(Level.SEVERE, problem.getSourceClassName(), problem.getContext(), problem.getMessageId(), problem + .getCause()); + + } else { + problemCache.add(problem); + problemLogger.logp(Level.SEVERE, problem.getSourceClassName(), problem.getContext(), problem.getMessageId(), problem + .getMessageParams()); + } + } + } + + public List getProblems() { + return problemCache; + } + + public Problem getLastProblem() { + if (problemCache.isEmpty()) { + return null; + } + return problemCache.get(problemCache.size() - 1); + } + + public Problem createProblem(String sourceClassName, + String bundleName, + Severity severity, + Object problemObject, + String messageId, + Throwable cause) { + return new ProblemImpl(sourceClassName, bundleName, severity, contextStack.toString(), problemObject, messageId, cause); + } + + public Problem createProblem(String sourceClassName, + String bundleName, + Severity severity, + Object problemObject, + String messageId, + Object... messageParams) { + return new ProblemImpl(sourceClassName, bundleName, severity, contextStack.toString(), problemObject, messageId, messageParams); + } + + public Problem createProblem(String sourceClassName, + String bundleName, + Severity severity, + Object problemObject, + String messageId, + Throwable cause, + Object... messageParams) { + return new ProblemImpl(sourceClassName, bundleName, severity, contextStack.toString(), problemObject, messageId, cause, messageParams); + } + + public String getArtifactName() { + return artifactName; + } + + public void setArtifactName(String artifactName) { + this.artifactName = artifactName; + } + + @Override + public void pushContext(Object context) { + contextStack.push(context); + } + + @Override + public Object popContext() { + return contextStack.pop(); + } + + @Override + public void reset() { + contextStack.clear(); + problemCache.clear(); + artifactName = null; + } + + @Override + public String getMessageString(String loggerName, String messageBundleName, String messageID){ + Logger problemLogger = Logger.getLogger(loggerName, messageBundleName); + return problemLogger.getResourceBundle().getString(messageID); + } +} diff --git a/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/ProblemImpl.java b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/ProblemImpl.java new file mode 100644 index 0000000000..acfc409856 --- /dev/null +++ b/sca-java-2.x/branches/2.0/modules/monitor/src/main/java/org/apache/tuscany/sca/monitor/impl/ProblemImpl.java @@ -0,0 +1,181 @@ +/* + * 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 String context; + private Object problemObject; + private String messageId; + private Object[] messageParams; + private Throwable 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 context the string indicating where the error occurred + * @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, + String context, + Object problemObject, + String messageId, + Object... messageParams) { + this.sourceClassName = sourceClassName; + this.bundleName = bundleName; + this.severity = severity; + this.context = context; + 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 context the string indicating where the error occurred + * @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, + String context, + Object problemObject, + String messageId, + Throwable cause, + Object... messageParams) { + this.sourceClassName = sourceClassName; + this.bundleName = bundleName; + this.severity = severity; + this.context = context; + this.problemObject = problemObject; + this.messageId = messageId; + this.cause = cause; + 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 context the string indicating where the error occurred + * @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, + String context, + Object problemObject, + String messageId, + Throwable cause) { + this.sourceClassName = sourceClassName; + this.bundleName = bundleName; + this.severity = severity; + this.context = context; + this.problemObject = problemObject; + this.messageId = messageId; + this.cause = cause; + } + + public String getSourceClassName() { + return sourceClassName; + } + + public String getResourceBundleName() { + return bundleName; + } + + public Severity getSeverity() { + return severity; + } + + public String getContext() { + return context + " (" + messageId + ")"; + } + + public Object getProblemObject() { + return problemObject; + } + + public String getMessageId() { + return messageId; + } + + public Object[] getMessageParams() { + return messageParams; + } + + public Throwable 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 context + " - " + formatter.formatMessage(record); + } +} -- cgit v1.2.3