org.lsst.ccs.elog

Class ELogConnection

java.lang.Object

org.lsst.ccs.elog.ELogConnection

All Implemented Interfaces:

Closeable, AutoCloseable

public class ELogConnection
extends Object
implements Closeable

A connection to an instance of an eLog. Methods on this class allow operations to be performed on the eLog.

Author:

tonyj

Constructor Summary

Constructors

Constructor and Description
ELogConnection(String baseURL) Create a new electronic logbook connection.
ELogConnection(URI baseURI) Create a new electronic logbook connection.

Method Summary

Modifier and Type	Method and Description
void	close()
List<String>	getCategories() Get the list of categories available for this log book
List<String>	getTags() Get the list of tags available for this log book.
ElogTransactionResult	postEntryToElog(ElogEntry entry) Post an entry to the log book.
List<ElogEntrySummary>	search(String query) Get the list of entries matching a query for this log book

Methods inherited from class java.lang.Object

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

Constructor Detail

ELogConnection

public ELogConnection(String baseURL)
               throws URISyntaxException

Create a new electronic logbook connection.

Parameters:

baseURL - The base URL for the logbook, e.g. "http://dbweb0.fnal.gov/ECL/lsst_camera"

Throws:

URISyntaxException - If the baseURL is invalid

ELogConnection

public ELogConnection(URI baseURI)

Create a new electronic logbook connection.

Parameters:

baseURI - The URI for the logbook.

Method Detail

getCategories

public List<String> getCategories()
                           throws IOException

Get the list of categories available for this log book

Returns:

A list of the available categories.

Throws:

IOException - if an error occurs, or the method returns a status other than 200 (OK)

getTags

public List<String> getTags()
                     throws IOException

Get the list of tags available for this log book.

Returns:

A list of the available tags.

Throws:

IOException - if an error occurs, or the method returns a status other than 200 (OK)

postEntryToElog

public ElogTransactionResult postEntryToElog(ElogEntry entry)
                                      throws IOException

Post an entry to the log book.

Parameters:

entry - The entry to post

Returns:

A result containing both the HTTP status code, and the text returned from the post.

Throws:

IOException - If an error occurs

search

public List<ElogEntrySummary> search(String query)
                              throws IOException

Get the list of entries matching a query for this log book

Parameters:

query - The query. Caller is responsible for knowing the language.

Returns:

A list of entry summaries.

Throws:

IOException - if an error occurs, or the method returns a status other than 200 (OK)

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException