xal.extension.logbook

Class ElogUtility

java.lang.Object

xal.extension.logbook.ElogUtility

public class ElogUtility
extends java.lang.Object

ElogUtility provides convenience methods for interacting with the Elog database.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,xal.extension.logbook.BinaryType>	_binaryTypes Map of binary types keyed by extension
protected ConnectionDictionary	_connectionDictionary connection dictionary
protected DatabaseAdaptor	_databaseAdaptor database adaptor
static java.lang.String	CONTROLS_LOGBOOK Controls logbook name
static int	DEFAULT_MAX_BODY_SIZE Default maximum allowed size of the main body text
static int	DEFAULT_MAX_TITLE_SIZE Default maximum allowed size of the title size
static java.lang.String	OPERATIONS_LOGBOOK Operations logbook name

Constructor Summary

Constructors

Constructor and Description
ElogUtility(ConnectionDictionary dictionary) ElogUtility constructor Uses the default database adaptor.

Method Summary

Modifier and Type	Method and Description
static ElogUtility	defaultUtility() Get the default elog utility which uses the default connection dictionary and the default database adaptor.
java.util.Map<java.lang.String,xal.extension.logbook.BinaryType>	getBinaryTypes() Get the binary types.
int	getMaxBodySize() get the maximum allowed size of the main body text
static ConnectionDictionary	newConnectionDictionary() generate a new connection dictionary appropriate for publishing new logbook entries
void	postEntry(java.lang.String logbook, java.lang.String title, java.lang.String content) Post an entry to a logbook using the account of the user logged in.
void	postEntry(java.lang.String logbook, java.lang.String title, java.lang.String content, java.lang.String dataName, java.lang.String formatName, byte[] data) Post an entry to a logbook using the account of the user logged in.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_BODY_SIZE

public static final int DEFAULT_MAX_BODY_SIZE

Default maximum allowed size of the main body text

See Also:

Constant Field Values

DEFAULT_MAX_TITLE_SIZE

public static final int DEFAULT_MAX_TITLE_SIZE

Default maximum allowed size of the title size

See Also:

Constant Field Values

CONTROLS_LOGBOOK

public static final java.lang.String CONTROLS_LOGBOOK

Controls logbook name

See Also:

Constant Field Values

OPERATIONS_LOGBOOK

public static final java.lang.String OPERATIONS_LOGBOOK

Operations logbook name

See Also:

Constant Field Values

_connectionDictionary

protected final ConnectionDictionary _connectionDictionary

connection dictionary

_databaseAdaptor

protected final DatabaseAdaptor _databaseAdaptor

database adaptor

_binaryTypes

protected java.util.Map<java.lang.String,xal.extension.logbook.BinaryType> _binaryTypes

Map of binary types keyed by extension

Constructor Detail

ElogUtility

public ElogUtility(ConnectionDictionary dictionary)
            throws DatabaseException

ElogUtility constructor Uses the default database adaptor.

Parameters:

dictionary - The connection dictionary.

Throws:

gov.sns.tools.database.DatabaseException - if an exception occurs while connecting to the database

DatabaseException

Method Detail

defaultUtility

public static ElogUtility defaultUtility()
                                  throws DatabaseException

Get the default elog utility which uses the default connection dictionary and the default database adaptor.

Returns:

The elog utility if the default connection dictionary exists and null if the connection dictionary cannot be found

Throws:

gov.sns.tools.database.DatabaseException - if an exception occurs while connecting to the database

DatabaseException

newConnectionDictionary

public static ConnectionDictionary newConnectionDictionary()

generate a new connection dictionary appropriate for publishing new logbook entries

getMaxBodySize

public int getMaxBodySize()

get the maximum allowed size of the main body text

postEntry

public void postEntry(java.lang.String logbook,
                      java.lang.String title,
                      java.lang.String content)
               throws DatabaseException

Post an entry to a logbook using the account of the user logged in.

Parameters:

logbook - The name of the logbook to which we are posting the entry

title - The title of the entry to post

content - The content of the entry to post

Throws:

gov.sns.tools.database.DatabaseException - if a database exception occurs while posting an entry

DatabaseException

postEntry

public void postEntry(java.lang.String logbook,
                      java.lang.String title,
                      java.lang.String content,
                      java.lang.String dataName,
                      java.lang.String formatName,
                      byte[] data)
               throws DatabaseException

Post an entry to a logbook using the account of the user logged in.

Parameters:

logbook - The name of the logbook to which we are posting the entry

title - The title of the entry to post

content - The content of the entry to post

dataName - The name of the associatiated image or attachment data.

formatName - The format of the image or attachment data to associate with this entry (e.g. "jpg", "pdf", "txt").

data - The image or attachment data to associate with the entry.

Throws:

gov.sns.tools.database.DatabaseException - if a database exception occurs while posting an entry

DatabaseException

getBinaryTypes

public java.util.Map<java.lang.String,xal.extension.logbook.BinaryType> getBinaryTypes()

Get the binary types.