com.fluidbpm.program.api.vo.attachment.Attachment Maven / Gradle / Ivy
Show all versions of fluid-api Show documentation
/*
* Koekiebox CONFIDENTIAL
*
* [2012] - [2017] Koekiebox (Pty) Ltd
* All Rights Reserved.
*
* NOTICE: All information contained herein is, and remains the property
* of Koekiebox and its suppliers, if any. The intellectual and
* technical concepts contained herein are proprietary to Koekiebox
* and its suppliers and may be covered by South African and Foreign Patents,
* patents in process, and are protected by trade secret or copyright law.
* Dissemination of this information or reproduction of this material is strictly
* forbidden unless prior written permission is obtained from Koekiebox.
*/
package com.fluidbpm.program.api.vo.attachment;
import com.fluidbpm.program.api.util.UtilGlobal;
import com.fluidbpm.program.api.vo.ABaseFluidJSONObject;
import com.fluidbpm.program.api.vo.form.Form;
import com.fluidbpm.program.api.vo.item.FluidItem;
import com.google.common.io.BaseEncoding;
import org.json.JSONException;
import org.json.JSONObject;
import javax.xml.bind.annotation.XmlTransient;
import java.io.File;
import java.util.Date;
/**
* Represents an Fluid Field for Form, User, Route and Global.
*
* {@code Field} can be part of Electronic Form or Form Definition in Fluid.
*
* @author jasonbruwer
* @since v1.0
*
* @see Form
* @see FluidItem
* @see com.fluidbpm.program.api.vo.mail.MailMessage
* @see com.fluidbpm.program.api.vo.mail.MailMessageAttachment
*/
public class Attachment extends ABaseFluidJSONObject {
public static final long serialVersionUID = 1L;
private String version;
private String name;
private String path;
private String contentType;
private Date dateLastUpdated;
private Date dateCreated;
private String attachmentDataBase64;
private Long formId;
/**
* The JSON mapping for the {@code Attachment} object.
*/
public static class JSONMapping {
public static final String NAME = "name";
public static final String PATH = "path";
public static final String VERSION = "version";
public static final String CONTENT_TYPE = "contentType";
public static final String DATE_LAST_UPDATED = "dateLastUpdated";
public static final String DATE_CREATED = "dateCreated";
public static final String FORM_ID = "formId";
public static final String ATTACHMENT_DATA_BASE64 = "attachmentDataBase64";
}
/**
* Default constructor.
*/
public Attachment() {
super();
}
/**
* Sets the Id associated with the Attachment.
*
* @param attachmentIdParam Attachment Id.
*/
public Attachment(Long attachmentIdParam) {
super();
this.setId(attachmentIdParam);
}
/**
* Sets the Path and Name of {@code this} {@code Attachment}.
*
* @param attachmentPath Sets the {@code Attachment} path.
* @param attachmentNameParam Sets the {@code Attachment} name.
*/
public Attachment(String attachmentPath, String attachmentNameParam) {
super();
this.setPath(attachmentPath);
this.setName(attachmentNameParam);
}
/**
* Sets the Path {@code this} {@code Attachment}.
*
* @param attachmentPath The path to the {@code Attachment}.
*/
public Attachment(String attachmentPath) {
super();
this.setPath(attachmentPath);
File theFile = new File(attachmentPath);
if (theFile.exists() && theFile.isFile())
{
this.setName(theFile.getName());
}
}
/**
* Create a clone from {@code toClone}
* @param toClone
*/
private Attachment(Attachment toClone) {
if (toClone == null) {
return;
}
this.setAttachmentDataBase64(toClone.getAttachmentDataBase64());
this.setContentType(toClone.getContentType());
this.setDateCreated(toClone.getDateCreated() == null ?
null : new Date(toClone.getDateCreated().getTime()));
this.setDateLastUpdated(toClone.getDateLastUpdated() == null ?
null : new Date(toClone.getDateLastUpdated().getTime()));
this.setFormId(toClone.getFormId());
this.setName(toClone.getName());
this.setPath(toClone.getPath());
this.setVersion(toClone.getVersion());
this.setId(toClone.getId());
this.setEcho(toClone.getEcho());
this.setServiceTicket(toClone.getServiceTicket());
this.setRequestUuid(toClone.getRequestUuid());
}
/**
* Populates local variables with {@code jsonObjectParam}.
*
* @param jsonObjectParam The JSON Object.
*/
public Attachment(JSONObject jsonObjectParam) {
super(jsonObjectParam);
if (this.jsonObject == null)
{
return;
}
//Name...
if (!this.jsonObject.isNull(JSONMapping.NAME)) {
this.setName(this.jsonObject.getString(JSONMapping.NAME));
}
//Path...
if (!this.jsonObject.isNull(JSONMapping.PATH)) {
this.setPath(this.jsonObject.getString(JSONMapping.PATH));
}
//Version...
if (!this.jsonObject.isNull(JSONMapping.VERSION)) {
this.setVersion(this.jsonObject.getString(JSONMapping.VERSION));
}
//Content Type...
if (!this.jsonObject.isNull(JSONMapping.CONTENT_TYPE)) {
this.setContentType(this.jsonObject.getString(JSONMapping.CONTENT_TYPE));
}
//Form Id...
if (!this.jsonObject.isNull(JSONMapping.FORM_ID)) {
this.setFormId(this.jsonObject.getLong(JSONMapping.FORM_ID));
}
//Date Created...
if (!this.jsonObject.isNull(JSONMapping.DATE_CREATED)) {
this.setDateCreated(new Date(
this.jsonObject.getLong(JSONMapping.DATE_CREATED)));
}
//Date Last Updated...
if (!this.jsonObject.isNull(JSONMapping.DATE_LAST_UPDATED)) {
this.setDateLastUpdated(new Date(
this.jsonObject.getLong(JSONMapping.DATE_LAST_UPDATED)));
}
//Attachment Data...
if (!this.jsonObject.isNull(JSONMapping.ATTACHMENT_DATA_BASE64)) {
this.setAttachmentDataBase64(this.jsonObject.getString(
JSONMapping.ATTACHMENT_DATA_BASE64));
}
}
/**
* Gets the version of {@code this} {@code Attachment}.
*
* @return Attachment version.
*/
public String getVersion() {
return this.version;
}
/**
* Sets the version of {@code this} {@code Attachment}.
*
* @param versionParam Attachment version.
*/
public void setVersion(String versionParam) {
this.version = versionParam;
}
/**
* Gets the name of {@code this} {@code Attachment}.
*
* @return Attachment name.
*/
public String getName() {
return this.name;
}
/**
* Sets the name of {@code this} {@code Attachment}.
*
* @param nameParam Attachment name.
*/
public void setName(String nameParam) {
this.name = nameParam;
}
/**
* Gets the path of {@code this} {@code Attachment}.
*
* @return Attachment path.
*/
public String getPath() {
return this.path;
}
/**
* Sets the path of {@code this} {@code Attachment}.
*
* @param pathParam Attachment path.
*/
public void setPath(String pathParam) {
this.path = pathParam;
}
/**
* Gets the id of {@code this} {@code Attachment} form parent.
*
* @return Attachment associated Form Id.
*/
public Long getFormId() {
return this.formId;
}
/**
* Sets the id of {@code this} {@code Attachment} form parent.
*
* @param formIdParam Attachment associated Form Id.
*/
public void setFormId(Long formIdParam) {
this.formId = formIdParam;
}
/**
* Gets the content-type of {@code this} {@code Attachment}.
*
* @return Attachment Content / Mime Type.
*/
public String getContentType() {
return this.contentType;
}
/**
* Sets the content-type of {@code this} {@code Attachment}.
*
* @param contentTypeParam Attachment Content / Mime Type.
*/
public void setContentType(String contentTypeParam) {
this.contentType = contentTypeParam;
}
/**
* Gets the {@code Date} when {@code this} {@code Attachment} was last updated.
*
* @return Attachment Last Updated Date.
*/
public Date getDateLastUpdated() {
return this.dateLastUpdated;
}
/**
* Sets the {@code Date} when {@code this} {@code Attachment} was last updated.
*
* @param dateLastUpdatedParam Attachment Last Updated Date.
*/
public void setDateLastUpdated(Date dateLastUpdatedParam) {
this.dateLastUpdated = dateLastUpdatedParam;
}
/**
* Gets the {@code Date} when {@code this} {@code Attachment} was created.
*
* @return Attachment Created Date.
*/
public Date getDateCreated() {
return this.dateCreated;
}
/**
* Sets the {@code Date} when {@code this} {@code Attachment} was created.
*
* @param dateCreatedParam Attachment Created Date.
*/
public void setDateCreated(Date dateCreatedParam) {
this.dateCreated = dateCreatedParam;
}
/**
*
* The data for {@code this} {@code Attachment} in Base-64 encoding.
*
*
* Find out more at;
* https://en.wikipedia.org/wiki/Base64
*
* @return Attachment Data in Base-64 encoding.
*/
public String getAttachmentDataBase64() {
return this.attachmentDataBase64;
}
/**
*
* The data for {@code this} {@code Attachment} in Base-64 encoding.
*
*
* Find out more at;
* https://en.wikipedia.org/wiki/Base64
*
* @param attachmentDataBase64Param Attachment Data in Base-64 encoding.
*/
public void setAttachmentDataBase64(String attachmentDataBase64Param) {
this.attachmentDataBase64 = attachmentDataBase64Param;
}
/**
* Checks to see whether {@code this} {@code Attachment} name contains
* the value {@code containingTextParam}.
*
* @param containingTextParam The text to check for (not case sensitive).
* @return Whether the {@code Attachment} name contains {@code containingTextParam}.
*/
@XmlTransient
public boolean doesNameContain(String containingTextParam) {
if (this.getName() == null || this.getName().trim().isEmpty()) {
return false;
}
if (containingTextParam == null || containingTextParam.trim().isEmpty()) {
return false;
}
String paramLower = containingTextParam.toLowerCase();
String nameLower = this.getName().toLowerCase();
return nameLower.contains(paramLower);
}
/**
* Conversion to {@code JSONObject} from Java Object.
*
* @return {@code JSONObject} representation of {@code Attachment}
* @throws JSONException If there is a problem with the JSON Body.
*
* @see ABaseFluidJSONObject#toJsonObject()
*/
@Override
public JSONObject toJsonObject() throws JSONException {
JSONObject returnVal = super.toJsonObject();
//Attachment Data...
if (this.getAttachmentDataBase64() != null) {
returnVal.put(JSONMapping.ATTACHMENT_DATA_BASE64, this.getAttachmentDataBase64());
}
//Content Type...
if (this.getContentType() != null) {
returnVal.put(JSONMapping.CONTENT_TYPE, this.getContentType());
}
//Form Id...
if (this.getFormId() != null) {
returnVal.put(JSONMapping.FORM_ID, this.getFormId());
}
//Name...
if (this.getName() != null) {
returnVal.put(JSONMapping.NAME, this.getName());
}
//Path...
if (this.getPath() != null) {
returnVal.put(JSONMapping.PATH, this.getPath());
}
//Version...
if (this.getVersion() != null) {
returnVal.put(JSONMapping.VERSION, this.getVersion());
}
//Date Created...
if (this.getDateCreated() != null) {
returnVal.put(JSONMapping.DATE_CREATED, this.getDateCreated().getTime());
}
//Date Last Updated...
if (this.getDateLastUpdated() != null) {
returnVal.put(JSONMapping.DATE_LAST_UPDATED, this.getDateLastUpdated().getTime());
}
return returnVal;
}
/**
* Clone {@code this} object.
*
* @return cloned instance of {@code Attachment}.
*/
@Override
public Attachment clone() {
return new Attachment(this);
}
/**
* Verifies whether attachment file type is {@code image/*}.
* @return {@code true} if content type is image.
*/
@XmlTransient
public boolean isFileTypeImage() {
if (this.getContentType() == null || this.getContentType().trim().isEmpty()) return false;
return (this.getContentType().trim().toLowerCase().startsWith("image"));
}
/**
* Verifies whether attachment type is {@code application/pdf}.
* @return {@code true} if content type is PDF.
*/
@XmlTransient
public boolean isFileTypePDF() {
return "application/pdf".equals(this.getContentType().trim().toLowerCase());
}
/**
* Verifies whether attachment type is Microsoft MS Word.
* @return {@code true} if content type is Microsoft Word Document.
*/
@XmlTransient
public boolean isFileTypeMSWord() {
String contentTypeLower = this.getContentType() == null ? null : this.getContentType().trim().toLowerCase();
switch (contentTypeLower) {
case "application/msword" :
case "application/vnd.openxmlformats-officedocument.wordprocessingml.document" :
case "application/vnd.openxmlformats-officedocument.wordprocessingml.template" :
return true;
default:
return false;
}
}
/**
* Verifies whether attachment type is Microsoft MS Word.
* @return {@code true} if content type is Microsoft Word Document.
*/
@XmlTransient
public boolean isFileTypeMSExcel() {
String contentTypeLower = this.getContentType() == null ? null : this.getContentType().trim().toLowerCase();
switch (contentTypeLower) {
case "application/vnd.ms-excel" :
case "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" :
case "application/vnd.openxmlformats-officedocument.spreadsheetml.template" :
return true;
default:
return false;
}
}
/**
* Verifies whether attachment type is {@code application/json}.
* @return {@code true} if content type is JSON.
*/
@XmlTransient
public boolean isFileTypeJSON() {
return "application/json".equals(this.getContentType().trim().toLowerCase());
}
/**
* Friendly name for content-type.
* @return String - The user friendly name for the content type.
*/
@XmlTransient
public String getContentTypeFriendly() {
if (this.isFileTypeImage()) return "Image";
if (this.isFileTypePDF()) return "PDF";
if (this.isFileTypeMSWord()) return "Office Word";
if (this.isFileTypeJSON()) return "JSON";
if (this.isFileTypeMSExcel()) return "Office Excel";
return this.getContentType();
}
/**
* Convert the Base64 encoded attachment data to binary.
* @return {@code byte[]}
*/
@XmlTransient
public byte[] getAttachmentDataRAW() {
if (UtilGlobal.isBlank(this.getAttachmentDataBase64())) return null;
return BaseEncoding.base64().decode(this.getAttachmentDataBase64());
}
/**
* @return Extension from filename.
*/
@XmlTransient
public String getExtensionFromFilename() {
if (this.getName() == null) return null;
int indexOf = this.getName().lastIndexOf(".");
if (indexOf > -1) return this.getName().substring(indexOf);
return null;
}
}