Package xal.plugin.olog

Class OlogProvider

java.lang.Object

xal.extension.logbook.LogbookProvider

xal.plugin.olog.OlogProvider

@ServiceProvider(service=LogbookProvider.class,
                 order=10)
public class OlogProvider
extends LogbookProvider

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENTRY_TYPE_STR
static final String	PROPERTIES_STR
static final String	SUBJECT_STR
static final String	TAGS_STR

Constructor Summary

Constructors

Constructor	Description
OlogProvider()

Method Summary

Modifier and Type	Method	Description
static String	getJsonAttributes(String nameMap, Map<String,String> attributesMap)	Utility class to transform a Map with an Olog property into a Json string.
boolean	login(String username, char[] password)
void	logout()
protected static javafx.util.Pair	parseProperty(String property)
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)

Methods inherited from class xal.extension.logbook.LogbookProvider

getDefaultLogbook, getDefaultServerUrl, getServer, setDefaultLogbook, setDefaultServerUrl, setServer

Methods inherited from class java.lang.Object

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

Field Details

ENTRY_TYPE_STR

public static final String ENTRY_TYPE_STR

See Also:

• Constant Field Values

TAGS_STR

public static final String TAGS_STR

See Also:

• Constant Field Values

SUBJECT_STR

public static final String SUBJECT_STR

See Also:

• Constant Field Values

PROPERTIES_STR

public static final String PROPERTIES_STR

See Also:

• Constant Field Values

Constructor Details

OlogProvider

public OlogProvider()

Method Details

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

Parameters:

logbooks - Array with a list of logbooks where the entry should be posted.

fields - Olog allows for the following attributes: Entry Type, Tags, Subject, and Properties. From those, Entry Type and Subject are required, the others are optional.

textBody - Message body test.

attachments -

Returns:

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

parseProperty

protected static javafx.util.Pair parseProperty(String property)

getJsonAttributes

public static String getJsonAttributes(String nameMap,
 Map<String,String> attributesMap)

Utility class to transform a Map with an Olog property into a Json string.

Parameters:

nameMap -

attributesMap -

Returns: