FacilitySession.java

/*
* Copyright 2012, CMM, University of Queensland.
*
* This file is part of Eccles.
*
* Eccles is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Eccles is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Eccles. If not, see <http://www.gnu.org/licenses/>.
*/

package au.edu.uq.cmm.eccles;

import java.util.Date;
import java.util.UUID;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.Transient;
import javax.persistence.UniqueConstraint;

import org.hibernate.annotations.GenericGenerator;

/**
 * A FacilitySession records minimal details of an ACLS Facility sesssion.
 * 
 * @author scrawley
 */
@Entity
@Table(name = "SESSIONS",
       uniqueConstraints=@UniqueConstraint(columnNames={"sessionUuid"}))
public class FacilitySession {
    public static final String UNKNOWN = "unknown";
    
    private String userName;
    private String account;
    private String facilityName;
    private Date loginTime;
    private Date logoutTime;
    private Long id;
    private String sessionUuid;
    private String emailAddress;
    private Date inferredLogoutTime;
    
    public FacilitySession() {
        super();
    }
    
    public FacilitySession(String facilityName) {
        this.facilityName = facilityName;
    }
    
    public FacilitySession(String userName, String account, String facilityName,
            String emailAddress, Date loginTime) {
        super();
        if (userName.isEmpty() || account.isEmpty() || 
                facilityName == null || loginTime == null) {
            throw new IllegalArgumentException("Empty or missing argument");
        }
        this.userName = userName;
        this.account = account;
        this.facilityName = facilityName;
        this.loginTime = loginTime;
        this.emailAddress = emailAddress;
        this.sessionUuid = UUID.randomUUID().toString();
    }

    /**
     * Get the logout timestamp.
     * @return the logout timestamp or ({@literal null} if the session is still
     *     notionally in progress.
     */
    public Date getLogoutTime() {
        return logoutTime;
    }

    @Temporal(TemporalType.TIMESTAMP)
    public void setLogoutTime(Date logoutTime) {
        this.logoutTime = logoutTime;
    }

    public String getUserName() {
        return userName;
    }

    public String getAccount() {
        return account;
    }

    @Temporal(TemporalType.TIMESTAMP)
    public Date getLoginTime() {
        return loginTime;
    }

    @Id
    @GeneratedValue(generator="increment")
    @GenericGenerator(name="increment", strategy = "increment")
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public void setAccount(String account) {
        this.account = account;
    }

    public void setLoginTime(Date loginTime) {
        this.loginTime = loginTime;
    }

    public String getSessionUuid() {
        return sessionUuid;
    }

    public void setSessionUuid(String sessionUuid) {
        this.sessionUuid = sessionUuid;
    }

    public String getEmailAddress() {
        return emailAddress;
    }

    public void setEmailAddress(String emailAddress) {
        this.emailAddress = emailAddress;
    }

    public String getFacilityName() {
        return facilityName;
    }

    public void setFacilityName(String facilityName) {
        this.facilityName = facilityName;
    }

    @Transient
    public Date getInferredLogoutTime() {
        return inferredLogoutTime;
    }
    
    public void setInferredLogoutTime(Date inferredLogoutTime) {
        this.inferredLogoutTime = inferredLogoutTime;
    }

    public static FacilitySession makeDummySession(String facilityName, long timestamp) {
        FacilitySession res = new FacilitySession(
                FacilitySession.UNKNOWN, FacilitySession.UNKNOWN, 
                facilityName, null, new Date(timestamp));
        res.setSessionUuid(FacilitySession.UNKNOWN);
        return res;
    }

    @Override
    public String toString() {
        return "FacilitySession [userName=" + userName + ", account=" + account
                + ", facilityName=" + facilityName + ", loginTime=" + loginTime
                + ", logoutTime=" + logoutTime + ", id=" + id
                + ", sessionUuid=" + sessionUuid + ", emailAddress="
                + emailAddress + "]";
    }

}