Package org.jlab.jlog

Class LogEntry

java.lang.Object

org.jlab.jlog.LogEntry

public class LogEntry
extends Object

An electronic log book log entry.

Constructor Summary

Constructors

Constructor	Description
LogEntry(String filePath)	Construct a new LogEntry from the specified XML file.
LogEntry(String title, String books)	Construct a new LogEntry with the specified title and log books designation.

Method Summary

Modifier and Type	Method	Description
void	addAttachment(String filepath)	Add a file attachment with an empty caption and a hastily guessed mime type.
void	addAttachment(String filepath, String caption)	Add a file attachment with the specified caption and a hastily guessed mime type.
void	addAttachment(String filepath, String caption, String mimeType)	Add a file attachment with the specified caption and mime type.
void	addEntryMakers(String entrymakers)	Add a comma-separated list of entry makers to the log entry.
void	addEntryMakers(String[] entrymakers)	Add an array of entry makers to the log entry.
void	addLogboks(String[] books)	Add an array of log books to this log entry.
void	addLogbooks(String books)	Add a comma-separated list of log books to this log entry.
void	addReference(Reference ref)	Add a reference to this log entry.
void	addTags(String tags)	Add a comma-separated list of tags to the log entry.
void	addTags(String[] tags)	Add an array of tags to the log entry.
void	deleteAttachments()	Remove the file attachments.
void	deleteReferences()	Remove the references from the log entry.
Attachment[]	getAttachments()	Return the file attachments.
String	getAuthor()	Return the author username.
Body	getBody()	Return the body.
String	getClientCertificatePath()	Get the path to the PEM-encoded client certificate.
GregorianCalendar	getCreated()	Return the created date/time.
String[]	getEmailNotify()	Return the array of email addresses.
String	getEmailNotifyCSV()	Return the comma-separated list of email addresses.
String[]	getEntryMakers()	Return the entry makers as an array.
String	getEntryMakersCSV()	Return the entry makers as comma-separated-values.
String[]	getLogbooks()	Return the log books as an array.
String	getLogbooksCSV()	Return the log books as comma-separated-values.
static LogEntry	getLogEntry(long lognumber, String reason)	Factory method to obtain an existing LogEntry for viewing or revising.
Long	getLogNumber()	Return the log number or null if none assigned.
ProblemReport	getProblemReport()	Get the problem report information.
Reference[]	getReferences()	Return the references.
String[]	getTags()	Return the tags as an array.
String	getTagsCSV()	Return the tags as comma-separated-values.
String	getTitle()	Return the title.
String	getXML()	Return the XML.
boolean	isSticky()	Return true if sticky, false if not.
static void	main(String[] args)	The entrypoint if this library is invoked as a command line application.
void	setBody(String content)	Set the body to the specified plain text content.
void	setBody(String content, Body.ContentType type)	Set the body to the specified content and content type.
void	setBody(Body body)
void	setClientCertificatePath(String certificatePath, boolean updateAuthor)	Set the path to the PEM-encoded client certificate.
void	setEmailNotify(String addresses)	Set the comma-separated list of email addresses used for notification.
void	setEmailNotify(String[] addresses)	Set the array of email addresses used for notification.
void	setEntryMakers(String entrymakers)	Replace the entry makers with the specified comma-separated-values.
void	setEntryMakers(String[] entrymakers)	Replace the entry makers with the specified array.
void	setLogbooks(String books)	Replace the existing log books with the specified comma-separated-values.
void	setLogbooks(String[] books)	Replace the existing log books with the specified array.
void	setProblemReport(ProblemReport report)	Set the problem report information.
void	setSticky(boolean sticky)	Set the sticky value of this log entry.
void	setTags(String tags)	Replace the existing tags with the specified comma-separated-values.
void	setTags(String[] tags)	Replace the existing tags with the specified array of tags.
void	setTitle(String title)	Set the title to a new value.
long	submit()	Submit the log item using the queue mechanism as a fallback and return the log number.
long	submitNow()	Submit the log item using only direct submission to the server using the client certificate named .elogcert in the user's home directory and return the log number.
LogException	whyQueued()	Return the LogException which prevented direct submission to the server on the most recent attempt, or null if none.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LogEntry

public LogEntry(String title,
 String books)
         throws LogRuntimeException

Construct a new LogEntry with the specified title and log books designation.

Parameters:

title - The title

books - A comma-separated list of log books

Throws:

LogRuntimeException - If unable to construct a new LogEntry

LogEntry

public LogEntry(String filePath)
         throws SchemaUnavailableException,
MalformedXMLException,
InvalidXMLException,
LogIOException,
AttachmentSizeException,
LogRuntimeException

Construct a new LogEntry from the specified XML file.

Parameters:

filePath - The path to the XML file

Throws:

SchemaUnavailableException - If the XML schema is unavailable

MalformedXMLException - If the XML is malformed

InvalidXMLException - If the XML is invalid

LogIOException - If unable to construct due to IO

AttachmentSizeException - If attachments cross a size limit

LogRuntimeException - If unable to construct

Method Details

setProblemReport

public void setProblemReport(ProblemReport report)

Set the problem report information. Use null to clear it.

Parameters:

report - The problem report information.

getProblemReport

public ProblemReport getProblemReport()

Get the problem report information.

Returns:

The problem report information or null if none

getLogEntry

public static LogEntry getLogEntry(long lognumber,
 String reason)
                            throws SchemaUnavailableException,
MalformedXMLException,
InvalidXMLException,
LogIOException,
AttachmentSizeException,
LogRuntimeException

Factory method to obtain an existing LogEntry for viewing or revising. If the intention is for viewing provide null for the reason.

Parameters:

lognumber - The log number.

reason - The reason for the revision

Returns:

The LogEntry

Throws:

SchemaUnavailableException - If the XML schema is unavailable

MalformedXMLException - If the XML is malformed

InvalidXMLException - If the XML is invalid

LogIOException - If unable to construct due to IO

AttachmentSizeException - If attachments cross a size limit

LogRuntimeException - If unable to construct

addLogboks

public void addLogboks(String[] books)
                throws LogRuntimeException

Add an array of log books to this log entry. See the Overview for a list of valid logbooks.

Parameters:

books - The log books

Throws:

LogRuntimeException - If unable to add log books

addLogbooks

public void addLogbooks(String books)
                 throws LogRuntimeException

Add a comma-separated list of log books to this log entry. See the Overview for a list of valid logbooks.

Parameters:

books - The log books

Throws:

LogRuntimeException - If unable to add log books

setLogbooks

public void setLogbooks(String[] books)
                 throws LogRuntimeException

Replace the existing log books with the specified array. See the Overview for a list of valid logbooks.

Parameters:

books - The log books

Throws:

LogRuntimeException - If unable to set log books

setLogbooks

public void setLogbooks(String books)
                 throws LogRuntimeException

Replace the existing log books with the specified comma-separated-values. See the Overview for a list of valid logbooks.

Parameters:

books - The log books

Throws:

LogRuntimeException - If unable to set the log books

getLogbooksCSV

public String getLogbooksCSV()
                      throws LogRuntimeException

Return the log books as comma-separated-values.

Returns:

The log books

Throws:

LogRuntimeException - If unable to return the log books

getLogbooks

public String[] getLogbooks()
                     throws LogRuntimeException

Return the log books as an array.

Returns:

The log books

Throws:

LogRuntimeException - If unable to return the log books

addTags

public void addTags(String[] tags)
             throws LogRuntimeException

Add an array of tags to the log entry. See the Overview for a list of valid tags.

Parameters:

tags - The tags

Throws:

LogRuntimeException - If unable to add tags

addTags

public void addTags(String tags)
             throws LogRuntimeException

Add a comma-separated list of tags to the log entry. See the Overview for a list of valid tags.

Parameters:

tags - The tags

Throws:

LogRuntimeException - If unable to add tags

setTags

public void setTags(String[] tags)
             throws LogRuntimeException

Replace the existing tags with the specified array of tags. See the Overview for a list of valid tags.

Parameters:

tags - The tags

Throws:

LogRuntimeException - If unable to set tags

setTags

public void setTags(String tags)
             throws LogRuntimeException

Replace the existing tags with the specified comma-separated-values. See the Overview for a list of valid tags.

Parameters:

tags - The tags

Throws:

LogRuntimeException - If unable to set the tags

getTagsCSV

public String getTagsCSV()
                  throws LogRuntimeException

Return the tags as comma-separated-values.

Returns:

The tags

Throws:

LogRuntimeException - If unable to return the tags

getTags

public String[] getTags()
                 throws LogRuntimeException

Return the tags as an array.

Returns:

The tags

Throws:

LogRuntimeException - If unable to get the tags

addReference

public void addReference(Reference ref)
                  throws LogRuntimeException

Add a reference to this log entry. See the Overview for a list of valid reference types.

Parameters:

ref - The reference

Throws:

LogRuntimeException - If unable to add a reference

getReferences

public Reference[] getReferences()
                          throws LogRuntimeException

Return the references.

Returns:

The references

Throws:

LogRuntimeException - If unable to get the references

deleteReferences

public void deleteReferences()
                      throws LogRuntimeException

Remove the references from the log entry.

Throws:

LogRuntimeException - If unable to remove the references

setTitle

public void setTitle(String title)
              throws LogRuntimeException

Set the title to a new value.

Parameters:

title - The new title

Throws:

LogRuntimeException - If unable to set the title

getTitle

public String getTitle()
                throws LogRuntimeException

Return the title.

Returns:

The title

Throws:

LogRuntimeException - If unable to get the title

addEntryMakers

public void addEntryMakers(String[] entrymakers)
                    throws LogRuntimeException

Add an array of entry makers to the log entry.

Parameters:

entrymakers - The entry makers

Throws:

LogRuntimeException - If unable to add entry makers

addEntryMakers

public void addEntryMakers(String entrymakers)
                    throws LogRuntimeException

Add a comma-separated list of entry makers to the log entry.

Parameters:

entrymakers - The entry makers

Throws:

LogRuntimeException - If unable to add entry makers

setEntryMakers

public void setEntryMakers(String[] entrymakers)
                    throws LogRuntimeException

Replace the entry makers with the specified array.

Parameters:

entrymakers - the entry makers

Throws:

LogRuntimeException - If unable to set the entry makers

setEntryMakers

public void setEntryMakers(String entrymakers)
                    throws LogRuntimeException

Replace the entry makers with the specified comma-separated-values.

Parameters:

entrymakers - The entry makers

Throws:

LogRuntimeException - If unable to set the entry makers

getEntryMakersCSV

public String getEntryMakersCSV()
                         throws LogRuntimeException

Return the entry makers as comma-separated-values.

Returns:

The entry makers

Throws:

LogRuntimeException - If unable to get the entry makers

getEntryMakers

public String[] getEntryMakers()
                        throws LogRuntimeException

Return the entry makers as an array.

Returns:

The entry makers

Throws:

LogRuntimeException - If unable to get the entry makers

setSticky

public void setSticky(boolean sticky)
               throws LogRuntimeException

Set the sticky value of this log entry.

Parameters:

sticky - true if sticky, false if not

Throws:

LogRuntimeException - If unable to set the sticky value

isSticky

public boolean isSticky()
                 throws LogRuntimeException

Return true if sticky, false if not.

Returns:

true if sticky, false if not

Throws:

LogRuntimeException - If unable to get the sticky value

setBody

public void setBody(String content)

Set the body to the specified plain text content.

Parameters:

content - The content

Throws:

LogRuntimeException - If unable to set the body

setBody

public void setBody(String content,
 Body.ContentType type)

Set the body to the specified content and content type.

Parameters:

content - The content

type - the type

Throws:

LogRuntimeException - If unable to set the body

setBody

public void setBody(Body body)
             throws LogRuntimeException

Throws:

LogRuntimeException

main

public static void main(String[] args)
                 throws Exception

The entrypoint if this library is invoked as a command line application.

Parameters:

args - The command line arguments

Throws:

Exception - If something goes wrong

addAttachment

public void addAttachment(String filepath)
                   throws AttachmentSizeException,
LogIOException,
LogRuntimeException

Add a file attachment with an empty caption and a hastily guessed mime type. The mime type is guessed by using the readily available java.net.URLConnection file name map, which simply looks at file extension and compares with the very limited lookup file at:

[JRE_HOME]\lib\content-types.properties

Parameters:

filepath - The file path

Throws:

AttachmentSizeException - If the attachment crosses a size limit

LogIOException - If unable to add the attachment due to IO

LogRuntimeException - If unable to add the attachment

addAttachment

public void addAttachment(String filepath,
 String caption)
                   throws AttachmentSizeException,
LogIOException,
LogRuntimeException

Add a file attachment with the specified caption and a hastily guessed mime type. The mime type is guessed by using the readily available java.net.URLConnection file name map, which simply looks at file extension and compares with the very limited lookup file at:

[JRE_HOME]\lib\content-types.properties

Parameters:

filepath - The file path

caption - The caption

Throws:

AttachmentSizeException - If the attachment crosses a size limit

LogIOException - If unable to add the attachment due to IO

LogRuntimeException - If unable to add the attachment

addAttachment

public void addAttachment(String filepath,
 String caption,
 String mimeType)
                   throws AttachmentSizeException,
LogIOException,
LogRuntimeException

Add a file attachment with the specified caption and mime type.

Parameters:

filepath - The file path

caption - The caption

mimeType - The mime type

Throws:

AttachmentSizeException - If the attachment crosses a size limit

LogIOException - If unable to add the attachment due to IO

LogRuntimeException - If unable to add the attachment

getAttachments

public Attachment[] getAttachments()
                            throws LogRuntimeException

Return the file attachments.

Returns:

The attachments

Throws:

LogRuntimeException - If unable to return the attachments

deleteAttachments

public void deleteAttachments()
                       throws LogRuntimeException

Remove the file attachments.

Throws:

LogRuntimeException - If unable to remove the file attachments

setEmailNotify

public void setEmailNotify(String addresses)
                    throws LogRuntimeException

Set the comma-separated list of email addresses used for notification.

Parameters:

addresses - The email addresses

Throws:

LogRuntimeException - If unable to set the email addresses

setEmailNotify

public void setEmailNotify(String[] addresses)
                    throws LogRuntimeException

Set the array of email addresses used for notification.

Parameters:

addresses - The email addresses

Throws:

LogRuntimeException - If unable to set the email addresses

getEmailNotifyCSV

public String getEmailNotifyCSV()
                         throws LogRuntimeException

Return the comma-separated list of email addresses.

Returns:

The email addresses

Throws:

LogRuntimeException - If unable to get the email addresses

getEmailNotify

public String[] getEmailNotify()
                        throws LogRuntimeException

Return the array of email addresses.

Returns:

The email addresses

Throws:

LogRuntimeException - If unable to get the email addresses

getAuthor

public String getAuthor()
                 throws LogRuntimeException

Return the author username.

Returns:

The author username

Throws:

LogRuntimeException - If unable to get the author username

getLogNumber

public Long getLogNumber()
                  throws LogRuntimeException

Return the log number or null if none assigned.

Returns:

The log number or null

Throws:

LogRuntimeException - If unable to get the log number

getCreated

public GregorianCalendar getCreated()
                             throws LogRuntimeException

Return the created date/time.

Returns:

The created date/time

Throws:

LogRuntimeException - If unable to get the created date/time

getBody

public Body getBody()
             throws LogRuntimeException

Return the body.

Returns:

The body

Throws:

LogRuntimeException - If unable to get the body

getXML

public String getXML()
              throws LogRuntimeException

Return the XML.

Returns:

The XML

Throws:

LogRuntimeException - If unable to get the XML

getClientCertificatePath

public String getClientCertificatePath()

Get the path to the PEM-encoded client certificate.

Returns:

certificatePath The path to the PEM-encoded client certificate

setClientCertificatePath

public void setClientCertificatePath(String certificatePath,
 boolean updateAuthor)
                              throws LogException

Set the path to the PEM-encoded client certificate.

Parameters:

certificatePath - The path to the PEM-encoded client certificate

updateAuthor - If true, the author field is updated to match username in certificate

Throws:

LogException - If unable to set the certificate path

submit

public long submit()
            throws InvalidXMLException,
LogIOException

Submit the log item using the queue mechanism as a fallback and return the log number. If the log number is zero then the submission was queued instead of being consumed directly by the server.

Returns:

The log number, zero means queued

Throws:

InvalidXMLException - If unable to submit due to invalid XML

LogIOException - If unable to submit due to IO

submitNow

public long submitNow()
               throws LogIOException,
LogCertificateException,
LogRuntimeException

Submit the log item using only direct submission to the server using the client certificate named .elogcert in the user's home directory and return the log number. If an error occurs during submission then an Exception will be thrown instead of falling back to the queue method.

Returns:

The log number

Throws:

LogIOException - If unable to submit due to IO

LogCertificateException - If unable to submit due to certificate

LogRuntimeException - If unable to submit

whyQueued

public LogException whyQueued()

Return the LogException which prevented direct submission to the server on the most recent attempt, or null if none. This method allows access to the exception which is masked when the submit method is called and returns with a zero value indicating the submission was queued.

Returns:

The LogException or null