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.service.annual.registration; import static com.google.common.base.Preconditions.checkArgument; import static gov.nih.nci.firebird.service.messages.FirebirdMessageTemplate.CTEP_INVESTIGATOR_WITHDRAWAL_REQUEST_DENIED_EMAIL_TO_INVESTIGATOR; import static gov.nih.nci.firebird.service.messages.FirebirdMessageTemplate.CTEP_INVESTIGATOR_WITHDRAWAL_REQUEST_DENIED_EMAIL_TO_OTHERS; import static gov.nih.nci.firebird.service.messages.FirebirdMessageTemplate.CTEP_INVESTIGATOR_WITHDRAWAL_REQUEST_ACCEPTED_EMAIL_TO_INVESTIGATOR; import static gov.nih.nci.firebird.service.messages.FirebirdMessageTemplate.CTEP_INVESTIGATOR_WITHDRAWAL_REQUEST_ACCEPTED_EMAIL_TO_OTHERS; import gov.nih.nci.firebird.common.FirebirdConstants; import gov.nih.nci.firebird.common.RichTextUtil; import gov.nih.nci.firebird.data.Organization; import gov.nih.nci.firebird.data.user.FirebirdUser; import gov.nih.nci.firebird.data.user.InvestigatorRole; import gov.nih.nci.firebird.data.user.InvestigatorStatus; import gov.nih.nci.firebird.data.user.InvestigatorWithdrawalRequest; import gov.nih.nci.firebird.service.ctep.esys.EsysIntegrationService; 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.sponsor.SponsorService; import gov.nih.nci.firebird.service.user.FirebirdUserService; import java.util.EnumMap; import java.util.List; import java.util.Map; import javax.annotation.Resource; import javax.ejb.Stateless; import javax.ejb.TransactionAttribute; import javax.ejb.TransactionAttributeType; import org.hibernate.Session; import org.hibernate.criterion.Restrictions; import com.google.inject.Inject; import com.google.inject.Provider; import com.google.inject.name.Named; /** * Provides service methods dealing with registration withdrawals. */ @Stateless @TransactionAttribute(TransactionAttributeType.REQUIRED) @SuppressWarnings({ "PMD.TooManyMethods", "PMD.TooManyStaticImports" }) // requires many supporting methods for readability // static imports are for enums public class RegistrationWithdrawalServiceBean implements RegistrationWithdrawalService { private FirebirdUserService userService; private SponsorService sponsorService; private EmailService emailService; private TemplateService templateService; private EsysIntegrationService esysIntegrationService; private AnnualRegistrationService annualRegistrationService; private Provider<Session> sessionProvider; private String registrationNotificationMailbox; @Override public void requestWithdrawal(FirebirdUser investigatorUser, String explanation) { checkArgument(investigatorUser.isInvestigator(), "Passed in user to withdraw is not an investigator"); InvestigatorWithdrawalRequest request = new InvestigatorWithdrawalRequest(explanation); investigatorUser.getInvestigatorRole().setWithdrawalRequest(request); userService.save(investigatorUser); sendWithdrawalRequestNotification(investigatorUser, explanation); } private void sendWithdrawalRequestNotification(FirebirdUser investigatorUser, String explanation) { Organization sponsor = sponsorService.getSponsorOrganizationWithAnnualRegistrations(); String sponsorEmailAddress = sponsorService.getSponsorEmailAddress(sponsor); Map<FirebirdTemplateParameter, Object> parameterValues = new EnumMap<FirebirdTemplateParameter, Object>( FirebirdTemplateParameter.class); parameterValues.put(FirebirdTemplateParameter.INVESTIGATOR, investigatorUser.getInvestigatorRole().getProfile().getPerson()); parameterValues.put(FirebirdTemplateParameter.COMMENTS, RichTextUtil.convertToPlainText(explanation)); parameterValues.put(FirebirdTemplateParameter.FIREBIRD_LINK, FirebirdConstants.FIREBIRD_HOME_URL_PATH); FirebirdMessage message = templateService.generateMessage( FirebirdMessageTemplate.CTEP_INVESTIGATOR_WITHDRAWAL_REQUEST_EMAIL, parameterValues); emailService.sendMessage(sponsorEmailAddress, null, null, message); } @Override @SuppressWarnings("unchecked") public List<FirebirdUser> getAllInvestigatorsWithPendingWithdrawalRequests() { return sessionProvider.get().createCriteria(FirebirdUser.class) .add(Restrictions.isNotNull("investigatorRole.withdrawalRequest.explanation")) .add(Restrictions.not(Restrictions.eq("investigatorRole.status", InvestigatorStatus.WITHDRAWN))) .list(); } @Override public void denyWithdrawalRequest(InvestigatorWithdrawalRequest request, String denialExplanation) { removeWithdrawalRequest(request); sendWithdrawalRequestDeniedEmails(request, RichTextUtil.convertToPlainText(denialExplanation)); } private void removeWithdrawalRequest(InvestigatorWithdrawalRequest request) { request.setExplanation(null); } private void sendWithdrawalRequestDeniedEmails(InvestigatorWithdrawalRequest request, String explanation) { sendWithdrawalRequestEmailToInvestigator(request, explanation, CTEP_INVESTIGATOR_WITHDRAWAL_REQUEST_DENIED_EMAIL_TO_INVESTIGATOR); sendWithdrawalRequestEmailToCoordinator(request, explanation, CTEP_INVESTIGATOR_WITHDRAWAL_REQUEST_DENIED_EMAIL_TO_OTHERS); sendWithdrawalRequestEmailToRegistrationNotificationMailbox(request, explanation, CTEP_INVESTIGATOR_WITHDRAWAL_REQUEST_DENIED_EMAIL_TO_OTHERS); } private void sendWithdrawalRequestEmailToInvestigator(InvestigatorWithdrawalRequest request, String explanation, FirebirdMessageTemplate messageTemplate) { String investigatorEmail = request.getInvestigatorRole().getProfile().getPerson().getEmail(); sendWithdrawalRequestDecisionEmail(request, explanation, messageTemplate, investigatorEmail); } private void sendWithdrawalRequestDecisionEmail(InvestigatorWithdrawalRequest request, String explanation, FirebirdMessageTemplate template, String toEmail) { Map<FirebirdTemplateParameter, Object> parameterValues = new EnumMap<FirebirdTemplateParameter, Object>( FirebirdTemplateParameter.class); parameterValues.put(FirebirdTemplateParameter.COMMENTS, RichTextUtil.convertToPlainText(explanation)); parameterValues.put(FirebirdTemplateParameter.INVESTIGATOR, request.getInvestigatorRole().getProfile().getPerson()); FirebirdMessage message = templateService.generateMessage(template, parameterValues); emailService.sendMessage(toEmail, null, null, message); } private void sendWithdrawalRequestEmailToCoordinator(InvestigatorWithdrawalRequest request, String explanation, FirebirdMessageTemplate messageTemplate) { if (request.getInvestigatorRole().getProfile().hasCtepRegistrationCoordinator()) { String coordinatorEmail = request.getInvestigatorRole().getProfile() .getCtepRegistrationCoordinatorMapping().getUser().getPerson().getEmail(); sendWithdrawalRequestDecisionEmail(request, explanation, messageTemplate, coordinatorEmail); } } private void sendWithdrawalRequestEmailToRegistrationNotificationMailbox(InvestigatorWithdrawalRequest request, String explanation, FirebirdMessageTemplate messageTemplate) { sendWithdrawalRequestDecisionEmail(request, explanation, messageTemplate, registrationNotificationMailbox); } @Override public void acceptWithdrawalRequest(InvestigatorWithdrawalRequest request, FirebirdUser approver) { request.getInvestigatorRole().setStatus(InvestigatorStatus.WITHDRAWN); esysIntegrationService.withdrawInvestigator(request.getInvestigatorRole().getUser(), approver); annualRegistrationService.removeUnFinalizedRegistrations(request.getInvestigatorRole().getUser()); sendWithdrawalRequestAcceptedEmails(request); } private void sendWithdrawalRequestAcceptedEmails(InvestigatorWithdrawalRequest request) { sendWithdrawalRequestEmailToInvestigator(request, null, CTEP_INVESTIGATOR_WITHDRAWAL_REQUEST_ACCEPTED_EMAIL_TO_INVESTIGATOR); sendWithdrawalRequestEmailToCoordinator(request, null, CTEP_INVESTIGATOR_WITHDRAWAL_REQUEST_ACCEPTED_EMAIL_TO_OTHERS); sendWithdrawalRequestEmailToRegistrationNotificationMailbox(request, null, CTEP_INVESTIGATOR_WITHDRAWAL_REQUEST_ACCEPTED_EMAIL_TO_OTHERS); } @Override public void reactivateInvestigator(FirebirdUser investigator) { checkArgument(investigator.isInvestigator(), "Passed in user to reactivate is not an investigator"); InvestigatorRole investigatorRole = investigator.getInvestigatorRole(); annualRegistrationService.createReactivatedRegistration(investigatorRole.getProfile()); investigatorRole.setStatus(InvestigatorStatus.ACTIVE); //remove the withdrawal request now its being reactivated investigatorRole.setWithdrawalRequest(null); } @Resource(mappedName = "firebird/FirebirdUserServiceBean/local") void setUserService(FirebirdUserService userService) { this.userService = userService; } @Resource(mappedName = "firebird/SponsorServiceBean/local") void setSponsorService(SponsorService sponsorService) { this.sponsorService = sponsorService; } @Inject void setEmailService(@Named("jmsEmailService") EmailService emailService) { this.emailService = emailService; } @Inject void setTemplateService(TemplateService templateService) { this.templateService = templateService; } @Resource(mappedName = "firebird/EsysIntegrationServiceBean/local") void setEsysIntegrationService(EsysIntegrationService esysIntegrationService) { this.esysIntegrationService = esysIntegrationService; } @Resource(mappedName = "firebird/AnnualRegistrationServiceBean/local") void setAnnualRegistrationService(AnnualRegistrationService annualRegistrationService) { this.annualRegistrationService = annualRegistrationService; } @Inject void setSessionProvider(Provider<Session> sessionProvider) { this.sessionProvider = sessionProvider; } @Inject void setRegistrationNotificationMailbox( @Named("ctep.registration.notification.mailbox") String registrationNotificationMailbox) { this.registrationNotificationMailbox = registrationNotificationMailbox; } }