org.pentaho.platform.repository.solution
Class SolutionRepositoryServiceImpl

java.lang.Object
  org.pentaho.platform.repository.solution.SolutionRepositoryServiceImpl

All Implemented Interfaces:

ISolutionRepositoryService

Direct Known Subclasses:

SolutionRepositoryServiceImplFast

public class SolutionRepositoryServiceImpl
extends java.lang.Object
implements ISolutionRepositoryService

Constructor Summary

SolutionRepositoryServiceImpl()

Method Summary

boolean	createFolder(IPentahoSession userSession, java.lang.String solution, java.lang.String path, java.lang.String name, java.lang.String desc) This method creates a folder along with it's index.xml file.
boolean	delete(IPentahoSession userSession, java.lang.String solution, java.lang.String path, java.lang.String name) This method will delete a file from the ISolutionRepository and respects IPentahoAclEntry.PERM_DELETE.
java.lang.String	getAclXml(java.lang.String solution, java.lang.String path, java.lang.String filename, IPentahoSession userSession) Gets ACLs based on a solution repository file.
org.w3c.dom.Document	getSolutionRepositoryDoc(IPentahoSession session, java.lang.String[] filters)
org.w3c.dom.Document	getSolutionRepositoryFileDetails(IPentahoSession session, java.lang.String fullPath) Returns an XML snippet consisting of a single file element.
void	setAcl(java.lang.String solution, java.lang.String path, java.lang.String filename, java.lang.String strAclXml, IPentahoSession userSession) Sets the ACL Xml for a particular file in the solution repository

Methods inherited from class java.lang.Object

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

Constructor Detail

SolutionRepositoryServiceImpl

public SolutionRepositoryServiceImpl()

Method Detail

delete

public boolean delete(IPentahoSession userSession,
                      java.lang.String solution,
                      java.lang.String path,
                      java.lang.String name)
               throws java.io.IOException

This method will delete a file from the ISolutionRepository and respects IPentahoAclEntry.PERM_DELETE.

Specified by:

delete in interface ISolutionRepositoryService

Parameters:

userSession - An IPentahoSession for the user requesting the delete operation

solution - The name of the solution, such as 'steel-wheels'

path - The path within the solution to the file/folder to be deleted (does not include the file/folder itself)

name - The name of the file or folder which will be deleted in the given solution/path

Returns:

Success of the delete operation is returned

Throws:

java.io.IOException

createFolder

public boolean createFolder(IPentahoSession userSession,
                            java.lang.String solution,
                            java.lang.String path,
                            java.lang.String name,
                            java.lang.String desc)
                     throws java.io.IOException

This method creates a folder along with it's index.xml file. This method also verifies that the user has PERM_CREATE permissions before creating the folder.

Specified by:

createFolder in interface ISolutionRepositoryService

Parameters:

userSession - the current user

solution - the solution path

path - the folder path

name - the name of the new folder

desc - the description of the new folder

Returns:

true if success

Throws:

java.io.IOException

getSolutionRepositoryDoc

public org.w3c.dom.Document getSolutionRepositoryDoc(IPentahoSession session,
                                                     java.lang.String[] filters)
                                              throws javax.xml.parsers.ParserConfigurationException

Specified by:

getSolutionRepositoryDoc in interface ISolutionRepositoryService

Throws:

javax.xml.parsers.ParserConfigurationException

getSolutionRepositoryFileDetails

public org.w3c.dom.Document getSolutionRepositoryFileDetails(IPentahoSession session,
                                                             java.lang.String fullPath)
                                                      throws javax.xml.parsers.ParserConfigurationException

Returns an XML snippet consisting of a single file element. The file element is the same as would have been returned by getSolutionRepositoryDoc.

Specified by:

getSolutionRepositoryFileDetails in interface ISolutionRepositoryService

Parameters:

session - current session

Returns:

doc

Throws:

javax.xml.parsers.ParserConfigurationException

setAcl

public void setAcl(java.lang.String solution,
                   java.lang.String path,
                   java.lang.String filename,
                   java.lang.String strAclXml,
                   IPentahoSession userSession)
            throws SolutionRepositoryServiceException,
                   java.io.IOException,
                   PentahoAccessControlException

Sets the ACL Xml for a particular file in the solution repository

Specified by:

setAcl in interface ISolutionRepositoryService

Parameters:

solution -

path -

filename -

strAclXml -

userSession -

Throws:

SolutionRepositoryServiceException

java.io.IOException

PentahoAccessControlException

getAclXml

public java.lang.String getAclXml(java.lang.String solution,
                                  java.lang.String path,
                                  java.lang.String filename,
                                  IPentahoSession userSession)
                           throws SolutionRepositoryServiceException,
                                  java.io.IOException

Gets ACLs based on a solution repository file.

Specified by:

getAclXml in interface ISolutionRepositoryService

Parameters:

userSession -

Returns:

acl xml

Throws:

SolutionRepositoryServiceException

java.io.IOException