Index (jlog 5.1.0 API)

A B C D E F G H I L M O P R S T V W X
All Classes and Interfaces|All Packages|Serialized Form

A

addAttachment(String) - Method in class org.jlab.jlog.Comment: Add a file attachment with an empty caption and a hastily guessed mime type.
addAttachment(String, String) - Method in class org.jlab.jlog.Comment: Add a file attachment with the specified caption and a hastily guessed mime type.
addAttachment(String, String, String) - Method in class org.jlab.jlog.Comment: Add a file attachment with the specified caption and mime type.
addComment(Comment) - Method in class org.jlab.jlog.LogEntryAdminExtension: Add a Comment to this LogEntry.
addEntryMakers(String) - Method in class org.jlab.jlog.LogEntry: Add a comma-separated list of entry makers to the log entry.
addEntryMakers(String[]) - Method in class org.jlab.jlog.LogEntry: Add an array of entry makers to the log entry.
addLogboks(String[]) - Method in class org.jlab.jlog.LogEntry: Add an array of log books to this log entry.
addLogbooks(String) - Method in class org.jlab.jlog.LogEntry: Add a comma-separated list of log books to this log entry.
addReference(Reference) - Method in class org.jlab.jlog.LogEntry: Add a reference to this log entry.
addTags(String) - Method in class org.jlab.jlog.LogEntry: Add a comma-separated list of tags to the log entry.
addTags(String[]) - Method in class org.jlab.jlog.LogEntry: Add an array of tags to the log entry.
appendCommaDelimitedElementsWithGrandchildAndText(Document, Element, String, String, String) - Static method in class org.jlab.jlog.util.XMLUtil: Creates a new element with child and grandchild with text from a comma separated list of values and appends them to the specified parent.
appendCommaDelimitedElementsWithText(Document, Element, String, String) - Static method in class org.jlab.jlog.util.XMLUtil: Creates a new element with child text for a comma separated list of values and appends them to the specified parent.
appendElementWithText(Document, Element, String, String) - Static method in class org.jlab.jlog.util.XMLUtil: Create a new element with child text node and append it to the specified parent.
arrayToCSV(String[]) - Static method in class org.jlab.jlog.util.IOUtil: Converts an array of String values to a comma-separated-values String.
Attachment - Class in org.jlab.jlog: A file attachment.
AttachmentSizeException - Exception in org.jlab.jlog.exception: Indicates that an Attachment is too large or that the total size of all attachments is too large.
AttachmentSizeException(String) - Constructor for exception org.jlab.jlog.exception.AttachmentSizeException: Create a new AttachmentSizeException with message.
AttachmentSizeException(String, Throwable) - Constructor for exception org.jlab.jlog.exception.AttachmentSizeException: Create a new AttachementSizeException with message and cause.

B

Body - Class in org.jlab.jlog: The body of a log book item, such as log entry or comment.
Body(Body.ContentType, String) - Constructor for class org.jlab.jlog.Body: Construct a new Body with the specified type and content.
Body.ContentType - Enum in org.jlab.jlog: The content type enumeration.
buildArrayFromText(NodeList) - Static method in class org.jlab.jlog.util.XMLUtil: Builds an array of String text values from a NodeList of Elements with Text children.
buildCommaDelimitedFromText(NodeList) - Static method in class org.jlab.jlog.util.XMLUtil: Builds a comma separated list of text values from a NodeList of Elements with Text children.

C

checkClientTrusted(X509Certificate[], String) - Method in class org.jlab.jlog.util.SecurityUtil.TrustyTrustManager
checkServerTrusted(X509Certificate[], String) - Method in class org.jlab.jlog.util.SecurityUtil.TrustyTrustManager
closeQuietly(Closeable) - Static method in class org.jlab.jlog.util.IOUtil: Closes a Closeable without generating any checked Exceptions.
Comment - Class in org.jlab.jlog: An electronic log book comment.
Comment(long, String) - Constructor for class org.jlab.jlog.Comment: Construct a new Comment with the specified log number and content of type plain text.
Comment(long, String, Body.ContentType) - Constructor for class org.jlab.jlog.Comment: Construct a new Comment with the specified log number, content, and content type.
Comment(long, Body) - Constructor for class org.jlab.jlog.Comment: Construct a new Comment with the specified log number and Body.
CommentAdminExtension - Class in org.jlab.jlog: Wraps a Comment to provide administrative capabilities.
CommentAdminExtension(Comment) - Constructor for class org.jlab.jlog.CommentAdminExtension: Construct a new CommentAdminExtension for the specified Comment.
copy(InputStream, OutputStream) - Static method in class org.jlab.jlog.util.IOUtil: Copies all of the bytes from the InputStream into the OutputStream using a buffer of 4096 bytes.
csvToArray(String) - Static method in class org.jlab.jlog.util.IOUtil: Converts a comma-separated-values String to an array of String values.

D

decodeBase64(String) - Static method in class org.jlab.jlog.util.IOUtil: Decodes a base64 String to an array of bytes.
deleteAttachments() - Method in class org.jlab.jlog.Comment: Remove the file attachments.
deleteQuietly(File) - Static method in class org.jlab.jlog.util.IOUtil: Deletes a file without generating any checked Exceptions.
deleteReferences() - Method in class org.jlab.jlog.LogEntry: Remove the references from the log entry.
disableServerCertificateCheck() - Static method in class org.jlab.jlog.util.SecurityUtil: Disables the server certificate check performed when using the default SSLSocketFactory.

E

enableServerCertificateCheck() - Static method in class org.jlab.jlog.util.SecurityUtil: Re-enables the server certificate check performed when using the default SSLSocketFactory, if it was previously disabled.
encodeBase64(byte[]) - Static method in class org.jlab.jlog.util.IOUtil: Encodes an array of bytes to base64.

F

fetchCertificateFromPEM(byte[]) - Static method in class org.jlab.jlog.util.SecurityUtil: Get an X509Certificate from PEM bytes.
fetchPrivateKeyFromPEM(byte[]) - Static method in class org.jlab.jlog.util.SecurityUtil: Get an RSAPublicKey from PEM bytes.
fileToBytes(File) - Static method in class org.jlab.jlog.util.IOUtil: Fully reads in a file and returns an array of the bytes representing the file.

G

generateRSAPrivateKeyFromDER(byte[]) - Static method in class org.jlab.jlog.util.SecurityUtil: Generates an RSAPrivateKey from an array of DER encoded bytes.
generateX509CertificateFromDER(byte[]) - Static method in class org.jlab.jlog.util.SecurityUtil: Generates an X509Certificate from an array of DER encoded bytes.
getAcceptedIssuers() - Method in class org.jlab.jlog.util.SecurityUtil.TrustyTrustManager
getAttachments() - Method in class org.jlab.jlog.Comment: Return the file attachments.
getAuthor() - Method in class org.jlab.jlog.Comment: Return the author username.
getBody() - Method in class org.jlab.jlog.Comment: Return the body.
getCaption() - Method in class org.jlab.jlog.Attachment: Return the attachment caption.
getChildElementByName(Node, String) - Static method in class org.jlab.jlog.util.XMLUtil: Returns the first occurrence of a child element with the specified tag name.
getClientCertificatePath() - Method in class org.jlab.jlog.Comment: Get the path to the PEM-encoded client certificate.
getClientCertSocketFactoryPEM(String, boolean) - Static method in class org.jlab.jlog.util.SecurityUtil: Obtain a SSLSocketFactory that provides a client certificate from a PEM file and optionally verifies the server's certificate.
getCommonNameFromCertificate(X509Certificate) - Static method in class org.jlab.jlog.util.SecurityUtil: Get the CN from the subject DN on an X509Certificate
getComponentId() - Method in class org.jlab.jlog.ProblemReport: Return the component ID or null if none.
getConfiguration() - Static method in class org.jlab.jlog.Library: Get the configuration properties.
getContent() - Method in class org.jlab.jlog.Body: Return the content.
getContext(String, boolean) - Static method in class org.jlab.jlog.util.SecurityUtil: Get SSLContext
getCreated() - Method in class org.jlab.jlog.Comment: Return the created date/time.
getData() - Method in class org.jlab.jlog.Attachment: Return the attachment data via an InputStream.
getEmailNotify() - Method in class org.jlab.jlog.Comment: Return the array of email addresses.
getEmailNotifyCSV() - Method in class org.jlab.jlog.Comment: Return the comma-separated list of email addresses.
getEntryMakers() - Method in class org.jlab.jlog.LogEntry: Return the entry makers as an array.
getEntryMakersCSV() - Method in class org.jlab.jlog.LogEntry: Return the entry makers as comma-separated-values.
getFileName() - Method in class org.jlab.jlog.Attachment: Return the attachment file name.
getGroupId() - Method in class org.jlab.jlog.ProblemReport: Return the group ID.
getHostname() - Static method in class org.jlab.jlog.util.SystemUtil: Attempt to obtain the hostname of machine this JVM is running on.
getId() - Method in class org.jlab.jlog.Reference: Return the reference ID.
getJVMProcessId() - Static method in class org.jlab.jlog.util.SystemUtil: Attempt to obtain the process ID of the running JVM.
getLogbooks() - Method in class org.jlab.jlog.LogEntry: Return the log books as an array.
getLogbooksCSV() - Method in class org.jlab.jlog.LogEntry: Return the log books as comma-separated-values.
getLogEntry(long, String) - Static method in class org.jlab.jlog.LogEntry: Factory method to obtain an existing LogEntry for viewing or revising.
getLogNumber() - Method in class org.jlab.jlog.Comment: Return the log number or null if none assigned.
getMimeType() - Method in class org.jlab.jlog.Attachment: Return the attachment mime type.
getProblemReport() - Method in class org.jlab.jlog.LogEntry: Get the problem report information.
getReferences() - Method in class org.jlab.jlog.LogEntry: Return the references.
getReleaseDate() - Static method in class org.jlab.jlog.Library: The date in which this version of the library was released.
getSocketFactoryJKS(String) - Static method in class org.jlab.jlog.util.SecurityUtil: Obtain a SSLSocketFactory that provides a client certificate from a JKS file.
getSocketFactoryPKCS12(String) - Static method in class org.jlab.jlog.util.SecurityUtil: Obtain a SSLSocketFactory that provides a client certificate from a PKCS12 file.
getSystemId() - Method in class org.jlab.jlog.ProblemReport: Return the system ID.
getTags() - Method in class org.jlab.jlog.LogEntry: Return the tags as an array.
getTagsCSV() - Method in class org.jlab.jlog.LogEntry: Return the tags as comma-separated-values.
getTitle() - Method in class org.jlab.jlog.LogEntry: Return the title.
getTrustySocketFactory() - Static method in class org.jlab.jlog.util.SecurityUtil: Obtains a custom SSLSocketFactory which trusts every certificate regardless of attributes.
getType() - Method in class org.jlab.jlog.Body: Return the content type.
getType() - Method in class org.jlab.jlog.ProblemReport: Return the problem report type.
getType() - Method in class org.jlab.jlog.Reference: Return the reference type.
getURL() - Method in class org.jlab.jlog.Attachment: Return the attachment URL or null if unavailable.
getVersion() - Static method in class org.jlab.jlog.Library: Returns the library version String.
getXML() - Method in class org.jlab.jlog.Comment: Return the XML.
getXML(Document) - Static method in class org.jlab.jlog.util.XMLUtil: Convert a Document (DOM) into an XML String.

H

HLA - Enum constant in enum org.jlab.jlog.ProblemReportType: Hall A
HLB - Enum constant in enum org.jlab.jlog.ProblemReportType: Hall B
HLC - Enum constant in enum org.jlab.jlog.ProblemReportType: Hall C
HLD - Enum constant in enum org.jlab.jlog.ProblemReportType: Hall D
HTML - Enum constant in enum org.jlab.jlog.Body.ContentType: HTML Body

I

InvalidXMLException - Exception in org.jlab.jlog.exception: Indicates that XML is invalid.
InvalidXMLException(String) - Constructor for exception org.jlab.jlog.exception.InvalidXMLException: Create a new InvalidXMLException with message.
InvalidXMLException(String, Throwable) - Constructor for exception org.jlab.jlog.exception.InvalidXMLException: Create a new InvalidXMLException with message and cause.
IOUtil - Class in org.jlab.jlog.util: IO Utilities.
isNeedsAttention() - Method in class org.jlab.jlog.ProblemReport: Return true if the problem report needs attention, false if it has been resolved.
isSticky() - Method in class org.jlab.jlog.LogEntry: Return true if sticky, false if not.
isURL() - Method in class org.jlab.jlog.Attachment: Return true if the attachment is accessed via URL or false if local only (has not been submitted yet).
isWindows() - Static method in class org.jlab.jlog.util.SystemUtil: Make a guess as to whether the JVM is running on Windows.

L

Library - Class in org.jlab.jlog: Captures the jlog library global version and configuration information.
LogCertificateException - Exception in org.jlab.jlog.exception: Indicates a problem with either the client or server PKI certificate.
LogCertificateException(String) - Constructor for exception org.jlab.jlog.exception.LogCertificateException: Create a new LogCertificateException with message.
LogCertificateException(String, Throwable) - Constructor for exception org.jlab.jlog.exception.LogCertificateException: Create a new LogCertificateException with message and cause.
LogEntry - Class in org.jlab.jlog: An electronic log book log entry.
LogEntry(String) - Constructor for class org.jlab.jlog.LogEntry: Construct a new LogEntry from the specified XML file.
LogEntry(String, String) - Constructor for class org.jlab.jlog.LogEntry: Construct a new LogEntry with the specified title and log books designation.
LogEntryAdminExtension - Class in org.jlab.jlog: Wraps a LogEntry to provide administrative capabilities.
LogEntryAdminExtension(LogEntry) - Constructor for class org.jlab.jlog.LogEntryAdminExtension: Construct a new LogEntryAdminExtension with the specified LogEntry.
LogException - Exception in org.jlab.jlog.exception: Top-level checked exception for the ELog client API that indicates a condition that a reasonable application might want to catch.
LogException(String) - Constructor for exception org.jlab.jlog.exception.LogException: Create a new LogException with a message.
LogException(String, Throwable) - Constructor for exception org.jlab.jlog.exception.LogException: Create a new LogException with a message and cause.
LogIOException - Exception in org.jlab.jlog.exception: Indicates an exception occurred during IO.
LogIOException(String) - Constructor for exception org.jlab.jlog.exception.LogIOException: Create a new LogIOException with a message.
LogIOException(String, Throwable) - Constructor for exception org.jlab.jlog.exception.LogIOException: Create a new LogIOException with a message and cause.
LogRuntimeException - Exception in org.jlab.jlog.exception: Top-level unchecked exception for the ELog client API that indicates a problem outside the control of the API user such as a bug in the client API implementation.
LogRuntimeException(String) - Constructor for exception org.jlab.jlog.exception.LogRuntimeException: Create a new LogRuntimeException with a message.
LogRuntimeException(String, Throwable) - Constructor for exception org.jlab.jlog.exception.LogRuntimeException: Create a new LogRuntimeException with a message and cause.

M

main(String[]) - Static method in class org.jlab.jlog.LogEntry: The entrypoint if this library is invoked as a command line application.
MalformedXMLException - Exception in org.jlab.jlog.exception: Indicates that XML is not well-formed.
MalformedXMLException(String) - Constructor for exception org.jlab.jlog.exception.MalformedXMLException: Create a new MalformedXMLException with a message.
MalformedXMLException(String, Throwable) - Constructor for exception org.jlab.jlog.exception.MalformedXMLException: Create a new MalformedXMLException with a message and cause.

O

OPS - Enum constant in enum org.jlab.jlog.ProblemReportType: Operations
org.jlab.jlog - package org.jlab.jlog: Provides the classes needed to make an electronic log book entry, comment, or revision.
org.jlab.jlog.exception - package org.jlab.jlog.exception: Provides the exception classes for an electronic log book client.
org.jlab.jlog.util - package org.jlab.jlog.util: Provides the utility classes for an electronic log book client.

P

parseDERFromPEM(byte[], String, String) - Static method in class org.jlab.jlog.util.SecurityUtil: Parse PEM encoded bytes between type delimiters and return the DER encoded bytes.
ProblemReport - Class in org.jlab.jlog: An immutable problem report associated with a log entry.
ProblemReport(ProblemReportType, boolean, int, int, Integer) - Constructor for class org.jlab.jlog.ProblemReport: Create a new Problem Report with the specified values.
ProblemReportType - Enum in org.jlab.jlog: An enumeration of problem report types.

R

Reference - Class in org.jlab.jlog: A document reference for use in an electronic log book.
Reference(String, String) - Constructor for class org.jlab.jlog.Reference: Construct a new Reference with the specified type and id.
removeChildren(Element) - Static method in class org.jlab.jlog.util.XMLUtil: Removes all children from a parent Element.

S

SchemaUnavailableException - Exception in org.jlab.jlog.exception: Indicates that the schema is not available.
SchemaUnavailableException(String) - Constructor for exception org.jlab.jlog.exception.SchemaUnavailableException: Create a new SchemaUnavailableException with a message.
SchemaUnavailableException(String, Throwable) - Constructor for exception org.jlab.jlog.exception.SchemaUnavailableException: Create a new SchemaUnavailableException with a message and cause.
SecurityUtil - Class in org.jlab.jlog.util: Security Utilities.
SecurityUtil.TrustyTrustManager - Class in org.jlab.jlog.util: A X509TrustManager which trusts every certificate regardless of attributes.
setAuthor(String) - Method in class org.jlab.jlog.CommentAdminExtension: Set the author username.
setBody(String) - Method in class org.jlab.jlog.LogEntry: Set the body to the specified plain text content.
setBody(String, Body.ContentType) - Method in class org.jlab.jlog.LogEntry: Set the body to the specified content and content type.
setBody(Body) - Method in class org.jlab.jlog.LogEntry
setClientCertificatePath(String, boolean) - Method in class org.jlab.jlog.Comment: Set the path to the PEM-encoded client certificate.
setConfiguration(Properties) - Static method in class org.jlab.jlog.Library: Set the configuration properties.
setCreated(GregorianCalendar) - Method in class org.jlab.jlog.CommentAdminExtension: Set the created date/time.
setEmailNotify(String) - Method in class org.jlab.jlog.Comment: Set the comma-separated list of email addresses used for notification.
setEmailNotify(String[]) - Method in class org.jlab.jlog.Comment: Set the array of email addresses used for notification.
setEntryMakers(String) - Method in class org.jlab.jlog.LogEntry: Replace the entry makers with the specified comma-separated-values.
setEntryMakers(String[]) - Method in class org.jlab.jlog.LogEntry: Replace the entry makers with the specified array.
setLogbooks(String) - Method in class org.jlab.jlog.LogEntry: Replace the existing log books with the specified comma-separated-values.
setLogbooks(String[]) - Method in class org.jlab.jlog.LogEntry: Replace the existing log books with the specified array.
setLogNumber(long) - Method in class org.jlab.jlog.CommentAdminExtension: Set the log number.
setProblemReport(ProblemReport) - Method in class org.jlab.jlog.LogEntry: Set the problem report information.
setServer(String) - Static method in class org.jlab.jlog.Library: Set the logbook server.
setSticky(boolean) - Method in class org.jlab.jlog.LogEntry: Set the sticky value of this log entry.
setTags(String) - Method in class org.jlab.jlog.LogEntry: Replace the existing tags with the specified comma-separated-values.
setTags(String[]) - Method in class org.jlab.jlog.LogEntry: Replace the existing tags with the specified array of tags.
setTitle(String) - Method in class org.jlab.jlog.LogEntry: Set the title to a new value.
streamToString(InputStream, String) - Static method in class org.jlab.jlog.util.IOUtil: Reads in an InputStream fully and returns the result as a String.
submit() - Method in class org.jlab.jlog.Comment: Submit the log item using the queue mechanism as a fallback and return the log number.
submitNow() - Method in class org.jlab.jlog.Comment: 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.
SystemUtil - Class in org.jlab.jlog.util: System Utilities.

T

TEXT - Enum constant in enum org.jlab.jlog.Body.ContentType: Plain Text Body
toGregorianCalendar(String) - Static method in class org.jlab.jlog.util.XMLUtil: Generates a calendar from an XML DateTime String.
toString() - Method in class org.jlab.jlog.Body: Returns a String representation.
toXMLFormat(GregorianCalendar) - Static method in class org.jlab.jlog.util.XMLUtil: Generates a formated DateTime String appropriate for insertion into an XML document.
TrustyTrustManager() - Constructor for class org.jlab.jlog.util.SecurityUtil.TrustyTrustManager

V

valueOf(String) - Static method in enum org.jlab.jlog.Body.ContentType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jlab.jlog.ProblemReportType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jlab.jlog.Body.ContentType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jlab.jlog.ProblemReportType: Returns an array containing the constants of this enum type, in the order they are declared.

W

whyQueued() - Method in class org.jlab.jlog.Comment: Return the LogException which prevented direct submission to the server on the most recent attempt, or null if none.

X

XMLUtil - Class in org.jlab.jlog.util: XML Utilities.

A B C D E F G H I L M O P R S T V W X
All Classes and Interfaces|All Packages|Serialized Form