Coverage Report

Coverage Report - org.kuali.rice.krad.web.form.IncidentReportForm

Classes in this File

Line Coverage

Branch Coverage

Complexity

IncidentReportForm

0/59

0/22

1.379

 /**
  * Copyright 2005-2011 The Kuali Foundation
  *
  * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
  *
  * 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.kuali.rice.krad.web.form;
 
 import org.kuali.rice.krad.service.KRADServiceLocator;
 import org.kuali.rice.krad.uif.UifConstants;
 import org.kuali.rice.krad.uif.UifConstants.ViewType;
 
 import java.io.PrintWriter;
 import java.io.StringWriter;
 
 /**
  * Form class for incident reports
  * 
  * @author Kuali Rice Team (rice.collab@kuali.org)
  */
 public class IncidentReportForm extends UifFormBase {
 
     private static final long serialVersionUID = -6677581167041430694L;
 
     protected String errorMessage = "The system has encountered an error and is unable to complete your request at this time. Please provide more information regarding this error by completing this Incident Report.";
 
     protected Exception exception;
     protected String exceptionMessage;
     protected String exceptionStackTrace;
 
     protected String userInput;
     protected String incidentDocId;
     protected String incidentViewId;
     protected String controller;
     protected String userName;
     protected String userId;
     protected String userEmail;
 
     protected boolean devMode;
 
     public IncidentReportForm() {
         super();
         this.setRenderFullView(true);
         setViewTypeName(ViewType.INCIDENT);
     }
 
     /**
      * Creates the email message from the exception, form and user data.
      * 
      * @return the email message
      */
     public String createEmailMessage() {
         String format = "Document Id: %s%n" + "View Id: %s%n" + "Handler: %s%n%n" + "User Email: %s%n"
                 + "Person User Identifier: %s%n" + "Person Name: %s%n" + "User Input: %s%n%n" + "errorMessage: %n"
                 + "%s";
         String message = String.format(format, (incidentDocId == null) ? "" : incidentDocId, (incidentViewId == null) ? "" : incidentViewId,
                 (controller == null) ? "" : controller, (userEmail == null) ? "" : userEmail, (userId == null) ? ""
                         : userId, (userName == null) ? "" : userName, (userInput == null) ? "" : userInput,
                 (exceptionStackTrace == null) ? "" : exceptionStackTrace);
 
         return message;
 
     }
 
     /**
      * Creates the email subject containing the mode, view id and the exception message.
      * 
      * @return the email subject
      */
     public String createEmailSubject() {
         String env = KRADServiceLocator.getKualiConfigurationService().getPropertyValueAsString("environment");
         String format = "%s:%s:%s";
         String subject = String.format(format, env, (incidentViewId == null) ? "" : incidentViewId,
                 truncateString(exceptionMessage, 180));
         return subject;
     }
 
     /**
      * Truncate the string to specified length.
      * 
      * @param str
      *            the string to truncate
      * @param maxLength
      *            the max length
      * @return the truncated string
      */
     protected String truncateString(String str, int maxLength) {
         if (str != null && str.length() > maxLength)
             str = str.substring(0, maxLength);
         return str;
     }
 
     /**
      * Gets the stack trace from an exception.
      * 
      * @param t
      *            the throwable to get the stack trace from
      * @return the stack trace
      */
     protected String getStackTrace(Throwable t) {
         StringWriter sw = new StringWriter();
         PrintWriter pw = new PrintWriter(sw, true);
         t.printStackTrace(pw);
         pw.flush();
         sw.flush();
         return sw.toString();
     }
 
     /**
      * @return the errorMessage
      */
     public String getErrorMessage() {
         return this.errorMessage;
     }
 
     /**
      * @param errorMessage
      *            the errorMessage to set
      */
     public void setErrorMessage(String errorMessage) {
         this.errorMessage = errorMessage;
     }
 
     /**
      * @return the exceptionMessage
      */
     public String getExceptionMessage() {
         return this.exceptionMessage;
     }
 
     /**
      * @param exceptionMessage
      *            the exceptionMessage to set
      */
     public void setExceptionMessage(String exceptionMessage) {
         this.exceptionMessage = exceptionMessage;
     }
 
     /**
      * @return the exceptionStackTrace
      */
     public String getExceptionStackTrace() {
         return this.exceptionStackTrace;
     }
 
     /**
      * @param exceptionStackTrace
      *            the exceptionStackTrace to set
      */
     public void setExceptionStackTrace(String exceptionStackTrace) {
         this.exceptionStackTrace = exceptionStackTrace;
     }
 
     /**
      * @return the userInput
      */
     public String getUserInput() {
         return this.userInput;
     }
 
     /**
      * @param userInput
      *            the userInput to set
      */
     public void setUserInput(String userInput) {
         this.userInput = userInput;
     }
 
     /**
      * @return the devMode
      */
     public boolean isDevMode() {
         return this.devMode;
     }
 
     /**
      * @param devMode
      *            the devMode to set
      */
     public void setDevMode(boolean devMode) {
         this.devMode = devMode;
     }
 
     /**
      * @param incidentDocId
      *            the incidentDocId to set
      */
     public void setIncidentDocId(String incidentDocId) {
         this.incidentDocId = incidentDocId;
     }
 
     /**
      * @return the incidentDocId
      */
     public String getIncidentDocId() {
         return incidentDocId;
     }
 
     /**
      * @param incidentViewId
      *            the incidentViewId to set
      */
     public void setIncidentViewId(String incidentViewId) {
         this.incidentViewId = incidentViewId;
     }
 
     /**
      * @return the incidentViewId
      */
     public String getIncidentViewId() {
         return incidentViewId;
     }
 
     /**
      * @param exception
      *            the exception to set
      */
     public void setException(Exception exception) {
         this.exception = exception;
         setExceptionStackTrace(getStackTrace(exception));
         setExceptionMessage(exception.getMessage());
     }
 
     /**
      * @return the exception
      */
     public Exception getException() {
         return exception;
     }
 
     /**
      * @param userName
      *            the userName to set
      */
     public void setUserName(String userName) {
         this.userName = userName;
     }
 
     /**
      * @return the userName
      */
     public String getUserName() {
         return userName;
     }
 
     /**
      * @param userId
      *            the userId to set
      */
     public void setUserId(String userId) {
         this.userId = userId;
     }
 
     /**
      * @return the userId
      */
     public String getUserId() {
         return userId;
     }
 
     /**
      * @param userEmail
      *            the userEmail to set
      */
     public void setUserEmail(String userEmail) {
         this.userEmail = userEmail;
     }
 
     /**
      * @return the userEmail
      */
     public String getUserEmail() {
         return userEmail;
     }
 
     /**
      * @param controller
      *            the controller to set
      */
     public void setController(String controller) {
         this.controller = controller;
     }
 
     /**
      * @return the controller
      */
     public String getController() {
         return controller;
     }
 
 }

1		/**
2		* Copyright 2005-2011 The Kuali Foundation
3		*
4		* Licensed under the Educational Community License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.opensource.org/licenses/ecl2.php
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*/
16		package org.kuali.rice.krad.web.form;
17
18		import org.kuali.rice.krad.service.KRADServiceLocator;
19		import org.kuali.rice.krad.uif.UifConstants;
20		import org.kuali.rice.krad.uif.UifConstants.ViewType;
21
22		import java.io.PrintWriter;
23		import java.io.StringWriter;
24
25		/**
26		* Form class for incident reports
27		*
28		* @author Kuali Rice Team (rice.collab@kuali.org)
29		*/
30		public class IncidentReportForm extends UifFormBase {
31
32		private static final long serialVersionUID = -6677581167041430694L;
33
34	0	protected String errorMessage = "The system has encountered an error and is unable to complete your request at this time. Please provide more information regarding this error by completing this Incident Report.";
35
36		protected Exception exception;
37		protected String exceptionMessage;
38		protected String exceptionStackTrace;
39
40		protected String userInput;
41		protected String incidentDocId;
42		protected String incidentViewId;
43		protected String controller;
44		protected String userName;
45		protected String userId;
46		protected String userEmail;
47
48		protected boolean devMode;
49
50		public IncidentReportForm() {
51	0	super();
52	0	this.setRenderFullView(true);
53	0	setViewTypeName(ViewType.INCIDENT);
54	0	}
55
56		/**
57		* Creates the email message from the exception, form and user data.
58		*
59		* @return the email message
60		*/
61		public String createEmailMessage() {
62	0	String format = "Document Id: %s%n" + "View Id: %s%n" + "Handler: %s%n%n" + "User Email: %s%n"
63		+ "Person User Identifier: %s%n" + "Person Name: %s%n" + "User Input: %s%n%n" + "errorMessage: %n"
64		+ "%s";
65	0	String message = String.format(format, (incidentDocId == null) ? "" : incidentDocId, (incidentViewId == null) ? "" : incidentViewId,
66		(controller == null) ? "" : controller, (userEmail == null) ? "" : userEmail, (userId == null) ? ""
67		: userId, (userName == null) ? "" : userName, (userInput == null) ? "" : userInput,
68		(exceptionStackTrace == null) ? "" : exceptionStackTrace);
69
70	0	return message;
71
72		}
73
74		/**
75		* Creates the email subject containing the mode, view id and the exception message.
76		*
77		* @return the email subject
78		*/
79		public String createEmailSubject() {
80	0	String env = KRADServiceLocator.getKualiConfigurationService().getPropertyValueAsString("environment");
81	0	String format = "%s:%s:%s";
82	0	String subject = String.format(format, env, (incidentViewId == null) ? "" : incidentViewId,
83		truncateString(exceptionMessage, 180));
84	0	return subject;
85		}
86
87		/**
88		* Truncate the string to specified length.
89		*
90		* @param str
91		* the string to truncate
92		* @param maxLength
93		* the max length
94		* @return the truncated string
95		*/
96		protected String truncateString(String str, int maxLength) {
97	0	if (str != null && str.length() > maxLength)
98	0	str = str.substring(0, maxLength);
99	0	return str;
100		}
101
102		/**
103		* Gets the stack trace from an exception.
104		*
105		* @param t
106		* the throwable to get the stack trace from
107		* @return the stack trace
108		*/
109		protected String getStackTrace(Throwable t) {
110	0	StringWriter sw = new StringWriter();
111	0	PrintWriter pw = new PrintWriter(sw, true);
112	0	t.printStackTrace(pw);
113	0	pw.flush();
114	0	sw.flush();
115	0	return sw.toString();
116		}
117
118		/**
119		* @return the errorMessage
120		*/
121		public String getErrorMessage() {
122	0	return this.errorMessage;
123		}
124
125		/**
126		* @param errorMessage
127		* the errorMessage to set
128		*/
129		public void setErrorMessage(String errorMessage) {
130	0	this.errorMessage = errorMessage;
131	0	}
132
133		/**
134		* @return the exceptionMessage
135		*/
136		public String getExceptionMessage() {
137	0	return this.exceptionMessage;
138		}
139
140		/**
141		* @param exceptionMessage
142		* the exceptionMessage to set
143		*/
144		public void setExceptionMessage(String exceptionMessage) {
145	0	this.exceptionMessage = exceptionMessage;
146	0	}
147
148		/**
149		* @return the exceptionStackTrace
150		*/
151		public String getExceptionStackTrace() {
152	0	return this.exceptionStackTrace;
153		}
154
155		/**
156		* @param exceptionStackTrace
157		* the exceptionStackTrace to set
158		*/
159		public void setExceptionStackTrace(String exceptionStackTrace) {
160	0	this.exceptionStackTrace = exceptionStackTrace;
161	0	}
162
163		/**
164		* @return the userInput
165		*/
166		public String getUserInput() {
167	0	return this.userInput;
168		}
169
170		/**
171		* @param userInput
172		* the userInput to set
173		*/
174		public void setUserInput(String userInput) {
175	0	this.userInput = userInput;
176	0	}
177
178		/**
179		* @return the devMode
180		*/
181		public boolean isDevMode() {
182	0	return this.devMode;
183		}
184
185		/**
186		* @param devMode
187		* the devMode to set
188		*/
189		public void setDevMode(boolean devMode) {
190	0	this.devMode = devMode;
191	0	}
192
193		/**
194		* @param incidentDocId
195		* the incidentDocId to set
196		*/
197		public void setIncidentDocId(String incidentDocId) {
198	0	this.incidentDocId = incidentDocId;
199	0	}
200
201		/**
202		* @return the incidentDocId
203		*/
204		public String getIncidentDocId() {
205	0	return incidentDocId;
206		}
207
208		/**
209		* @param incidentViewId
210		* the incidentViewId to set
211		*/
212		public void setIncidentViewId(String incidentViewId) {
213	0	this.incidentViewId = incidentViewId;
214	0	}
215
216		/**
217		* @return the incidentViewId
218		*/
219		public String getIncidentViewId() {
220	0	return incidentViewId;
221		}
222
223		/**
224		* @param exception
225		* the exception to set
226		*/
227		public void setException(Exception exception) {
228	0	this.exception = exception;
229	0	setExceptionStackTrace(getStackTrace(exception));
230	0	setExceptionMessage(exception.getMessage());
231	0	}
232
233		/**
234		* @return the exception
235		*/
236		public Exception getException() {
237	0	return exception;
238		}
239
240		/**
241		* @param userName
242		* the userName to set
243		*/
244		public void setUserName(String userName) {
245	0	this.userName = userName;
246	0	}
247
248		/**
249		* @return the userName
250		*/
251		public String getUserName() {
252	0	return userName;
253		}
254
255		/**
256		* @param userId
257		* the userId to set
258		*/
259		public void setUserId(String userId) {
260	0	this.userId = userId;
261	0	}
262
263		/**
264		* @return the userId
265		*/
266		public String getUserId() {
267	0	return userId;
268		}
269
270		/**
271		* @param userEmail
272		* the userEmail to set
273		*/
274		public void setUserEmail(String userEmail) {
275	0	this.userEmail = userEmail;
276	0	}
277
278		/**
279		* @return the userEmail
280		*/
281		public String getUserEmail() {
282	0	return userEmail;
283		}
284
285		/**
286		* @param controller
287		* the controller to set
288		*/
289		public void setController(String controller) {
290	0	this.controller = controller;
291	0	}
292
293		/**
294		* @return the controller
295		*/
296		public String getController() {
297	0	return controller;
298		}
299
300		}