Package xal.plugin.jelog

Class ElogProvider

java.lang.Object

xal.extension.logbook.LogbookProvider

xal.plugin.jelog.ElogProvider

@ServiceProvider(service=LogbookProvider.class,
                 order=20)
public class ElogProvider
extends LogbookProvider

Author:

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

Constructor Summary

Constructors

Constructor	Description
ElogProvider()

Method Summary

Modifier and Type	Method	Description
boolean	login(String username, char[] password)
void	logout()
long	post(String[] defaultLogbooks, Map<String,List<String>> defaultAttributes)
long	post(String[] logbooks, Map<String,List<String>> fields, String textBody)
long	post(String[] logbooks, Map<String,List<String>> fields, String textBody, List<Attachment> attachments)
long	post(List<Attachment> attachments, String[] defaultLogbooks, Map<String,List<String>> defaultAttributes)
long	post(List<Attachment> attachments, Map<String,List<String>> defaultAttributes)
long	post(Map<String,List<String>> defaultAttributes)
void	setServer(String server)

Methods inherited from class xal.extension.logbook.LogbookProvider

getDefaultLogbook, getDefaultServerUrl, getServer, setDefaultLogbook, setDefaultServerUrl

Methods inherited from class java.lang.Object

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

Constructor Details

ElogProvider

public ElogProvider()

Method Details

setServer

public void setServer(String server)

Overrides:

setServer in class LogbookProvider

login

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

Specified by:

login in class LogbookProvider

logout

public void logout()

Specified by:

logout in class LogbookProvider

post

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

Specified by:

post in class LogbookProvider

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 long post(String[] logbooks,
 Map<String,List<String>> fields,
 String textBody,
 List<Attachment> attachments)
          throws LogbookException

Specified by:

post in class LogbookProvider

Throws:

LogbookException

post

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

Specified by:

post in class LogbookProvider

Throws:

LogbookException

post

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

Specified by:

post in class LogbookProvider

Throws:

LogbookException

post

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

Specified by:

post in class LogbookProvider

Throws:

LogbookException

post

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

Specified by:

post in class LogbookProvider

Throws:

LogbookException