edu.msu.nscl.olog

Class OlogImpl

java.lang.Object

edu.msu.nscl.olog.OlogImpl

public class OlogImpl
extends Object

Central business logic layer that implements all directory operations.

Author:

Eric Berryman taken from Ralph Lange

Method Summary

Methods

Modifier and Type	Method and Description
Logbook	addSingleLogbook(String logbookName, Long logId) Add the logbook identified by logbook to the single log id.
Tag	addSingleTag(String tagName, Long logId) Add the tag identified by tag to the single log logId.
void	checkIdMatchesPayload(Long logId, Log data) Check that logId matches the log id in data.
void	checkNameMatchesPayload(String name, Logbook data) Check that name matches the logbook name in data.
void	checkNameMatchesPayload(String name, Tag data) Check that name matches the tag name in data.
void	checkPropertyName(String propertyName, Property data) Check the property name in data with the property name in the URL.
void	checkPropertyName(String propertyName, XmlProperty data) Check the property name in data with the property name in the URL.
void	checkUserBelongsToGroup(String user, Log data) Check that user belongs to the owner group specified in the log data.
void	checkUserBelongsToGroup(String user, Logbook data) Check that user belongs to the owner group specified in the logbook data.
void	checkUserBelongsToGroup(String user, Logbooks data) Check that user belongs to the owner groups of all logbooks in data.
void	checkUserBelongsToGroup(String user, Logs data) Check that user belongs to the owner groups of all logs in data.
void	checkUserBelongsToGroupOfLog(String user, Long logId) Check that user belongs to the owner group specified in the database for log logId.
void	checkUserBelongsToGroupOfLogbook(String user, String logbook) Check that user belongs to the owner group specified in the database for logbook logbook.
void	checkValid(Log data) Check the log in data for valid owner data.
void	checkValid(Logs data) Check all logs in data for valid owner data.
void	checkValidNameAndOwner(Logbook data) Check the logbook in data for valid name/owner data.
void	checkValidNameAndOwner(Logbooks data) Check all logbooks in data for valid name/owner data.
void	checkValidNameAndOwner(Tag data) Check the tag in data for valid name data.
void	checkValidNameAndOwner(Tags data) Check all tags in data for valid name data.
Log	createOrReplaceLog(Long logId, Log data) Update a log identified by logId, creating it when necessary.
Logbook	createOrReplaceLogbook(String logbookName, Logbook data) Adds the logbook identified by tag exclusively to the logs specified in the Logbook payload data, creating it if necessary.
Logbooks	createOrReplaceLogbooks(Logbooks data) Create or replace logbooks specified in data.
Logs	createOrReplaceLogs(Logs logs) Create logs specified in data.
Tag	createOrReplaceTag(String tagName, Tag data) Adds the tag identified by tag exclusively to the logs specified in the Tag payload data, creating it if necessary.
Tags	createOrReplaceTags(Tags data) Create tags specified in data.
Logbook	findLogbookByName(String name) Return single logbook found by name.
Log	findLogById(Long logId) Return single log found by log id.
Logs	findLogsByMultiMatch(javax.ws.rs.core.MultivaluedMap<String,String> matches) Returns logs found by matching logbook names, tag names, log description.
Tag	findTagByName(String name) Return single tag found by name.
static OlogImpl	getInstance() Returns the (singleton) instance of OlogManager
Logbooks	listLogbooks() List all Logbooks in the database.
XmlProperties	listProperties() Return a list of all properties
Tags	listTags() List all tags in the database.
static void	mergeXmlLogs(Log dest, Log src) Merges Logbooks and Tags of two logs in place
void	removeExistingLogbook(String logbook) Deletes a logbook identified by name from all logs, failing if the logbook does not exists.
void	removeExistingTag(String tag) Deletes a logbook identified by name from all logs, failing if the logbook does not exists.
void	removeLog(Long logId) Deletes a log identified by logId.
void	removeLogbook(String logbook) Deletes a logbook identified by name from all logs.
void	removeSingleLogbook(String logbookName, Long logId) Deletes a logbook identified by name from a single log.
void	removeSingleTag(String tagName, Long logId) Deletes a tag identified by name from a single log.
void	removeTag(String tag) Deletes a tag identified by name from all logs.
Log	updateLog(Long logId, Log data) Merge logbook set in data into the existing log logId.
Logbook	updateLogbook(Logbook data) Add the logbook identified by logbook to the logs specified in the Logs data.
Tag	updateTag(String tagName, Tag data) Add the tag identified by tag and state to the logs specified in the Logs data.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OlogImpl getInstance()

Returns the (singleton) instance of OlogManager

Returns:

the instance of OlogManager

mergeXmlLogs

public static void mergeXmlLogs(Log dest,
                Log src)

Merges Logbooks and Tags of two logs in place

Parameters:

dest - destination log

src - source log

findLogById

public Log findLogById(Long logId)
                throws OlogException,
                       UnsupportedEncodingException,
                       NoSuchAlgorithmException

Return single log found by log id.

Parameters:

logId - id to look for

Returns:

Log with found log and its logbooks

Throws:

OlogException - on SQLException

UnsupportedEncodingException

NoSuchAlgorithmException

findLogsByMultiMatch

public Logs findLogsByMultiMatch(javax.ws.rs.core.MultivaluedMap<String,String> matches)
                          throws OlogException,
                                 javax.jcr.RepositoryException,
                                 UnsupportedEncodingException,
                                 NoSuchAlgorithmException

Returns logs found by matching logbook names, tag names, log description.

Parameters:

matches - multivalued map of logbook, tag, log names and patterns to match their values against.

Returns:

Logs container with all found logs and their logbooks

Throws:

OlogException - wrapping an SQLException

javax.jcr.RepositoryException

UnsupportedEncodingException

NoSuchAlgorithmException

removeLog

public void removeLog(Long logId)
               throws OlogException

Deletes a log identified by logId.

Parameters:

logId - log to delete

Throws:

OlogException - wrapping an SQLException

listLogbooks

public Logbooks listLogbooks()
                      throws OlogException

List all Logbooks in the database.

Throws:

OlogException - wrapping an SQLException

findLogbookByName

public Logbook findLogbookByName(String name)
                          throws OlogException

Return single logbook found by name.

Parameters:

name - name to look for

Returns:

Logbook with found logbook and its logs

Throws:

OlogException - on SQLException

updateLogbook

public Logbook updateLogbook(Logbook data)
                      throws OlogException

Add the logbook identified by logbook to the logs specified in the Logs data.

Parameters:

logbook - logbook to add

data - Logbook data with all logs

Throws:

OlogException - on ownership mismatch, or wrapping an SQLException

createOrReplaceLogbook

public Logbook createOrReplaceLogbook(String logbookName,
                             Logbook data)
                               throws OlogException

Adds the logbook identified by tag exclusively to the logs specified in the Logbook payload data, creating it if necessary.

Parameters:

logbook - logbook to add

data - Logbook container with all logs to add logbook to

Throws:

OlogException - on ownership mismatch, or wrapping an SQLException

createOrReplaceLogbooks

public Logbooks createOrReplaceLogbooks(Logbooks data)
                                 throws OlogException

Create or replace logbooks specified in data.

Parameters:

data - Logbooks data

Throws:

OlogException - on ownership mismatch, or wrapping an SQLException

addSingleLogbook

public Logbook addSingleLogbook(String logbookName,
                       Long logId)
                         throws OlogException

Add the logbook identified by logbook to the single log id. TODO: this couldn't work as stated

Parameters:

logbook - logbook to add

logId - log to add the logbook to

data - Logbook

Throws:

OlogException - on ownership mismatch, or wrapping an SQLException

removeLogbook

public void removeLogbook(String logbook)
                   throws OlogException

Deletes a logbook identified by name from all logs.

Parameters:

logbook - tag to delete

Throws:

OlogException - wrapping an SQLException

removeExistingLogbook

public void removeExistingLogbook(String logbook)
                           throws OlogException

Deletes a logbook identified by name from all logs, failing if the logbook does not exists.

Parameters:

logbook - tag to delete

Throws:

OlogException - wrapping an SQLException or on failure

removeSingleLogbook

public void removeSingleLogbook(String logbookName,
                       Long logId)
                         throws OlogException

Deletes a logbook identified by name from a single log.

Parameters:

logbook - tag to delete

logId - log to delete it from

Throws:

OlogException - wrapping an SQLException

listTags

public Tags listTags()
              throws OlogException

List all tags in the database.

Throws:

OlogException - wrapping an SQLException

findTagByName

public Tag findTagByName(String name)
                  throws OlogException

Return single tag found by name.

Parameters:

name - name to look for

Returns:

Tag with found tag and its logs/state

Throws:

OlogException - on SQLException

updateTag

public Tag updateTag(String tagName,
            Tag data)
              throws OlogException

Add the tag identified by tag and state to the logs specified in the Logs data.

Parameters:

tag - tag to add

data - Tag with list of all logs to add tag to

Throws:

OlogException - on ownership mismatch, or wrapping an SQLException

createOrReplaceTag

public Tag createOrReplaceTag(String tagName,
                     Tag data)
                       throws OlogException

Adds the tag identified by tag exclusively to the logs specified in the Tag payload data, creating it if necessary.

Parameters:

tag - tag to add

data - Tag container with all logs to add tag to

Throws:

OlogException - on ownership mismatch, or wrapping an SQLException

createOrReplaceTags

public Tags createOrReplaceTags(Tags data)
                         throws OlogException

Create tags specified in data.

Parameters:

data - Tags data

Throws:

OlogException - on ownership mismatch, or wrapping an SQLException

removeExistingTag

public void removeExistingTag(String tag)
                       throws OlogException

Deletes a logbook identified by name from all logs, failing if the logbook does not exists.

Parameters:

logbook - tag to delete

Throws:

OlogException - wrapping an SQLException or on failure

addSingleTag

public Tag addSingleTag(String tagName,
               Long logId)
                 throws OlogException

Add the tag identified by tag to the single log logId.

Parameters:

tag - tag to add

logId -

Throws:

OlogException - on ownership mismatch, or wrapping an SQLException

removeTag

public void removeTag(String tag)
               throws OlogException

Deletes a tag identified by name from all logs.

Parameters:

tag - tag to delete

Throws:

OlogException - wrapping an SQLException

removeSingleTag

public void removeSingleTag(String tagName,
                   Long logId)
                     throws OlogException

Deletes a tag identified by name from a single log.

Parameters:

tag - tag to delete

logId - log to delete it from

Throws:

OlogException - wrapping an SQLException

listProperties

public XmlProperties listProperties()
                             throws OlogException

Return a list of all properties

Parameters:

-

Throws:

OlogException - wrapping an SQLException

createOrReplaceLog

public Log createOrReplaceLog(Long logId,
                     Log data)
                       throws OlogException,
                              UnsupportedEncodingException,
                              NoSuchAlgorithmException

Update a log identified by logId, creating it when necessary. The logbook set in data has to be complete, i.e. the existing log logbooks are replaced with the logbooks in data.

Parameters:

logId - log to update

data - Log data

Throws:

OlogException - on ownership or name mismatch, or wrapping an SQLException

UnsupportedEncodingException

NoSuchAlgorithmException

createOrReplaceLogs

public Logs createOrReplaceLogs(Logs logs)
                         throws OlogException,
                                UnsupportedEncodingException,
                                NoSuchAlgorithmException

Create logs specified in data.

Parameters:

logs - Logs data

Throws:

OlogException - on ownership mismatch, or wrapping an SQLException

UnsupportedEncodingException

NoSuchAlgorithmException

updateLog

public Log updateLog(Long logId,
            Log data)
              throws OlogException,
                     UnsupportedEncodingException,
                     NoSuchAlgorithmException

Merge logbook set in data into the existing log logId.

Parameters:

logId - log to merge the logbooks and tags into

data - Log data containing logbooks and tags

Throws:

OlogException - on name or owner mismatch, or wrapping an SQLException

UnsupportedEncodingException

NoSuchAlgorithmException

checkIdMatchesPayload

public void checkIdMatchesPayload(Long logId,
                         Log data)
                           throws OlogException

Check that logId matches the log id in data.

Parameters:

logId - log id to check

data - Log data to check against

Throws:

OlogException - on name mismatch

checkValid

public void checkValid(Log data)
                throws OlogException

Check the log in data for valid owner data.

Parameters:

data - Log data to check

Throws:

OlogException - on error

checkValid

public void checkValid(Logs data)
                throws OlogException

Check all logs in data for valid owner data.

Parameters:

data - Logs data to check

Throws:

OlogException - on error

checkNameMatchesPayload

public void checkNameMatchesPayload(String name,
                           Tag data)
                             throws OlogException

Check that name matches the tag name in data.

Parameters:

name - tag name to check

data - Tag data to check against

Throws:

OlogException - on name mismatch

checkValidNameAndOwner

public void checkValidNameAndOwner(Tag data)
                            throws OlogException

Check the tag in data for valid name data.

Parameters:

data - Tag data to check

Throws:

OlogException - on name mismatch

checkPropertyName

public void checkPropertyName(String propertyName,
                     Property data)
                       throws OlogException

Check the property name in data with the property name in the URL.

Parameters:

propertyName - name coming from the URL

data - Property data

Throws:

OlogException - on name mismatch

checkPropertyName

public void checkPropertyName(String propertyName,
                     XmlProperty data)
                       throws OlogException

Check the property name in data with the property name in the URL.

Parameters:

propertyName - name coming from the URL

data - Property data

Throws:

OlogException - on name mismatch

checkValidNameAndOwner

public void checkValidNameAndOwner(Tags data)
                            throws OlogException

Check all tags in data for valid name data.

Parameters:

data - Tags data to check

Throws:

OlogException - on error

checkNameMatchesPayload

public void checkNameMatchesPayload(String name,
                           Logbook data)
                             throws OlogException

Check that name matches the logbook name in data.

Parameters:

name - logbook name to check

data - Logbook data to check against

Throws:

OlogException - on name mismatch

checkValidNameAndOwner

public void checkValidNameAndOwner(Logbook data)
                            throws OlogException

Check the logbook in data for valid name/owner data.

Parameters:

data - Logbook data to check

Throws:

OlogException - on error

checkValidNameAndOwner

public void checkValidNameAndOwner(Logbooks data)
                            throws OlogException

Check all logbooks in data for valid name/owner data.

Parameters:

data - Logbooks data to check

Throws:

OlogException - on error

checkUserBelongsToGroupOfLog

public void checkUserBelongsToGroupOfLog(String user,
                                Long logId)
                                  throws OlogException,
                                         UnsupportedEncodingException,
                                         NoSuchAlgorithmException

Check that user belongs to the owner group specified in the database for log logId.

Parameters:

user - user name

logId - name of log to check ownership for

Throws:

OlogException - on name mismatch

UnsupportedEncodingException

NoSuchAlgorithmException

checkUserBelongsToGroupOfLogbook

public void checkUserBelongsToGroupOfLogbook(String user,
                                    String logbook)
                                      throws OlogException

Check that user belongs to the owner group specified in the database for logbook logbook.

Parameters:

user - user name

logbook - name of logbook to check ownership for

Throws:

OlogException - on name mismatch

checkUserBelongsToGroup

public void checkUserBelongsToGroup(String user,
                           Log data)
                             throws OlogException

Check that user belongs to the owner group specified in the log data.

Parameters:

user - user name

data - Log data to check ownership for

Throws:

OlogException - on name mismatch

checkUserBelongsToGroup

public void checkUserBelongsToGroup(String user,
                           Logs data)
                             throws OlogException

Check that user belongs to the owner groups of all logs in data.

Parameters:

user - user name

data - Logs data to check ownership for

Throws:

OlogException - on name mismatch

checkUserBelongsToGroup

public void checkUserBelongsToGroup(String user,
                           Logbook data)
                             throws OlogException

Check that user belongs to the owner group specified in the logbook data.

Parameters:

user - user name

data - Logbook data to check ownership for

Throws:

OlogException - on name mismatch

checkUserBelongsToGroup

public void checkUserBelongsToGroup(String user,
                           Logbooks data)
                             throws OlogException

Check that user belongs to the owner groups of all logbooks in data.

Parameters:

user - user name

data - Logs data to check ownership for

Throws:

OlogException - on name mismatch