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 po-app * 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 po-app 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 po-app Software to (i) use, install, access, operate, * execute, copy, modify, translate, market, publicly display, publicly perform, * and prepare derivative works of the po-app Software; (ii) distribute and * have distributed to and by third parties the po-app 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 com.fiveamsolutions.nci.commons.audit; import java.util.Date; import javax.persistence.CascadeType; import javax.persistence.Entity; import javax.persistence.EnumType; import javax.persistence.Enumerated; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.Id; import javax.persistence.OneToMany; import javax.persistence.Temporal; import javax.persistence.TemporalType; import org.apache.commons.lang.builder.ToStringBuilder; import org.hibernate.annotations.Cache; import org.hibernate.annotations.CacheConcurrencyStrategy; import org.hibernate.validator.Length; import org.hibernate.validator.NotNull; import com.fiveamsolutions.nci.commons.data.persistent.PersistentObject; import java.util.LinkedHashSet; import java.util.Set; import javax.persistence.OrderBy; /** * Audit log records document changes to entities. A single audit log record records * multiple changes to a single entity (via it's details.) Multiple entities that are * changed as part of a single transaction are grouped together via a transaction id. */ @Entity @org.hibernate.annotations.Entity(mutable = false) @Cache(usage = CacheConcurrencyStrategy.READ_ONLY) @SuppressWarnings("PMD.AvoidDuplicateLiterals") // "unused" appears multiple times public class AuditLogRecord implements PersistentObject { private static final long serialVersionUID = -7534836139333622418L; private static final int ENTITY_NAME_LENGTH = 254; private static final int USERNAME_LENGTH = 100; // from CSM definitions private Long id; private AuditType type; private String entityName; private Long entityId; // 'Long' not 'long' since we can construct (but not save) with null private String username; private Date createdDate; private long transactionId; private Set<AuditLogDetail> details = new LinkedHashSet<AuditLogDetail>(); /** * Construct a new audit log record. All fields must be non-null. * * @param type audit type * @param entityName type of entity being audited * @param entityId id of entity being audited * @param username user making the change * @param createdDate audit date (usually now) */ public AuditLogRecord(AuditType type, String entityName, Long entityId, String username, Date createdDate) { this.type = type; this.entityName = entityName; this.entityId = entityId; this.username = username; this.createdDate = createdDate; } /** * @deprecated hibernate-only */ @Deprecated public AuditLogRecord() { // hibernate-only } /** * @return database identifier */ @Id @GeneratedValue(strategy = GenerationType.AUTO) public Long getId() { return this.id; } @SuppressWarnings("unused") private void setId(Long id) { this.id = id; } /** * @return insert or update */ @Enumerated(value = EnumType.STRING) @NotNull public AuditType getType() { return this.type; } @SuppressWarnings("unused") private void setType(AuditType type) { this.type = type; } /** * @return the type of entity this log entry is for */ @NotNull @Length(max = ENTITY_NAME_LENGTH) public String getEntityName() { return this.entityName; } @SuppressWarnings("unused") private void setEntityName(String entityName) { this.entityName = entityName; } /** * @return the database identifier for the object this log entry applies to */ @NotNull public Long getEntityId() { return this.entityId; } /** * @param entityId entity id */ public void setEntityId(Long entityId) { this.entityId = entityId; } /** * @return user that created this audit entry */ @Length(max = USERNAME_LENGTH) @NotNull public String getUsername() { return this.username; } @SuppressWarnings("unused") private void setUsername(String username) { this.username = username; } /** * @return create date */ @Temporal(TemporalType.TIMESTAMP) @NotNull public Date getCreatedDate() { return this.createdDate; } @SuppressWarnings("unused") private void setCreatedDate(Date createdDate) { this.createdDate = createdDate; } /** * @return transaction id */ @NotNull public long getTransactionId() { return this.transactionId; } /** * @param transactionId common cross-record transaction id */ public void setTransactionId(long transactionId) { this.transactionId = transactionId; } /** * @return the details */ @OneToMany(mappedBy = "record", cascade = CascadeType.ALL) @OrderBy(value = "id asc") @Cache(usage = CacheConcurrencyStrategy.READ_WRITE) public Set<AuditLogDetail> getDetails() { return details; } @SuppressWarnings("unused") private void setDetails(Set<AuditLogDetail> details) { this.details = details; } /** * {@inheritDoc} */ @Override public String toString() { return ToStringBuilder.reflectionToString(this); } }