org.phoebus.logbook.LogClient Maven / Gradle / Ivy
package org.phoebus.logbook;
import java.io.File;
import java.io.InputStream;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
/**
* @author Eric Berryman taken from shroffk
*/
public interface LogClient {
/**
* Create a single LogEntry log, if the LogEntry already exists it is replaced.
*
* @param log - LogEntry to be added
* @return - the created log entry
*/
LogEntry set(LogEntry log) throws LogbookException;
/**
* Create a log entry as reply to an existing one.
*
* @param log The {@link LogEntry} holding the reply
* @param inReplyTo The {@link LogEntry} to which log is a reply.
* @return The created {@link LogEntry}
* @throws LogbookException For instance if logId is invalid, or if an implementation
* does not support this.
*/
default LogEntry reply(LogEntry log, LogEntry inReplyTo) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Returns a LogEntry that exactly matches the logId logId
*
* @param logId LogEntry id
* @return LogEntry object
*/
LogEntry getLog(Long logId);
/**
* Returns a collection of attachments that matches the logId logId
*
* @param logId LogEntry id
* @return attachments collection object
*/
Collection listAttachments(Long logId);
/**
* Query for logs based on the criteria specified in the map
*
* @param map - search parameters
* @return collection of LogEntry objects
*/
List findLogs(Map map);
/**
* Return all the logs. ***Warning can return a lot of data***
*
* @return Collection of all {@link LogEntry}s
*/
Collection listLogs();
/**
* Get a list of all the logbooks currently existings
*
* @return string collection of logbooks
*/
default Collection listLogbooks() {
return Collections.emptyList();
}
/**
* Get a list of all the tags currently existing
*
* @return string collection of tags
*/
default Collection listTags() {
return Collections.emptyList();
}
/**
* Get a list of all the Properties currently existing
*
* @return list of properties
*/
default Collection listProperties() {
return Collections.emptyList();
}
/**
* List the supported log levels
*
* @return a list of supported levels
*/
default Collection listLevels() {
return Collections.emptyList();
}
/**
* List all the active attributes associated with the property
* propertyName property must exist, name != null
*
* @param propertyName - string property name
* @return list of property attributes
*/
default Collection listAttributes(String propertyName) {
return Collections.emptyList();
}
/**
* Retrieve an attachment of a log entry
*
* @param logId - log id
* @param attachment - the at
* @return {@link InputStream} to the attachment file
*/
default InputStream getAttachment(Long logId, Attachment attachment) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* @param logId - log id
* @param attachmentName - attachment name
* @return {@link InputStream} to the attachment file
*/
default InputStream getAttachment(Long logId, String attachmentName) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* return the complete property property
*
* @param property - property name
* @return the @property if it exists
*/
default Property getProperty(String property) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Create a Tag tag.
*
* @param tag - the tag to be created
* @return The created tag
*/
default Tag set(Tag tag) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Create tag tag on the set of logs logIds
*
* @param tag - create a new tag
* @param logIds - the log ids to which the above tag is to be added
* @return the created tag
*/
default Tag set(Tag tag, Collection logIds) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Create a new logbook logbook with no associated logs.
*
* @param Logbook - the @logbook to be created
* @return the created logbook
*/
default Logbook set(Logbook Logbook) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Create of replace logbook and add them to the logs logIds
*
* @param logbook - logbook to be created
* @param logIds - log ids to which the created logbook is to be
*/
default Logbook set(Logbook logbook, Collection logIds) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Create or replace property property
*
* @param property - the property to be created or replaced
* @return the created/updated property
*/
default Property set(Property property) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Update a LogEntry entry LogEntry
*
* @param log - the updated log entry
* @return the updated LogEntry entry
*/
default LogEntry update(LogEntry log) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Update a set of logs
*
* @param logs set of logs to be added
* @return return updated logentries
*/
default Collection update(Collection logs) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Update an existing property.
*
* @param property - the property to be updates
* @return the updated property
*/
default Property update(Property property) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Update Tag tag by adding it to LogEntry with id logId
*
* @param tag - tag to be updated
* @param logId LogEntry id the tag is to be added
* @return updated tag
*/
default Tag update(Tag tag, Long logId) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Update the Tag tag by adding it to the set of the logs with ids
* logIds
*
* @param tag - tag to be updated
* @param logIds - collection of LogEntry id
* @return updated tag
*/
default Tag update(Tag tag, Collection logIds) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Add Logbook logbook to the LogEntry logId
*
* @param logbook - logbook to be updated
* @param logId - LogEntry id the logbook is to be added
* @return updated logbook
*/
default Logbook update(Logbook logbook, Long logId) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Update the Tag logbook by adding it to the set of the logs with ids
* logIds
*
* @param logbook - logbook to be updated
* @param logIds - LogEntry id the logbook is to be added
* @return updated logbook
*/
default Logbook update(Logbook logbook, Collection logIds) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Update Property property by adding it to LogEntry with id
* logId
*
* @param property - property to be
* @param logId - LogEntry id the property to be added
* @return updated property
*/
default Property update(Property property, Long logId) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* @param logId - the log id of the entry to which the file is to be attached
* @param local - local file to be attached to logId
* @return the new attachment add to the log entry
*/
default Attachment add(File local, Long logId) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* @param logId - the log id of the entry to be retrieved
* @return The log identified by logId
*/
@Deprecated
default LogEntry findLogById(Long logId) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* @param pattern - search pattern
* @return List of matching {@link LogEntry}
*/
default List findLogsBySearch(String pattern) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Find log entries with tag {tagname}
*
* @param tagName - tag name
* @return List of matching {@link LogEntry}
*/
default List findLogsByTag(String tagName) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Find log entries with logbook
*
* @param logbookName - logbook name
* @return List of matching {@link LogEntry}
*/
default List findLogsByLogbook(String logbookName) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* This function is a subset of queryLogs should it be removed??
*
* search for logs with property property and optionally value
* matching patternpropertyValue
*
* @param propertyName Property identifier
* @param attributeName Attribute identifier
* @param attributeValue Attribute value
* @return List of matching {@link LogEntry}
*/
default List findLogsByProperty(String propertyName, String attributeName, String attributeValue) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Find log entries with the given property
*
* @param propertyName - name of the required property
* @return List of matching {@link LogEntry}
*/
default List findLogsByProperty(String propertyName) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Delete the tag with name tag
*
* @param tagName - the name of the tag to be deleted
*/
default void deleteTag(String tagName) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Delete the logbook with name logbook
*
* @param logbookName - the name of the logbook to be deleted
*/
default void deleteLogbook(String logbookName) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Delete the property with name property
*
* @param propertyName - property to be deleted
*/
default void deleteProperty(String propertyName) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Remove the LogEntry log
*
* @param log LogEntry to be removed
*/
default void delete(LogEntry log) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Remove the LogEntry identified by logId
*
* @param logId LogEntry id LogEntry id to be removed
*/
default void delete(Long logId) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Remove the LogEntry collection identified by logIds
*
* @param logIds logs to be removed
*/
default void delete(Collection logIds) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Remove tag tag from the LogEntry with the id logId
*
* @param tag - the tag to be removed
* @param logId - the log entry from which the tag is to be removed
*/
default void delete(Tag tag, Long logId) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Remove the tag tag from all the logs identified by logIds
*
* @param tag - the tag to be removed
* @param logIds - the logs from which the tag is to be removed
*/
default void delete(Tag tag, Collection logIds) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Remove logbook logbook from the LogEntry with name logName
*
* @param logbook - the logbook to be removed
* @param logId - the log entry from which the logbook is to be removed
*/
default void delete(Logbook logbook, Long logId) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Remove the logbook logbook from the set of logs logIds
*
* @param logbook - the logbook to be removed
* @param logIds - the logs from which the logbook is to be removed
*/
default void delete(Logbook logbook, Collection logIds) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Remove property property from the LogEntry with id logId
*
* @param property - the property to be deleted
* @param logId - LogEntry id from which the property is to be removed
*/
default void delete(Property property, Long logId) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Remove the property property from the set of logs
* logIds
*
* @param property - the property to be deleted
* @param logIds - the logs from which to property is to be removed
*/
default void delete(Property property, Collection logIds) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* Remove file attachment from LogEntry logId
*
* @param fileName - the file name to be removed
* @param logId - the logid from which the attached file is to be removed
*/
default void delete(String fileName, Long logId) throws LogbookException {
throw new LogbookException(new UnsupportedOperationException());
}
/**
* @return The service URL configured in the client.
*/
default String getServiceUrl() {
return null;
}
default SearchResult search(Map map) throws LogbookException{
throw new LogbookException(new UnsupportedOperationException());
}
default void groupLogEntries(List logEntryIds) throws LogbookException{
throw new LogbookException(new UnsupportedOperationException());
}
/**
* @return Information about the remote service. It is up to the service implementation to
* provide relevant information.
*/
default String serviceInfo(){
return null;
}
/**
* @param id Unique log entry id
* @return A list of archived {@link LogEntry}s corresponding to the unique id.
*/
default SearchResult getArchivedEntries(long id){
return null;
}
}