Package xal.extension.logbook

Class LogbookProvider

java.lang.Object

xal.extension.logbook.LogbookProvider

Direct Known Subclasses:

ElogProvider, OlogProvider

public abstract class LogbookProvider
extends Object

Abstract class that defines a logbook service provider.

Author:

Juan F. Esteban Müller <JuanF.EstebanMuller@ess.eu>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LogbookProvider()

Method Summary

Modifier and Type	Method	Description
String	getDefaultLogbook()
final String	getDefaultServerUrl()
String	getServer()
abstract boolean	login(String username, char[] password)
abstract void	logout()
abstract long	post(String[] defaultLogbooks, Map<String,List<String>> defaultAttributes)
abstract long	post(String[] logbooks, Map<String,List<String>> fields, String textBody)
abstract long	post(String[] logbooks, Map<String,List<String>> fields, String textBody, List<Attachment> attachments)
abstract long	post(List<Attachment> attachments, String[] defaultLogbooks, Map<String,List<String>> defaultAttributes)
abstract long	post(List<Attachment> attachments, Map<String,List<String>> defaultAttributes)
abstract long	post(Map<String,List<String>> defaultAttributes)
void	setDefaultLogbook(String logbook)
final void	setDefaultServerUrl(String serverUrl)
void	setServer(String server)

Methods inherited from class java.lang.Object

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

Constructor Details

LogbookProvider

protected LogbookProvider()

Method Details

getServer

public String getServer()

setServer

public void setServer(String server)

getDefaultLogbook

public String getDefaultLogbook()

Returns:

the name of the default logbook

setDefaultLogbook

public void setDefaultLogbook(String logbook)

getDefaultServerUrl

public final String getDefaultServerUrl()

setDefaultServerUrl

public final void setDefaultServerUrl(String serverUrl)

login

public abstract boolean login(String username,
 char[] password)

logout

public abstract void logout()

post

public abstract long post(String[] logbooks,
 Map<String,List<String>> fields,
 String textBody)
                   throws LogbookException

Parameters:

logbook - Name of the logbooks where the entry should be posted

fields - map containing metadata as pair of name of the attribute and value

textBody - entry body text

Returns:

the message ID

Throws:

LogbookException

post

public abstract long post(String[] logbooks,
 Map<String,List<String>> fields,
 String textBody,
 List<Attachment> attachments)
                   throws LogbookException

Throws:

LogbookException

post

public abstract long post(Map<String,List<String>> defaultAttributes)
                   throws LogbookException

Throws:

LogbookException

post

public abstract long post(String[] defaultLogbooks,
 Map<String,List<String>> defaultAttributes)
                   throws LogbookException

Throws:

LogbookException

post

public abstract long post(List<Attachment> attachments,
 Map<String,List<String>> defaultAttributes)
                   throws LogbookException

Throws:

LogbookException

post

public abstract long post(List<Attachment> attachments,
 String[] defaultLogbooks,
 Map<String,List<String>> defaultAttributes)
                   throws LogbookException

Throws:

LogbookException