001: /********************************************************************************
002: * CruiseControl, a Continuous Integration Toolkit
003: * Copyright (c) 2001, ThoughtWorks, Inc.
004: * 200 E. Randolph, 25th Floor
005: * Chicago, IL 60601 USA
006: * All rights reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * + Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * + Redistributions in binary form must reproduce the above
016: * copyright notice, this list of conditions and the following
017: * disclaimer in the documentation and/or other materials provided
018: * with the distribution.
019: *
020: * + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
021: * names of its contributors may be used to endorse or promote
022: * products derived from this software without specific prior
023: * written permission.
024: *
025: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
026: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
027: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
028: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
029: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
030: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
031: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
032: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
033: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
034: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
035: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
036: ********************************************************************************/package net.sourceforge.cruisecontrol.jmx;
037:
038: import java.lang.reflect.Method;
039: import java.util.HashMap;
040: import java.util.Map;
041:
042: import mx4j.MBeanDescriptionAdapter;
043:
044: /**
045: * @author <a href="mailto:joriskuipers@xs4all.nl">Joris Kuipers</a>
046: */
047: public class ProjectControllerMBeanDescription extends
048: MBeanDescriptionAdapter {
049:
050: private static final Map METHOD_DESCRIPTIONS;
051:
052: static {
053: METHOD_DESCRIPTIONS = new HashMap();
054:
055: METHOD_DESCRIPTIONS.put("pause", "Pauses the project");
056: METHOD_DESCRIPTIONS.put("resume",
057: "Resumes the project when it's paused");
058: METHOD_DESCRIPTIONS.put("build",
059: "Forces a build of the project");
060: METHOD_DESCRIPTIONS.put("buildWithTarget",
061: "Forces a build of the project using the given target");
062: METHOD_DESCRIPTIONS.put("serialize",
063: "Persists the state of the project to disk");
064: METHOD_DESCRIPTIONS.put("commitMessages",
065: "Gets the commit messages which"
066: + " include the user name and the message.");
067: }
068:
069: private static final Map ATTR_DESCRIPTIONS;
070:
071: static {
072: ATTR_DESCRIPTIONS = new HashMap();
073: ATTR_DESCRIPTIONS
074: .put("ConfigFileName",
075: "The name of the config file this project reads its settings from");
076:
077: ATTR_DESCRIPTIONS.put("Label", "The current build label");
078:
079: ATTR_DESCRIPTIONS
080: .put(
081: "LabelIncrementer",
082: "The classname of the LabelIncrementer used to determine the build label. "
083: + "Changes to this attribute are not persisted");
084:
085: ATTR_DESCRIPTIONS
086: .put("LastBuild",
087: "Time of the last build, using the format 'yyyyMMddHHmmss'");
088:
089: ATTR_DESCRIPTIONS
090: .put("LastSuccessfulBuild",
091: "Time of the last successful build, using the format 'yyyyMMddHHmmss'");
092:
093: ATTR_DESCRIPTIONS
094: .put(
095: "LogDir",
096: "The directory where the log files for this project are written to. "
097: + "Changes to this attribute are not persisted");
098:
099: ATTR_DESCRIPTIONS
100: .put("ProjectName", "The name of this project");
101:
102: ATTR_DESCRIPTIONS
103: .put(
104: "BuildInterval",
105: "The build interval in milliseconds. Changes to this attribute are not persisted");
106:
107: ATTR_DESCRIPTIONS.put("Status",
108: "The current status of the project");
109:
110: ATTR_DESCRIPTIONS.put("Paused",
111: "Indicates if the project is paused");
112:
113: ATTR_DESCRIPTIONS
114: .put("BuildStartTime",
115: "Start Time of the last build, using the format 'yyyyMMddHHmmss'");
116: }
117:
118: public String getOperationDescription(Method method) {
119: String methodName = method.getName();
120: if (METHOD_DESCRIPTIONS.containsKey(methodName)) {
121: return (String) METHOD_DESCRIPTIONS.get(methodName);
122: }
123: return super .getOperationDescription(method);
124: }
125:
126: public String getAttributeDescription(String attr) {
127: if (ATTR_DESCRIPTIONS.containsKey(attr)) {
128: return (String) ATTR_DESCRIPTIONS.get(attr);
129: }
130: return super .getAttributeDescription(attr);
131: }
132:
133: public String getMBeanDescription() {
134: return "Controller for a CruiseControl project";
135: }
136: }
|