Java tutorial
/** * The software subject to this notice and license includes both human readable * source code form and machine readable, binary, object code form. The NCI OCR * Software was developed in conjunction with the National Cancer Institute * (NCI) by NCI employees and 5AM Solutions, Inc. (5AM). To the extent * government employees are authors, any rights in such works shall be subject * to Title 17 of the United States Code, section 105. * * This NCI OCR Software License (the License) is between NCI and You. You (or * Your) shall mean a person or an entity, and all other entities that control, * are controlled by, or are under common control with the entity. Control for * purposes of this definition means (i) the direct or indirect power to cause * the direction or management of such entity, whether by contract or otherwise, * or (ii) ownership of fifty percent (50%) or more of the outstanding shares, * or (iii) beneficial ownership of such entity. * * This License is granted provided that You agree to the conditions described * below. NCI grants You a non-exclusive, worldwide, perpetual, fully-paid-up, * no-charge, irrevocable, transferable and royalty-free right and license in * its rights in the NCI OCR Software to (i) use, install, access, operate, * execute, copy, modify, translate, market, publicly display, publicly perform, * and prepare derivative works of the NCI OCR Software; (ii) distribute and * have distributed to and by third parties the NCI OCR Software and any * modifications and derivative works thereof; and (iii) sublicense the * foregoing rights set out in (i) and (ii) to third parties, including the * right to license such rights to further third parties. For sake of clarity, * and not by way of limitation, NCI shall have no right of accounting or right * of payment from You or Your sub-licensees for the rights granted under this * License. This License is granted at no charge to You. * * Your redistributions of the source code for the Software must retain the * above copyright notice, this list of conditions and the disclaimer and * limitation of liability of Article 6, below. Your redistributions in object * code form must reproduce the above copyright notice, this list of conditions * and the disclaimer of Article 6 in the documentation and/or other materials * provided with the distribution, if any. * * Your end-user documentation included with the redistribution, if any, must * include the following acknowledgment: This product includes software * developed by 5AM and the National Cancer Institute. If You do not include * such end-user documentation, You shall include this acknowledgment in the * Software itself, wherever such third-party acknowledgments normally appear. * * You may not use the names "The National Cancer Institute", "NCI", or "5AM" * to endorse or promote products derived from this Software. This License does * not authorize You to use any trademarks, service marks, trade names, logos or * product names of either NCI or 5AM, except as required to comply with the * terms of this License. * * For sake of clarity, and not by way of limitation, You may incorporate this * Software into Your proprietary programs and into any third party proprietary * programs. However, if You incorporate the Software into third party * proprietary programs, You agree that You are solely responsible for obtaining * any permission from such third parties required to incorporate the Software * into such third party proprietary programs and for informing Your * sub-licensees, including without limitation Your end-users, of their * obligation to secure any required permissions from such third parties before * incorporating the Software into such third party proprietary software * programs. In the event that You fail to obtain such permissions, You agree * to indemnify NCI for any claims against NCI by such third parties, except to * the extent prohibited by law, resulting from Your failure to obtain such * permissions. * * For sake of clarity, and not by way of limitation, You may add Your own * copyright statement to Your modifications and to the derivative works, and * You may provide additional or different license terms and conditions in Your * sublicenses of modifications of the Software, or any derivative works of the * Software as a whole, provided Your use, reproduction, and distribution of the * Work otherwise complies with the conditions stated in this License. * * THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES, * (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO * EVENT SHALL THE NATIONAL CANCER INSTITUTE, 5AM SOLUTIONS, INC. OR THEIR * AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ package gov.nih.nci.firebird.web.interceptor; import gov.nih.nci.firebird.common.FirebirdConstants; import gov.nih.nci.firebird.data.user.FirebirdUser; import gov.nih.nci.firebird.security.UserSessionInformation; import gov.nih.nci.firebird.service.messages.FirebirdMessage; import gov.nih.nci.firebird.service.messages.FirebirdMessageTemplate; import gov.nih.nci.firebird.service.messages.FirebirdTemplateParameter; import gov.nih.nci.firebird.service.messages.TemplateService; import gov.nih.nci.firebird.service.messages.email.EmailService; import gov.nih.nci.firebird.service.user.FirebirdUserService; import java.util.Date; import java.util.HashMap; import java.util.Map; import javax.ejb.EJBException; import javax.servlet.http.HttpServletRequest; import org.apache.commons.lang.StringUtils; import org.apache.commons.lang3.exception.ExceptionUtils; import org.apache.log4j.Logger; import org.apache.struts2.ServletActionContext; import com.google.inject.Inject; import com.google.inject.name.Named; import com.opensymphony.xwork2.ActionContext; import com.opensymphony.xwork2.ActionInvocation; import com.opensymphony.xwork2.interceptor.AbstractInterceptor; /** * Handles unexpected exceptions by logging the error, emailing details to a support email address and directing the * user to an error page. */ public class FirebirdExceptionHandlingInterceptor extends AbstractInterceptor { private static final long serialVersionUID = 1L; private static final Logger LOG = Logger.getLogger(FirebirdExceptionHandlingInterceptor.class); private final TemplateService templateService; private final EmailService emailService; private final FirebirdUserService userService; private final String supportEmail; /** * @param templateService . * @param emailService . * @param userService . * @param supportEmail . */ @Inject public FirebirdExceptionHandlingInterceptor(TemplateService templateService, @Named("jmsEmailService") EmailService emailService, FirebirdUserService userService, @Named("firebird.email.support.address") String supportEmail) { this.templateService = templateService; this.emailService = emailService; this.userService = userService; this.supportEmail = supportEmail; } @Override @SuppressWarnings({ "PMD.AvoidCatchingGenericException", "PMD.SignatureDeclareThrowsException" }) // Need to handle all exceptions // possible failure from invoke. public String intercept(ActionInvocation invocation) throws Exception { try { return invocation.invoke(); } catch (EJBException exception) { handleException(exception, invocation); throw exception.getCausedByException(); } catch (Exception exception) { handleException(exception, invocation); throw exception; } } private void handleException(Exception e, ActionInvocation invocation) { String timestamp = new Date().toString(); FirebirdUser user = getUser(invocation); String requestUrl = ServletActionContext.getRequest().getRequestURI(); String requestParameters = getRequestParametersString(); logException(timestamp, user, requestUrl, requestParameters, e); emailExceptionInformation(timestamp, user, requestUrl, requestParameters, e); } private FirebirdUser getUser(ActionInvocation invocation) { final ActionContext context = invocation.getInvocationContext(); UserSessionInformation userSessionInformation = (UserSessionInformation) context.getSession() .get(FirebirdConstants.USER_SESSION_INFORMATION); if (userSessionInformation != null) { return userService.getUserInfo(userSessionInformation); } else { return null; } } @SuppressWarnings("rawtypes") // parameters map is untyped private String getRequestParametersString() { HttpServletRequest request = ServletActionContext.getRequest(); StringBuilder sb = new StringBuilder(); for (Object entryObject : request.getParameterMap().entrySet()) { Map.Entry entry = (Map.Entry) entryObject; sb.append(entry.getKey()); sb.append(" = "); sb.append(StringUtils.join((Object[]) entry.getValue(), ",")); sb.append('\n'); } return sb.toString(); } private void logException(String timestamp, FirebirdUser user, String requestUrl, String requestParameters, Exception e) { StringBuilder sb = new StringBuilder(); sb.append("Unhandled FIREBIRD exception:\n"); sb.append("Timestamp: "); sb.append(timestamp); sb.append('\n'); sb.append("User: "); if (user != null) { sb.append(user.getBaseUsername()); } else { sb.append("No user logged in"); } sb.append('\n'); sb.append("URL: "); sb.append(requestUrl); sb.append('\n'); sb.append("Parameters: "); sb.append(requestParameters); sb.append('\n'); LOG.error(sb.toString(), e); } private void emailExceptionInformation(String timestamp, FirebirdUser user, String requestUrl, String requestParameters, Exception e) { Map<FirebirdTemplateParameter, Object> parameterValues = new HashMap<FirebirdTemplateParameter, Object>(); parameterValues.put(FirebirdTemplateParameter.TIMESTAMP, timestamp); parameterValues.put(FirebirdTemplateParameter.FIREBIRD_USER, user); parameterValues.put(FirebirdTemplateParameter.REQUEST_URL, requestUrl); parameterValues.put(FirebirdTemplateParameter.REQUEST_PARAMETERS, requestParameters); parameterValues.put(FirebirdTemplateParameter.STACKTRACE, ExceptionUtils.getStackTrace(e)); FirebirdMessage message = templateService.generateMessage(FirebirdMessageTemplate.UNHANDLED_EXCEPTION_EMAIL, parameterValues); emailService.sendMessage(supportEmail, null, null, message); } }