Java tutorial
/* * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others. * * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0 * * 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. * * Contributors: * Julien Anguenot * Thierry Delprat * Florent Guillaume */ package org.nuxeo.ecm.platform.audit.impl; import java.util.Date; import java.util.HashMap; import java.util.Map; import javax.persistence.CascadeType; import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.Id; import javax.persistence.JoinColumn; import javax.persistence.JoinTable; import javax.persistence.MapKey; import javax.persistence.NamedQueries; import javax.persistence.NamedQuery; import javax.persistence.OneToMany; import javax.persistence.Table; import javax.persistence.Temporal; import javax.persistence.TemporalType; import javax.persistence.Transient; import org.apache.commons.lang.builder.ToStringBuilder; import org.nuxeo.ecm.core.api.DocumentModel; import org.nuxeo.ecm.core.api.DocumentRef; import org.nuxeo.ecm.platform.audit.api.ExtendedInfo; import org.nuxeo.ecm.platform.audit.api.LogEntry; import org.nuxeo.ecm.platform.audit.api.comment.UIAuditComment; /** * Log entry implementation. */ @Entity(name = "LogEntry") @NamedQueries({ @NamedQuery(name = "LogEntry.removeByEventIdAndPath", query = "delete LogEntry log where log.eventId = :eventId and log.docPath like :pathPattern"), @NamedQuery(name = "LogEntry.findByDocument", query = "from LogEntry log where log.docUUID=:docUUID ORDER BY log.eventDate DESC"), @NamedQuery(name = "LogEntry.findByDocumentAndRepository", query = "from LogEntry log where log.docUUID=:docUUID and log.repositoryId=:repositoryId ORDER BY log.eventDate DESC"), @NamedQuery(name = "LogEntry.findAll", query = "from LogEntry log order by log.eventDate DESC"), @NamedQuery(name = "LogEntry.findByEventIdAndPath", query = "from LogEntry log where log.eventId=:eventId and log.docPath LIKE :pathPattern"), @NamedQuery(name = "LogEntry.findByHavingExtendedInfo", query = "from LogEntry log where log.extendedInfos['one'] is not null order by log.eventDate DESC"), @NamedQuery(name = "LogEntry.countEventsById", query = "select count(log.eventId) from LogEntry log where log.eventId=:eventId"), @NamedQuery(name = "LogEntry.findEventIds", query = "select distinct log.eventId from LogEntry log") }) @Table(name = "NXP_LOGS") public class LogEntryImpl implements LogEntry { private static final long serialVersionUID = 3037187381843636097L; private long id; private String principalName; private String eventId; private Date eventDate; private Date logDate; private String docUUID; private String docType; private String docPath; private String category; private String comment; private String docLifeCycle; private String repositoryId; protected transient UIAuditComment uiComment; private Map<String, ExtendedInfoImpl> extendedInfos = new HashMap<String, ExtendedInfoImpl>(); /** * @return the log identifier */ @Override @Id @GeneratedValue(strategy = GenerationType.AUTO) @Column(name = "LOG_ID", nullable = false, columnDefinition = "integer") public long getId() { return id; } @Override public void setId(long id) { this.id = id; } /** * Returns the name of the principal who originated the log entry. * * @return the name of the principal who originated the log entry */ @Override @Column(name = "LOG_PRINCIPAL_NAME") public String getPrincipalName() { return principalName; } @Override public void setPrincipalName(String principalName) { this.principalName = principalName; } /** * Returns the identifier of the event that originated the log entry. * * @return the identifier of the event that originated the log entry */ @Override @Column(name = "LOG_EVENT_ID", nullable = false) @MapKey(name = "logKey") public String getEventId() { return eventId; } @Override public void setEventId(String eventId) { this.eventId = eventId; } /** * Returns the date of the event that originated the log entry. * * @return the date of the event that originated the log entry */ @Override @Temporal(TemporalType.TIMESTAMP) @Column(name = "LOG_EVENT_DATE") public Date getEventDate() { return eventDate; } @Override public void setEventDate(Date eventDate) { this.eventDate = eventDate; } /** * @return the date of the log insertion: this up to max transaction timeout later than eventDate. This date is * useful for services such as Nuxeo Drive that need fine grained incremental near-monotonic access to the * audit log. * @since 5.7 * @since 5.6-HF16 */ @Override @Temporal(TemporalType.TIMESTAMP) @Column(name = "LOG_DATE") public Date getLogDate() { return logDate; } @Override public void setLogDate(Date logDate) { this.logDate = logDate; } /** * Returns the doc UUID related to the log entry. * <p> * It might be null if the event that originated the event is noe bound to any document. * * @return the doc UUID related to the log entry. */ @Override @Column(name = "LOG_DOC_UUID") public String getDocUUID() { return docUUID; } @Override public void setDocUUID(String docUUID) { this.docUUID = docUUID; } @Override public void setDocUUID(DocumentRef docRef) { switch (docRef.type()) { case DocumentRef.ID: docUUID = (String) docRef.reference(); break; case DocumentRef.INSTANCE: docUUID = ((DocumentModel) docRef.reference()).getId(); break; default: throw new IllegalArgumentException("not an id reference " + docRef); } } /** * Returns the doc path related to the log entry. * <p> * It might be null if the event that originated the event is noe bound to any document. * * @return the doc path related to the log entry. */ @Override @Column(name = "LOG_DOC_PATH", length = 1024) public String getDocPath() { return docPath; } @Override public void setDocPath(String docPath) { this.docPath = docPath; } /** * Returns the doc type related to the log entry. * <p> * It might be null if the event that originated the event is not bound to any document. * * @return the doc type related to the log entry. */ @Override @Column(name = "LOG_DOC_TYPE") public String getDocType() { return docType; } @Override public void setDocType(String docType) { this.docType = docType; } /** * Returns the category for this log entry. * <p> * This is defined at client level. Categories are not restricted in any ways. * * @return the category for this log entry. */ @Override @Column(name = "LOG_EVENT_CATEGORY") public String getCategory() { return category; } @Override public void setCategory(String category) { this.category = category; } /** * Returns the associated comment for this log entry. * * @return the associated comment for this log entry */ @Override @Column(name = "LOG_EVENT_COMMENT", length = 1024) public String getComment() { return comment; } @Override public void setComment(String comment) { this.comment = comment; } /** * Return the life cycle if the document related to the log entry. * <p> * It might be null if the event that originated the event is noe bound to any document. * * @return the life cycle if the document related to the log entry. */ @Override @Column(name = "LOG_DOC_LIFE_CYCLE") public String getDocLifeCycle() { return docLifeCycle; } @Override public void setDocLifeCycle(String docLifeCycle) { this.docLifeCycle = docLifeCycle; } /** * Returns the repository id related to the log entry. * * @return the repository id */ @Override @Column(name = "LOG_REPO_ID") public String getRepositoryId() { return repositoryId; } @Override public void setRepositoryId(String repositoryId) { this.repositoryId = repositoryId; } // public Map<String, ExtendedInfoImpl> getExtendedInfosImpl() { // return extendedInfos; // } // // public void setExtendedInfosImpl(Map<String, ExtendedInfoImpl> infos) { // extendedInfos = infos; // } @Override @OneToMany(cascade = CascadeType.ALL, targetEntity = ExtendedInfoImpl.class) @JoinTable(name = "NXP_LOGS_MAPEXTINFOS", joinColumns = { @JoinColumn(name = "LOG_FK") }, inverseJoinColumns = { @JoinColumn(name = "INFO_FK") }) @org.hibernate.annotations.MapKey(columns = { @Column(name = "mapkey", nullable = false) }) public Map<String, ExtendedInfo> getExtendedInfos() { return (Map) extendedInfos; // return (Map)getExtendedInfosImpl(); } @Override public void setExtendedInfos(Map<String, ExtendedInfo> infos) { extendedInfos = (Map) infos; // setExtendedInfosImpl((Map)infos); } @Override public String toString() { return ToStringBuilder.reflectionToString(this); } @Transient @Override public UIAuditComment getPreprocessedComment() { return uiComment; } @Override public void setPreprocessedComment(UIAuditComment uiComment) { this.uiComment = uiComment; } }