Chapter 7. Java Services

TaxonomyService
LinkManager
PublicationManager
WCMComposer
NewFolksonomy
ApplicationTemplateManager
NodeFinder
JodConverter

Taxonomy service is used to work with taxonomies. In this service, there are many functions which enable you to add, find, delete taxonomies from a node.

Method Return Prototype Description
getTaxonomyTree Node

getTaxonomyTree(String repository, String taxonomyName, boolean system) throws RepositoryException;

Returns the root node of the given taxonomy tree

@param repository: The name of repository

@param taxonomyName: The name of the taxonomy

@param system: Indicates whether the nodes must be retrieved using a session system or user session

@throws RepositoryException: if the taxonomy tree could not be found

getTaxonomyTree

Node

getTaxonomyTree(String repository, String taxonomyName) throws RepositoryException;

Returns the root node of the given taxonomy tree with the user session

@param repository: The name of repository

@param taxonomyName: The name of the taxonomy

@throws RepositoryException: if the taxonomy tree could not be found

getAllTaxonomyTrees List<Node>

getAllTaxonomyTrees(String repository, boolean system) throws RepositoryException;

Returns the list of all the root nodes of the taxonomy tree available

@param repository: The name of repository

@param system: Indicates whether the nodes must be retrieved using a session system or user session

@throws RepositoryException: if the taxonomy trees could not be found

getAllTaxonomyTrees List<Node>

getAllTaxonomyTrees(String repository) throws RepositoryException;

Returns the list of all the root nodes of the taxonomy tree available with the user session

@param repository: The name of repository

@throws RepositoryException: if the taxonomies could not be found

hasTaxonomyTree

boolean

hasTaxonomyTree(String repository, String taxonomyName) throws RepositoryException;

Checks if a taxonomy tree with the given name has already been defined

@param repository: The name of repository

@param taxonomyName: The name of the taxonomy

@throws RepositoryException: if the taxonomy name could not be checked

addTaxonomyTree void

addTaxonomyTree(Node taxonomyTree) throws RepositoryException, TaxonomyAlreadyExistsException;

Defines a node as a new taxonomy tree

@param taxonomyTree: The taxonomy tree to define

@throws TaxonomyAlreadyExistsException: if a taxonomy with the same name has already been defined

@throws RepositoryException: if the taxonomy tree could not be defined

updateTaxonomyTree

void

updateTaxonomyTree(String taxonomyName, Node taxonomyTree) throws RepositoryException;

Re-defines a node as a taxonomy tree

@param taxonomyName: The name of the taxonomy to update

@param taxonomyTree: The taxonomy tree to define

@throws RepositoryException: if the taxonomy tree could not be updated

removeTaxonomyTree

void

removeTaxonomyTree(String taxonomyName) throws RepositoryException;

Remove the taxonomy tree definition

@param taxonomyName: The name of the taxonomy to remove

@throws RepositoryException: if the taxonomy tree could not be removed

addTaxonomyNode

void

addTaxonomyNode(String repository, String workspace, String parentPath, String taxoNodeName, String creator) throws RepositoryException, TaxonomyNodeAlreadyExistsException;

Adds a new taxonomy node at the given location

@param repository: The name of the repository

@param workspace: The name of the workspace

@param parentPath: The place where the taxonomy node will be added

@param taxoNodeName :The name of taxonomy node

@param creator: The name of the user creating this node

@throws TaxonomyNodeAlreadyExistsException: if a taxonomy node with the same name has already been added

@throws RepositoryException: if the taxonomy node could not be added

removeTaxonomyNode void

removeTaxonomyNode(String repository, String workspace, String absPath) throws RepositoryException;

Remove the taxonomy node located at the given absolute path

@param repository: The name of the repository

@param workspace: The name of the workspace

@param absPath: The absolute path of the taxonomy node to remove

@throws RepositoryException: if the taxonomy node could not be removed

moveTaxonomyNode void

moveTaxonomyNode(String repository, String workspace, String srcPath, String destPath, String type) throws RepositoryException;

Copies or cuts the taxonomy node from source path to destination path. The parameter type indicates if the node must be cut or copied

@param repository: The name of the repository

@param workspace: The name of the workspace

@param srcPath: The source path of this taxonomy

@param destPath: The destination path of the taxonomy

@param type: If type is equal to cut, the process will be cut. If type is equal to copy, the process will be copied

@throws RepositoryException: if the taxonomy node could not be moved

hasCategories boolean

hasCategories(Node node, String taxonomyName) throws RepositoryException;

Returns true if the given node has categories in the given taxonomy

@param node: The node to check

@param taxonomyName: The name of the taxonomy

@throws RepositoryException: if categories cannot be checked

hasCategories boolean

hasCategories(Node node, String taxonomyName, boolean system) throws RepositoryException;

Return true if the given node has categories in the given taxonomy

@param node: The node to check

@param taxonomyName: The name of the taxonomy

@param system: check system provider or not

@throws RepositoryException: if categories cannot be checked

getCategories List<Node>

getCategories(Node node, String taxonomyName) throws RepositoryException;

Returns all the paths of the categories (relative to the root node of the given taxonomy) which have been associated to the given node for the given taxonomy

@param node: The node for which we seek the categories

@param taxonomyName: The name of the taxonomy

@throws RepositoryException: if the categories cannot be retrieved

getCategories List<Node>

getCategories(Node node, String taxonomyName, boolean system) throws RepositoryException;

Returns all the paths of the categories(relative to the root node of the given taxonomy) which have been associated to the given node for the given taxonomy

@param node: The node for which we seek the categories

@param taxonomyName: The name of the taxonomy

@param system

@throws RepositoryException: if the categories cannot be retrieved

getAllCategories List<Node>

getAllCategories(Node node) throws RepositoryException;

Returns all the paths of the categories which have been associated to the given node

@param node: The node for which we seek the categories

@throws RepositoryException

getAllCategories List<Node>

getAllCategories(Node node, boolean system) throws RepositoryException;

Returns all the paths of the categories which have been associated to the given node

@param node: The node for which we seek the categories

@param system: check system provider or not

@throws RepositoryException

removeCategory void

removeCategory(Node node, String taxonomyName, String categoryPath) throws RepositoryException;

Removes a category to the given node

@param node: The node for which we remove the category

@param taxonomyName: The name of the taxonomy

@param categoryPath: The path of the category relative to the root node of the given taxonomy

@throws RepositoryException: if the category cannot be removed

removeCategory

void

removeCategory(Node node, String taxonomyName, String categoryPath, boolean system) throws RepositoryException;

Removes a category to the given node

@param node: The node for which we remove the category

@param taxonomyName: The name of the taxonomy

@param categoryPath: The path of the category relative to the root node of the given taxonomy

@param system: check system provider or not

@throws RepositoryException: if the category cannot be removed

addCategories void

addCategories(Node node, String taxonomyName, String[] categoryPaths) throws RepositoryException;

Adds several categories to the given node

@param node: The node for which we add the categories

@param taxonomyName: The name of the taxonomy

@param categoryPaths: An array of category paths relative to the given taxonomy

@throws RepositoryException: if the categories cannot be added

addCategories

void

addCategories(Node node, String taxonomyName, String[] categoryPaths, boolean system) throws RepositoryException;

Adds several categories to the given node

@param node: The node for which we add the categories

@param taxonomyName: The name of the taxonomy

@param categoryPaths: An array of category paths relative to the given taxonomy

@param system: check system provider or not

@throws RepositoryException: if the categories cannot be added

addCategory

void

addCategory(Node node, String taxonomyName, String categoryPath) throws RepositoryException;

Adds a new category path to the given node

@param node: the node for which we add the category

@param taxonomyName: The name of the taxonomy

@param categoryPath: The path of the category relative to the given taxonomy

@throws RepositoryException: if the category cannot be added

addCategory

void

addCategory(Node node, String taxonomyName, String categoryPath, boolean system) throws RepositoryException;

Adds a new category path to the given node

@param node: the node for which we add the category

@param taxonomyName: The name of the taxonomy

@param categoryPath: The path of the category relative to the given taxonomy

@param system: check system provider or not

@throws RepositoryException: if the category cannot be added

getTaxonomyTreeDefaultUserPermission

Map<String, String[]>

getTaxonomyTreeDefaultUserPermission();

get default permission for the user in taxonomy tree
addTaxonomyPlugin void

addTaxonomyPlugin(ComponentPlugin plugin);

Add a new taxonomy plugin to the service

@param plugin: The plugin to add

init

void

init(String repository) throws Exception;

Initialize all taxonomy plugins that have been already configured in .xml files

@param repository: The name of repository

@see TaxonomyPlugin

@throws Exception

Supply API to work with the linked node or the link included in a node.

Package org.exoplatform.services.cms.link.LinkManager

Method Return Prototype Description
createLink Node

createLink(Node parent, String linkType, Node target)

throws RepositoryException;

Creates a new link, add it to the parent node and returns the link

@param parent: The parent node of the link

@param linkType: The primary node type of the link must be a sub-type of

exo:symlink, the default value is "exo:symlink"

@param target The target of the link

@throws RepositoryException: if the link cannot be created for any reason

createLink Node

createLink(Node parent, Node target)

throws RepositoryException;

Creates a new node of type exo:symlink, add it to the parent node and

returns the link node

@param parent: The parent node of the link to create

@param target: The target of the link

@throws RepositoryException: if the link cannot be created for any reason

createLink Node

createLink(Node parent, String linkType, Node target, String linkName)

throws RepositoryException;

Creates a new link, add it to the parent node and returns the link

@param parent: The parent node of the link

@param linkType: The primary node type of the link must be a sub-type of

exo:symlink, the default value is "exo:symlink"

@param target: The target of the link

@param linkName: The name of the link

@return

@throws RepositoryException: if the link cannot be created for any reason

updateLink Node

updateLink(Node link, Node target)

throws RepositoryException;

Updates the target node of the given link

@param link: The link node to update

@param target: The new target of the link

@throws RepositoryException: if the link cannot be updated for any reason

getTarget Node

getTarget(Node link, boolean system) throws ItemNotFoundException,

RepositoryException;

Gets the target node of the given link

@param link: The node of type exo:symlink

@param system: Indicates whether the target node must be retrieved using a

session system or user session in case we cannot use the same

session as the node link because the target and the link are not

in the same workspace

@throws ItemNotFoundException: if the target node cannot be found

@throws RepositoryException: if an unexpected error occurs while retrieving

the target node

getTarget Node

getTarget(Node link)

throws ItemNotFoundException, RepositoryException;

Gets the target node of the given link using the user session

@param link: The node of type exo:symlink

@throws ItemNotFoundException: if the target node cannot be found

@throws RepositoryException: if an unexpected error occurs while retrieving

the target node

isTargetReachable boolean

isTargetReachable(Node link)

throws RepositoryException;

Checks if the target node of the given link can be reached using the user session

@param link: The node of type exo:symlink

@throws RepositoryException: if an unexpected error occurs

isTargetReachable boolean

isTargetReachable(Node link, boolean system)

throws RepositoryException;

Checks if the target node of the given link can be reached using the user session

@param link: The node of type exo:symlink

@param system

@throws RepositoryException if an unexpected error occurs

isLink boolean

isLink(Item item)

throws RepositoryException;

Indicates whether the given item is a link

@param item: the item to test

@return <code>true</code>: if the node is a link, <code>false</code> otherwise

@throws RepositoryException: if an unexpected error occurs

getTargetPrimaryNodeType String

getTargetPrimaryNodeType(Node link)

throws RepositoryException;

Gives the primary node type of the target

@param link: The node of type exo:symlink

@return: the primary node type of the target

@throws RepositoryException: if an unexpected error occurs

getAllLinks List<Node>

getAllLinks(Node targetNode, String linkType, String repoName)

{}throws Exception;

Gives all links of the given node

@param targetNode: The target node to get links

@param linkType: The type of link to get

@param repoName: Name of the repository

@return: the list of link of the target node with given type

@throw Exception

PublicationService to manage the publication

Method Return Prototype Description
addLifecycle void addLifecycle(ComponentPlugin plugin); Add plugins context for the publication service
getLifecycle Lifecycle Lifecycle getLifecycle(String name) ;

Get a specific Lifecycle with the given name

@param name: Name of wanted Lifecycle

getLifecycles List<Lifecycle> List<Lifecycle> getLifecycles(); Get all the Lyfecycle which were added to service instance
getContext Context Context getContext(String name) ; Get a specific context with the given name
getContexts List<Context> List<Context> getContexts(); Get all the context which were added to service instance
getContents List<Node> List<Node> getContents(String fromstate, String tostate, String date, String user, String lang , String workspace) throws Exception;

Get all the node

@param fromstate/tostate: the current range state of node

@param @param user: The last user of node

@param lang: the node's language

@param workspace: the Workspace of node's location

getLifecyclesFromUser List<Lyfecycle> List<Lyfecycle> getLifecyclesFromUser(String remoteUser, String state);

Get all the Lifecycle of a specific user@param remoteUser: current user of publication service

@param state: Current state of the node

This class is used to get contents inside the WCM product. We should not access contents directly from the jcr on the front side.

In generall, this service stands between publication and cache.

Package org.exoplatform.services.wcm.publication.WCMComposer

Method Return Prototype Description
getContent Node

getContent(String repository, String workspace, String nodeIdentifier, HashMap<String, String> filters, SessionProvider sessionProvider)

throws Exception ;

returns content at the specified path based on filters.

repository the repository

workspace the workspace

@param path: the path

@param filters: the filters

@param sessionProvider: the session provider

@return a jcr node

@throws Exception: the exception

getContents List<Node>

getContents(String repository, String workspace, String path, HashMap<String, String> filters, SessionProvider sessionProvider)

throws Exception ;

returns contents at the specified path based on filters.

@param repository: the repository

@param workspace: the workspace

@param path: the path

@param filters: the filters

@param sessionProvider: the session provider

@return a jcr node

@throws Exception: the exception

updateContent boolean

updateContent(String repository, String workspace, String nodeIdentifier, HashMap<String, String> filters)

throws Exception;

Update content.

repository the repository

@param workspace: the workspace

@param path: the path

@param filters: the filters

@return true, if successful

getAllowedStates List<String>

getAllowedStates(String mode)

throws Exception ;

returns allowed states for a specified mode.

@param mode: the mode

@return a jcr node

@throws Exception: the exception

cleanTemplates void

cleanTemplates()

throws Exception ;

initialize the templates hashmap

@throws Exception: the exception

isCached boolean

isCached()

throws Exception;

Check isCache or not

@return the state of cache

@throws Exception: the exception

Package org.exoplatform.services.cms.folksonomy.NewFolksonomyService;

Method Return Prototype Description
addPrivateTag void addPrivateTag(String[] tagsName, Node documentNode, String repository, String workspace, String userName) throws Exception ;

Add a private tag to a document. A folksonomy link will be created in a tag node

@param tagNames: Array of tag name as the children of tree

@param documentNode: Tagging this node by creating a folksonomy link to the node in tag

@param repository: Repository name

@param workspace: Workspace name

@param userName: User name

@throws Exception

addGroupsTag void addGroupsTag(String[] tagsName, Node documentNode,String repository, String workspace, String[] roles) throws Exception ;

Add a group tag to a document. A folksonomy link will be created in a tag node

@param tagNames: Array of tag name as the children of tree

@param documentNode: Tagging this node by creating a folksonomy link to the node in tag

@param repository: Repository name

@param workspace: Workspace name

@param roles: User roles

@throws Exception

addPublicTag void addPublicTag(String treePath, String[] tagsName, Node documentNode, String repository, String workspace) throws Exception ;

Add a public tag to a document. A folksonomy link will be created in a tag node

@param treePath: Path of folksonomy tree

@param tagNames: Array of tag name as the children of tree

@param documentNode: Tagging this node by creating a folksonomy link to the node in tag

@param repository: Repository name

@param workspace: Workspace name

@throws Exception

addSiteTag void addSiteTag(String siteName, String[] tagsName, Node node, String repository, String workspace) throws Exception ;

Add a site tag to a document. A folksonomy link will be created in a tag node

@param siteName: Portal name

@param treePath: Path of folksonomy tree

@param tagNames: Array of tag name as the children of tree

@param documentNode: Tagging this node by creating a folksonomy link to the node in tag

@param repository: Repository name

@param workspace: Workspace name

@throws Exception

getAllPrivateTags List<Node> getAllPrivateTags(String userName, String repository, String workspace) throws Exception ;

Get all private tags

@param userName: User name

@param repository: repository name

@param workspace: Workspace name

@return List<Node>

getAllPublicTags List<Node> getAllPublicTags(String treePath, String repository, String workspace) throws Exception ;

Get all public tags

@param treePath: Folksonomy tree path

@param repository: Repository name

@param workspace: Workspace name

@return List<Node>

@throws Exception

getAllGroupTags List<Node> getAllGroupTags(String[] roles, String repository, String workspace) throws Exception ;

Get all tags by groups

@param roles: Roles of user

@param repository: Repository name

@param workspace: Workspace name

@return List<Node>

@throws Exception

getAllGroupTags List<Node> getAllGroupTags(String role, String repository, String workspace) throws Exception ;

Get all tags by group

@param role: Role of user

@param repository: Repository name

@param workspace: Workspace name

@return List<Node>

@throws Exception

getAllSiteTags List<Node> getAllSiteTags(String siteName, String repository, String workspace) throws Exception ;

Get all tags of Site

@param siteName: Portal name

@param treePath: Folksonomy tree path

@param repository: Repository name

@param workspace: Workspace name

@return List<Node>

@throws Exception

getAllDocumentsByTag List<Node> getAllDocumentsByTag(String tagPath, String repository, String workspace, SessionProvider sessionProvider) throws Exception ;

Get all documents which are stored in a tag

@param treeName: Name of folksonomy tree

@param tagName : Name of tag

@param repository: Repository name

@return: List of documents in tag

@throws Exception

getTagStyle String getTagStyle(String tagPath, String repository, String workspace) throws Exception ;

Get HTMLSTYLEPROP property in styleName node in repository

@param tagPath: Tag path

@param workspace Workspace name

@param repository: Repository name

@return: value of property of styleName node

@throws Exception

addTagStyle void addTagStyle(String styleName, String tagRange, String htmlStyle, String repository, String workspace) throws Exception ;

Update the properties TAGRATEPROP and HTMLSTYLEPROP, following the values tagRate, htmlStyle

for node in tagPath in repository

@param styleName: Style name

@param tagRate: The range of tag numbers

@param htmlStyle: Tag style

@param repository: Repository name

@param workspace: Workspace name

@throws Exception

updateTagStyle void updateTagStyle(String styleName, String tagRange, String htmlStyle, String repository, String workspace) throws Exception ;

Update the properties TAGRATEPROP and HTMLSTYLEPROP, following the value tagRate, htmlStyle

for node in tagPath in repository

@param styleName: Style name

@param tagRate: The range of tag numbers

@param htmlStyle Tag style

@param repository Repository name

@param workspace: Workspace name

@throws Exception

getAllTagStyle List<Node> getAllTagStyle(String repository, String workspace) throws Exception ;

Get all tag style bases of folksonomy tree

@param repository: Repository name

@param workspace: Workspace name

@return List<Node> List tag styles

@throws Exception

init void init(String repository) throws Exception ;

Initialize all TagStylePlugin with session in repository name

@param repository: repository name

removeTagOfDocument void removeTagOfDocument(String tagPath, Node document, String repository, String workspace) throws Exception;

Remove a tag of a given document

@param treeName: Name of folksonomy tree

@param tagName: Name of tag

@param document: Document which is added a link to tagName

@param repository: Repository name

@return

@throws Exception

removeTag void removeTag(String tagPath, String repository, String workspace) throws Exception;

Remove tag

@param tagPath: Path of tag

@param repository: Repository name

@param workspace: Workspace name

modifyTagName Node modifyTagName(String tagPath, String newTagName, String repository, String workspace) throws Exception;

Modify tag name

@param tagPath: Path of tag

@param newTagName: New tag name

@param repository: Repository name

@param workspace Workspace name

@return

@throws Exception

getLinkedTagsOfDocument List<Node> getLinkedTagsOfDocument(Node documentNode, String repository, String workspace) throws Exception;

Get all tags linked to given document

@param documentNode Document node

@param repository: Repository name

@param workspace: Workspace name

@return

@throws Exception

getLinkedTagsOfDocumentByScope List<Node> getLinkedTagsOfDocumentByScope(int scope, String value, Node documentNode, String repository, String workspace) throws Exception;

Get all tags linked to given document by scope

@param documentNode: Document node

@param repository: Repository name

@param workspace Workspace name

@return

@throws Exception

removeTagsOfNodeRecursively void removeTagsOfNodeRecursively(Node node, String repository, String workspace, String username, String groups) throws Exception;

Remove all tags linked to children of given node

@param node

@param repository

@param workspace

@throws Exception

addTagPermission void addTagPermission(String usersOrGroups);

Add given users or groups to tagPermissionList

@param usersOrGroups

removeTagPermission void removeTagPermission(String usersOrGroups);

Remove given users or groups from tagPermissionList

@param usersOrGroups

getTagPermissionList List<String> getTagPermissionList(); Returns tagPermissionList
canEditTag boolean canEditTag(int scope, List<String> memberships);

Set the permission for a user to edit tag.

@param scope: Scope

@param memberships: Memberships

@return true If it is possible

getAllTagNames List<String> getAllTagNames(String repository, String workspace, int scope, String value) throws Exception;

Get all tag names which start within a given scope

@param repository: Repository

@param workspace: Workspace

@param scope: scope of tags

@param value: value, according to scope, can be understood differently

@return true if it is possiblee

This class is used to manage dynamic groovy templates for ecm-based products.

Package org.exoplatform.services.cms.views.ApplicationTemplateManager;

Method Return Prototype Description
addPlugin void

addPlugin(PortletTemplatePlugin portletTemplatePlugin)

throws Exception

Adds the plugin.

portletTemplatePlugin the portlet template plugin

getAllManagedPortletName List<String>

getAllManagedPortletName(String repository)

throws Exception

Retrieve all the portlet names that have dynamic groovy templates managed by service.

repository the repository

@throws Exception the exception

getTemplatesByApplication List<Node>

getTemplatesByApplication(String repository, String portletName, SessionProvider provider)

throws Exception;

Retrieve the templates node by application.

@param repository: the repository

@param portletName: the portlet name

@param provider: the provider

@return the templates by application

@throws Exception: the exception

getTemplatesByCategory List<Node>

getTemplatesByCategory(String repository, String portletName, String category, SessionProvider sessionProvider)

throws Exception;

Retrieve the templates node by category:.

@param repository: the repository

@param portletName: the portlet name

@param category: the category

@param sessionProvider: the session provider

@return the templates by category

@throws Exception: the exception

getTemplateByName Node

getTemplateByName(String repository, String portletName, String category, String templateName, SessionProvider sessionProvider)

throws Exception;

Retrieve the template by name

@param repository: the repository

@param portletName: the portlet name

@param category: the category

@param templateName: the template name

@param sessionProvider: the session provider

@return the template by name

@throws Exception: the exception

getTemplateByPath Node

getTemplateByPath(String repository, String templatePath, SessionProvider sessionProvider)

throws Exception ;

Get the template by path:

@param repository: the repository

@param templatePath: the template path

@param sessionProvider: the session provider

@return the template by path

@throws Exception: the exception

addTemplate void

addTemplate(Node portletTemplateHome, PortletTemplateConfig config)

throws Exception;

Adds the template:

@param portletTemplateHome: the portlet template home

@param config: the config

@throws Exception: the exception

removeTemplate void

removeTemplate(String repository, String portletName, String catgory, String templateName, SessionProvider sessionProvider)

throws Exception;

Remove the template:

@param repository: the repository

@param portletName: the portlet name

@param catgory: the catgory

@param templateName: the template name

@param sessionProvider: the session provider

@throws Exception: the exception

NodeFinder is used to find a node with a given path. If the path to the node contains sub-paths to exo:symlink nodes, find real link node.

Method Return Prototype Desription
getNode Node getNode(Node ancestorNode, String relativePath) throws PathNotFoundException, RepositoryException;

Return the node at relPath related to ancestor node.

@param ancestorNode: The ancestor of the node to retrieve from which we start.

@param relativePath: The relative path of the node to retrieve.

@throws PathNotFoundException: If "no", the node exists at the specified path.

@throws RepositoryException: if another error occurs.

getNode Node getNode(Node ancestorNode, String relativePath, boolean giveTarget) throws PathNotFoundException, RepositoryException;

Return the node at relPath related to ancestor node. If the node is a link and giveTarget has been set to <code>true</code>, the target node will be returned

@param ancestorNode: The ancestor of the node to retrieve from which we start.

@param relativePath: The relative path of the node to retrieve.

@param giveTarget: Indicate if the target must be returned in case the item is a link

@throws PathNotFoundException: If no node exists at the specified path.

@throws RepositoryException: if another error occurs.

getItem Item getItem(String repository, String workspace, String absPath) throws PathNotFoundException, RepositoryException;

Return the item at the specified absolute path.

@param repository: The name of repository

@param workspace: The name of workspace

@param absPath: An absolute path.

@throws PathNotFoundException: if the specified path cannot be found.

@throws RepositoryException: if another error occurs.

getItemSys Item

getItemSys(String repository, String workspace, String absPath, boolean system) throws PathNotFoundException

, RepositoryException;

Return the item at the specified absolute path.

@param repository: The name of repository

@param workspace: The name of workspace

@param absPath: An absolute path.

@throws PathNotFoundException: if the specified path cannot be found.

@throws RepositoryException: if another error occurs.

getItem Item

getItem(String repository, String workspace, String : absPath, boolean giveTarget) throws PathNotFoundException,

RepositoryException;

Return the item at the specified absolute path. If the item is a link and giveTarget has been set to <code>true</code>, the target node will be returned

@param repository: The name of repository

@param workspace: The name of workspace

@param absPath: An absolute path.

@param giveTarget: Indicates if the target must be returned in case the item is a link

@throws PathNotFoundException: if the specified path cannot be found.

@throws RepositoryException: if another error occurs.

getItemGiveTargetSys Item

getItemGiveTargetSys(String

repository, String workspace, String absPath, boolean giveTarget, boolean system) throws PathNotFoundException, RepositoryException;

Return the item at the specified absolute path. If the item is a link and giveTarget has been set to <code>true</code>, the target node will be returned

@param repository: The name of repository

@param workspace: The name of workspace

@param absPath: An absolute path.

@param giveTarget: Indicates if the target must be returned in case the item is a link

@param system: system provider

@throws PathNotFoundException: if the specified path cannot be found.

@throws RepositoryException: if another error occurs.

getItem Item getItem(Session session, String absPath) throws PathNotFoundException, RepositoryException;

Return the item at the specified absolute path.

@param session: The session to use in order to get the item

@param absPath: An absolute path.

@throws PathNotFoundException: if the specified path cannot be found.

@throws RepositoryException: if another error occurs.

getItem Item getItem(Session session, String absPath, boolean giveTarget) throws PathNotFoundException, RepositoryException;

Return the item at the specified absolute path. If the item is a link and giveTarget has been set to <code>true</code>, the target node will be returned

@param session: The session to use in order to get the item

@param absPath: An absolute path.

@param giveTarget: Indicates if the target must be returned in case the item is a link

@throws PathNotFoundException: if the specified path cannot be found.

@throws RepositoryException: if another error occurs.

getItemTarget Item getItemTarget(Session session, String absPath, boolean giveTarget, boolean system) throws PathNotFoundException, RepositoryException;

Return the item at the specified absolute path. If the item is a link and giveTarget has been set to <code>true</code>, the target node will be returned

@param session: The session to use in order to get the item

@param absPath: An absolute path.

@param giveTarget: Indicates if the target must be returned in case the item is a link

@param system: system provider

@throws PathNotFoundException: if the specified path cannot be found.

@throws RepositoryException: if another error occurs.

itemExists boolean itemExists(Session session, String absPath) throws RepositoryException;

Return <code>true</code> if an item exists at absPath; otherwise returns <code>false</code>

Also return <code>false</code> if the specified absPath is malformed.

@param session: The session to use in order to get the item

@param absPath: An absolute path.

@return <code>true</code> if an item exists at absPath; otherwise returns <code>false</code>.

@throws RepositoryException: if an error occurs.

JodConverter is used to convert documents into different office formats.

Package org.exoplatform.services.cms.jodconverter.JodConverterService

Method Return Prototype Desription
convert void convert(InputStream input, String formatInput, OutputStream out, String formatOutput) throws Exception;

Convert InputStream in with formatInput format to OutputStream out with formatOutput

@param input

@param formatInput

@param out

@param formatOutput

@throws Exception