com.activeviam.tools.bookmark.impl

Class BookmarkTool

java.lang.Object

com.activeviam.tools.bookmark.impl.BookmarkTool

public class BookmarkTool
extends Object

Library class exposing content server bookmark import and export functionality for Accelerators.

Constructor Summary

Constructors

Constructor and Description
BookmarkTool()

Method Summary

Modifier and Type	Method and Description
static void	configureExportFileNames(String encodingChar, List<String> charsToEncode) Sets the character that should be used to replace forbidden characters in file names.
static void	exportBookmarks(com.qfs.content.snapshot.impl.ContentServiceSnapshotter snapshotter, String folderName, Map<String,List<String>> defaultPermissions) Exports content server bookmarks into a directory structure representing the UI bookmark structure.
static void	importBookmarks(com.qfs.content.snapshot.impl.ContentServiceSnapshotter snapshotter, String folderName, Map<String,List<String>> defaultPermissions) Imports content server bookmarks from a directory structure representing the required UI bookmark structure.
static com.quartetfs.fwk.IPair<com.fasterxml.jackson.databind.JsonNode,com.fasterxml.jackson.databind.JsonNode>	transformPermissionsMapToPair(Map<String,List<String>> permissions) Transform a permissions map of type to role names into a pair of JsonNode objects.
static Map<String,List<String>>	transformPermissionsPairToMap(com.quartetfs.fwk.IPair<com.fasterxml.jackson.databind.node.ArrayNode,com.fasterxml.jackson.databind.node.ArrayNode> permissions) Transform a pair of JsonNode objects into a map of type to role name.
static Map<String,List<String>>	transformPermissionsStringsToMap(String owners, String readers) Transform the string representation of lists of role names into a map of type to role name.
static com.quartetfs.fwk.IPair<com.fasterxml.jackson.databind.JsonNode,com.fasterxml.jackson.databind.JsonNode>	transformPermissionsStringsToPair(String owners, String readers) Transform the string representation of lists of role names into a pair of JsonNode objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

BookmarkTool

public BookmarkTool()

Method Detail

importBookmarks

public static void importBookmarks(com.qfs.content.snapshot.impl.ContentServiceSnapshotter snapshotter,
                                   String folderName,
                                   Map<String,List<String>> defaultPermissions)

Imports content server bookmarks from a directory structure representing the required UI bookmark structure.

Parameters:

snapshotter - The content service snapshotter to use for the import.

folderName - The folder from which to import the bookmarks.

defaultPermissions - The permissions to use when not explicitly defining permissions for any bookmark path.

exportBookmarks

public static void exportBookmarks(com.qfs.content.snapshot.impl.ContentServiceSnapshotter snapshotter,
                                   String folderName,
                                   Map<String,List<String>> defaultPermissions)

Exports content server bookmarks into a directory structure representing the UI bookmark structure.

Parameters:

snapshotter - The content service snapshotter to use for the export.

folderName - The folder into which the bookmarks should be exported.

defaultPermissions - The default permissions to use for the tree, except where explicitly defined otherwise.

configureExportFileNames

public static void configureExportFileNames(String encodingChar,
                                            List<String> charsToEncode)

Sets the character that should be used to replace forbidden characters in file names. Allows customisation of forbidden characters.

Parameters:

encodingChar - The encoding character.

charsToEncode - A custom list of characters that should be replaced with the encoding character.

transformPermissionsMapToPair

public static com.quartetfs.fwk.IPair<com.fasterxml.jackson.databind.JsonNode,com.fasterxml.jackson.databind.JsonNode> transformPermissionsMapToPair(Map<String,List<String>> permissions)

Transform a permissions map of type to role names into a pair of JsonNode objects.

Parameters:

permissions - The map of type to role name.

Returns:

The pair of JsonNode objects.

transformPermissionsStringsToPair

public static com.quartetfs.fwk.IPair<com.fasterxml.jackson.databind.JsonNode,com.fasterxml.jackson.databind.JsonNode> transformPermissionsStringsToPair(String owners,
                                                                                                                                                         String readers)

Transform the string representation of lists of role names into a pair of JsonNode objects.

Parameters:

owners - The string representation of a list of owners.

readers - The string representation of a list of readers.

Returns:

The pair of JsonNode objects.

transformPermissionsStringsToMap

public static Map<String,List<String>> transformPermissionsStringsToMap(String owners,
                                                                        String readers)

Transform the string representation of lists of role names into a map of type to role name.

Parameters:

owners - The string representation of a list of owners.

readers - The string representation of a list of readers.

Returns:

The permissions map.

transformPermissionsPairToMap

public static Map<String,List<String>> transformPermissionsPairToMap(com.quartetfs.fwk.IPair<com.fasterxml.jackson.databind.node.ArrayNode,com.fasterxml.jackson.databind.node.ArrayNode> permissions)

Transform a pair of JsonNode objects into a map of type to role name.

Parameters:

permissions - The pair of JsonNode objects.

Returns:

The permissions map.