net.datenwerke.rs.terminal.service.terminal

Interface TerminalService

public interface TerminalService

Field Summary

Fields

Modifier and Type	Field and Description
static double	CHAR_WIDTH

Method Summary

Modifier and Type	Method and Description
void	closeTerminalSession(java.lang.String sessionId) Closes the TerminalSession identified by the given sessionId
CommandResult	convertListOfListsToCommandResult(java.lang.String headline, java.util.List<java.util.List<java.lang.String>> lists)
CommandResult	convertResultSetToCommandResult(java.sql.ResultSet rs)
CommandResult	convertSimpleListToCommandResult(java.lang.String headline, java.util.List<java.lang.String> list)
RSTableModel	convertSimpleListToTableModel(java.lang.String headline, java.util.List<java.lang.String> list)
CommandResult	convertSimpleMapListToCommandResult(java.util.List<java.lang.String> headlines, java.lang.String emptyTableMessage, java.util.List<java.util.Map<java.lang.String,java.lang.String>> mapList, java.util.List<java.lang.String> firstKeys, java.util.Map<java.lang.String,java.lang.String> keyToText) Creates a CommandResult that contains a table created from the given list of maps.
RSTableModel	convertSimpleMapListToTableModel(java.lang.String emptyTableMessage, java.util.List<java.util.Map<java.lang.String,java.lang.String>> mapList, java.util.List<java.lang.String> firstKeys, java.util.Map<java.lang.String,java.lang.String> keyToText)
CommandResult	convertSimpleMapToCommandResult(java.util.List<java.lang.String> headlines, java.util.Map<java.lang.String,java.lang.Object> map) Creates a CommandResult that contains a table created from the given map.
CommandResult	convertSimpleMapToCommandResult(java.util.List<java.lang.String> headlines, java.lang.String emptyTableMessage, java.util.Map<java.lang.String,java.lang.Object> map) Creates a CommandResult that contains a table created from the given map.
RSTableModel	convertSimpleMapToTableModel(java.util.Map<java.lang.String,java.lang.Object> map)
java.lang.Object	getObjectByQuery(java.lang.Class<? extends VirtualFileSystemManagerHook> vfs, java.lang.String location)
java.lang.Object	getObjectByQuery(java.lang.Class<? extends VirtualFileSystemManagerHook> vfsManager, java.lang.String location, boolean checkRights)
java.lang.Object	getObjectByQuery(java.lang.String location) Fetches a single object by an object resolver query.
java.lang.Object	getObjectByQuery(java.lang.String location, boolean checkRights) Fetches a single object by an object resolver query.
java.util.Collection<java.lang.Object>	getObjectsByQuery(java.lang.String location) Fetch objects by an object resolver query.
java.util.Collection<java.lang.Object>	getObjectsByQuery(java.lang.String location, boolean checkRights) Fetches objects by an object resolver query.
<T> T	getSingleObjectOfTypeByQuery(java.lang.Class<T> type, java.lang.String query, TerminalSession session, java.lang.Class<? extends Right>... rights)
TerminalSession	getTerminalSession(java.lang.String sessionId) Returns the TerminalSession identified by the given sessionId
TerminalSession	getUnscopedTerminalSession()
int	getWidthForText(java.lang.String text) Gets the width of the given text in pixels if its rendered in the terminal
TerminalSession	initTerminalSession() Initializes a new TerminalSession.
java.lang.String	join(java.util.List<java.lang.String> list, boolean sort) Joins the list with ", ".

Field Detail

CHAR_WIDTH

static final double CHAR_WIDTH

See Also:

Constant Field Values

Method Detail

initTerminalSession

TerminalSession initTerminalSession()

Initializes a new TerminalSession.

Returns:

The newly initialized TerminalSession

getTerminalSession

TerminalSession getTerminalSession(java.lang.String sessionId)
                            throws SessionNotFoundException

Returns the TerminalSession identified by the given sessionId

Parameters:

sessionId - The ID of the desired TerminalSession

Returns:

The TerminalSession

Throws:

SessionNotFoundException

closeTerminalSession

void closeTerminalSession(java.lang.String sessionId)

Closes the TerminalSession identified by the given sessionId

Parameters:

sessionId - The ID of the TerminalSession

getObjectByQuery

java.lang.Object getObjectByQuery(java.lang.Class<? extends VirtualFileSystemManagerHook> vfs,
                                  java.lang.String location)
                           throws VFSException

Throws:

VFSException

getObjectByQuery

java.lang.Object getObjectByQuery(java.lang.String location)
                           throws ObjectResolverException

Fetches a single object by an object resolver query. Permissions are checked.

Parameters:

location - the object resolver query

Returns:

the object found

Throws:

ObjectResolverException - if the query is not valid or something happens during query execution

getObjectByQuery

java.lang.Object getObjectByQuery(java.lang.String location,
                                  boolean checkRights)
                           throws ObjectResolverException

Fetches a single object by an object resolver query.

Parameters:

location - the object resolver query

checkRights - if permissions should be checked

Returns:

the object found

Throws:

ObjectResolverException - if the query is not valid or something happens during query execution

getObjectByQuery

java.lang.Object getObjectByQuery(java.lang.Class<? extends VirtualFileSystemManagerHook> vfsManager,
                                  java.lang.String location,
                                  boolean checkRights)
                           throws VFSException

Throws:

VFSException

getObjectsByQuery

java.util.Collection<java.lang.Object> getObjectsByQuery(java.lang.String location,
                                                         boolean checkRights)
                                                  throws ObjectResolverException

Fetches objects by an object resolver query.

Parameters:

location - the object resolver query

checkRights - if permissions should be checked

Returns:

the objects found

Throws:

ObjectResolverException - if the query is not valid or something happens during query execution

getObjectsByQuery

java.util.Collection<java.lang.Object> getObjectsByQuery(java.lang.String location)
                                                  throws ObjectResolverException

Fetch objects by an object resolver query. Permissions are checked.

Parameters:

location - the object resolver query

Returns:

the objects found

Throws:

ObjectResolverException - if the query is not valid or something happens during query execution

getUnscopedTerminalSession

TerminalSession getUnscopedTerminalSession()

getSingleObjectOfTypeByQuery

<T> T getSingleObjectOfTypeByQuery(java.lang.Class<T> type,
                                   java.lang.String query,
                                   TerminalSession session,
                                   java.lang.Class<? extends Right>... rights)
                            throws ObjectResolverException

Throws:

ObjectResolverException

convertResultSetToCommandResult

CommandResult convertResultSetToCommandResult(java.sql.ResultSet rs)
                                       throws java.sql.SQLException

Throws:

java.sql.SQLException

convertSimpleMapToCommandResult

CommandResult convertSimpleMapToCommandResult(java.util.List<java.lang.String> headlines,
                                              java.lang.String emptyTableMessage,
                                              java.util.Map<java.lang.String,java.lang.Object> map)

Creates a CommandResult that contains a table created from the given map. The table contains the map keys as the first table column and their corresponding values as the second table column.

Parameters:

headlines - headlines of the CommandResult. Each headline is printed in a new row. Note that these are NOT the table headers.

emptyTableMessage - message to show if the map is empty.

map - the map. Its keys map to the first table column of the result, their corresponding values to its second table column.

Returns:

a CommandResult containing the given map as a table.

convertSimpleMapToCommandResult

CommandResult convertSimpleMapToCommandResult(java.util.List<java.lang.String> headlines,
                                              java.util.Map<java.lang.String,java.lang.Object> map)

Creates a CommandResult that contains a table created from the given map. The table contains the map keys as the first table column and their corresponding values as the second table column.

Parameters:

headlines - headlines of the CommandResult. Each headline is printed in a new row. Note that these are NOT the table headers.

map - the map. Its keys map to the first table column of the result, their corresponding values to its second table column.

Returns:

a CommandResult containing the given map as a table.

convertSimpleMapToTableModel

RSTableModel convertSimpleMapToTableModel(java.util.Map<java.lang.String,java.lang.Object> map)

getWidthForText

int getWidthForText(java.lang.String text)

Gets the width of the given text in pixels if its rendered in the terminal

Parameters:

text - The text

Returns:

the width in pixels.

convertSimpleListToTableModel

RSTableModel convertSimpleListToTableModel(java.lang.String headline,
                                           java.util.List<java.lang.String> list)

convertSimpleListToCommandResult

CommandResult convertSimpleListToCommandResult(java.lang.String headline,
                                               java.util.List<java.lang.String> list)

convertListOfListsToCommandResult

CommandResult convertListOfListsToCommandResult(java.lang.String headline,
                                                java.util.List<java.util.List<java.lang.String>> lists)

convertSimpleMapListToCommandResult

CommandResult convertSimpleMapListToCommandResult(java.util.List<java.lang.String> headlines,
                                                  java.lang.String emptyTableMessage,
                                                  java.util.List<java.util.Map<java.lang.String,java.lang.String>> mapList,
                                                  java.util.List<java.lang.String> firstKeys,
                                                  java.util.Map<java.lang.String,java.lang.String> keyToText)

Creates a CommandResult that contains a table created from the given list of maps. The map keys map to the table headers, their corresponding values map to the table values. All maps must have the same size. The order of the headers is not defined. If the firstHeaders attribute is given, the table headers contain the given firstHeaders in first place and their order is preserved. All firstHeaders must be contained in all maps.

Parameters:

headlines - headlines of the CommandResult. Each headline is printed in a new row. Note that these are NOT the table headers.

emptyTableMessage - message to shwo if the list of maps is empty.

mapList - the list of maps.

firstKeys - the ordered first map keys to appear in the table

keyToDisplayText - maps the map keys to a display text

Returns:

a CommandResult containing the given list of maps as a table.

convertSimpleMapListToTableModel

RSTableModel convertSimpleMapListToTableModel(java.lang.String emptyTableMessage,
                                              java.util.List<java.util.Map<java.lang.String,java.lang.String>> mapList,
                                              java.util.List<java.lang.String> firstKeys,
                                              java.util.Map<java.lang.String,java.lang.String> keyToText)

join

java.lang.String join(java.util.List<java.lang.String> list,
                      boolean sort)

Joins the list with ", ". If sort is true, sorts the given list alphabetically

Parameters:

list - the list

sort - if false, just joins without sorting

Returns:

the converted string