com.github.wnameless.spring.papertrail.AbstractJpaPaperTrail Maven / Gradle / Ivy

Go to download
/*
 *
 * Copyright 2015 Wei-Ming Wu
 *
 * 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.
 *
 */
package com.github.wnameless.spring.papertrail;

import java.io.Serializable;
import java.util.Date;

import javax.persistence.Column;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.MappedSuperclass;

import org.springframework.http.HttpMethod;

/**
 * 
 * {@link AbstractJpaPaperTrail} is a JPA implementation of {@link PaperTrail}.
 *
 */
@MappedSuperclass
public abstract class AbstractJpaPaperTrail
    implements PaperTrail, Serializable {

  private static final long serialVersionUID = 1L;

  @Id
  @GeneratedValue
  private Long id;

  @Column
  private String userId;

  @Column(nullable = false)
  private String remoteAddr;

  @Enumerated(EnumType.STRING)
  @Column(nullable = false)
  private HttpMethod httpMethod;

  @Column(nullable = false)
  private String requestUri;

  @Column(nullable = false)
  private int httpStatus;

  @Column(nullable = false)
  private Date createdAt = new Date();

  /**
   * Returns the entity ID.
   * 
   * @return an entity ID
   */
  public Long getId() {
    return id;
  }

  /**
   * Sets the entity ID.
   * 
   * @param id
   *          an entity ID
   */
  protected void setId(final Long id) {
    this.id = id;
  }

  @Override
  public String getUserId() {
    return userId;
  }

  @Override
  public void setUserId(String userId) {
    this.userId = userId;
  }

  @Override
  public String getRemoteAddr() {
    return remoteAddr;
  }

  @Override
  public void setRemoteAddr(String remoteAddr) {
    this.remoteAddr = remoteAddr;
  }

  @Override
  public HttpMethod getHttpMethod() {
    return httpMethod;
  }

  @Override
  public void setHttpMethod(HttpMethod httpMethod) {
    this.httpMethod = httpMethod;
  }

  @Override
  public String getRequestUri() {
    return requestUri;
  }

  @Override
  public void setRequestUri(String requestUri) {
    this.requestUri = requestUri;
  }

  @Override
  public int getHttpStatus() {
    return httpStatus;
  }

  @Override
  public void setHttpStatus(int httpStatus) {
    this.httpStatus = httpStatus;
  }

  @Override
  public Date getCreatedAt() {
    return createdAt;
  }

  @Override
  public void setCreatedAt(Date createdAt) {
    this.createdAt = createdAt;
  }

  @Override
  public final int hashCode() {
    int hashCode = 27;
    hashCode += null == getId() ? 0 : getId().hashCode() ^ 31;
    return hashCode;
  }

  @Override
  public final boolean equals(Object o) {
    if (o == this) return true;
    if (o == null) return false;
    if (!getClass().equals(o.getClass())) return false;
    AbstractJpaPaperTrail that = (AbstractJpaPaperTrail) o;
    return null == getId() ? false : getId().equals(that.getId());
  }

  @Override
  public String toString() {
    return getClass().getSimpleName() + "{userId=" + getUserId()
        + ", remoteAddr=" + getRemoteAddr() + ", httpMethod=" + getHttpMethod()
        + ", requestUri=" + getRequestUri() + ", httpStatus=" + getHttpStatus()
        + ", createdAt=" + getCreatedAt() + "}";
  }

}