org.pageseeder.bridge.control

Class DocumentManager

java.lang.Object

org.pageseeder.bridge.control.DocumentManager

public final class DocumentManager
extends Object

A manager for documents and folders (based on PageSeeder URIs).

Since:

0.2.0

Version:

0.8.2

Author:

Philip Rutherford, Christophe Lauret

Field Summary

Fields

Modifier and Type	Field and Description
protected PSSession	_session The user connecting to the server.

Constructor Summary

Constructors

Constructor and Description
DocumentManager(PSSession user) Creates a new manager for PageSeeder groups.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	create(PSDocument document, PSGroup group, PSMember creator) Create the specified document in PageSeeder.
boolean	create(PSDocument document, PSGroup group, PSMember creator, Map<String,String> parameters) Create the specified document in PageSeeder passing the specified template parameters.
boolean	editDocumentProperties(PSDocument document, PSGroup group, PSMember creator) Edit the properties for specified document in PageSeeder.
static PSEntityCache<PSDocument>	getCache()
void	getContent(Long uri, org.xml.sax.helpers.DefaultHandler handler) Write the content of the specified document onto the XML writer.
void	getContent(Long uri, org.pageseeder.xmlwriter.XMLWriter xml) Write the content of the specified document onto the XML writer.
void	getContent(String docid, org.xml.sax.helpers.DefaultHandler handler) Write the content of the specified document onto the XML writer.
void	getContent(String docid, org.pageseeder.xmlwriter.XMLWriter xml) Write the content of the specified document onto the XML writer.
PSDocument	getDocument(long id, PSGroup group) Identify a document from a specific URI ID.
PSDocument	getDocument(String url, PSGroup group) Identify a document from a specified URL.
PSFolder	getFolder(String url, PSGroup group) Identify a document from a specified URL.
static PSEntityCache<PSFolder>	getFoldersCache()
PSMLFragment	getFragment(PSDocument document, PSGroup group, PSMember editor, String fragment) Create the specified document in PageSeeder.
List<PSDocument>	listDocuments(PSGroup group) List the documents in the specified group in PageSeeder at the top level (maximum returned 200).
List<PSDocument>	listDocuments(PSGroup group, String folder, int max) List the documents in the specified group in PageSeeder under a folder.
List<PSDocument>	listDocumentsForURL(PSGroup group, String url, int max) List the documents in the specified group in PageSeeder under a parent URL.
List<PSFolder>	listFolders(PSGroup group, String folder, int max) List the folders in the specified group in PageSeeder under a folder.
List<PSFolder>	listFoldersForURL(PSGroup group, String url, int max) List the folders in the specified group in PageSeeder under a parent URL.
PSMLFragment	postFragment(PSDocument document, PSGroup group, PSMember editor, PSMLFragment fragment) Deprecated. Use putFragment(PSDocument, PSGroup, PSMember, PSMLFragment) instead.
PSMLFragment	putFragment(PSDocument document, PSGroup group, PSMember editor, PSMLFragment fragment) Edit the specified fragment in PageSeeder by using PUT method.
PSSession	session()
PSDocument	upload(PSGroup group, String url, File file) Uploads a file on the server at the specified URL.
PSDocument	upload(PSGroup group, String url, InputStream in, String filename) Uploads a file on the server at the specified URL.

Methods inherited from class java.lang.Object

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

Field Detail

_session

protected final PSSession _session

The user connecting to the server.

Constructor Detail

DocumentManager

public DocumentManager(PSSession user)

Creates a new manager for PageSeeder groups.

Parameters:

user - The user that can connect to PageSeeder.

Method Detail

create

public boolean create(PSDocument document,
             PSGroup group,
             PSMember creator)
               throws APIException

Create the specified document in PageSeeder.

Parameters:

document - The document to create

group - The group the document is part of

creator - The member creating the document

Returns:

true if the document was created.

Throws:

APIException

create

public boolean create(PSDocument document,
             PSGroup group,
             PSMember creator,
             Map<String,String> parameters)
               throws APIException

Create the specified document in PageSeeder passing the specified template parameters.

Parameters:

document - The document to create

group - The group the document is part of

creator - The member creating the document

parameters - The parameters for the PSML template

Returns:

true if the document was created.

Throws:

APIException

editDocumentProperties

public boolean editDocumentProperties(PSDocument document,
                             PSGroup group,
                             PSMember creator)
                               throws APIException

Edit the properties for specified document in PageSeeder.

Parameters:

document - The document to create

group - The group the document is part of

creator - The member creating the document

Returns:

true if the document properties was edit.

Throws:

APIException

getDocument

public PSDocument getDocument(long id,
                     PSGroup group)
                       throws APIException

Identify a document from a specific URI ID.

Parameters:

id - The URI ID of the document.

group - The group the document is accessible from.

Throws:

APIException

getDocument

public PSDocument getDocument(String url,
                     PSGroup group)
                       throws APIException

Identify a document from a specified URL.

Parameters:

url - The URL

group - The group the document is accessible from.

Returns:

the corresponding document

Throws:

APIException

getFolder

public PSFolder getFolder(String url,
                 PSGroup group)
                   throws APIException

Identify a document from a specified URL.

Parameters:

url - The URL

group - The group the folder is part of

Returns:

the corresponding folder

Throws:

APIException

listDocuments

public List<PSDocument> listDocuments(PSGroup group)
                               throws APIException

List the documents in the specified group in PageSeeder at the top level (maximum returned 200).

Parameters:

group - The group instance.

Returns:

the documents

Throws:

APIException

listDocuments

public List<PSDocument> listDocuments(PSGroup group,
                             String folder,
                             int max)
                               throws APIException

List the documents in the specified group in PageSeeder under a folder.

Parameters:

group - the group

folder - the relative folder path (e.g. documents/myfolder)

max - the maximum number of return documents.

Returns:

the documents/folders.

Throws:

APIException

listFolders

public List<PSFolder> listFolders(PSGroup group,
                         String folder,
                         int max)
                           throws APIException

List the folders in the specified group in PageSeeder under a folder.

Parameters:

group - the group

folder - the relative folder path (e.g. documents/myfolder)

max - the maximum number of return documents.

Returns:

the folders.

Throws:

APIException

listDocumentsForURL

public List<PSDocument> listDocumentsForURL(PSGroup group,
                                   String url,
                                   int max)
                                     throws APIException

List the documents in the specified group in PageSeeder under a parent URL.

Parameters:

group - the group

url - the parent URL

max - the maximum number of return documents.

Returns:

the documents/folders.

Throws:

APIException

listFoldersForURL

public List<PSFolder> listFoldersForURL(PSGroup group,
                               String url,
                               int max)
                                 throws APIException

List the folders in the specified group in PageSeeder under a parent URL.

Parameters:

group - the group

url - the parent URL

max - the maximum number of return documents.

Returns:

the documents/folders.

Throws:

APIException

upload

public PSDocument upload(PSGroup group,
                String url,
                File file)
                  throws APIException

Uploads a file on the server at the specified URL.

Parameters:

group - The group the file should be uploaded to

url - The URL of the folder receiving the file

file - The file to upload

Returns:

The uploaded document.

Throws:

APIException

upload

public PSDocument upload(PSGroup group,
                String url,
                InputStream in,
                String filename)
                  throws APIException

Uploads a file on the server at the specified URL.

Parameters:

group - The group the file should be uploaded to

url - The URL of the folder receiving the file

in - The input stream for file content

filename - The filename for the file

Returns:

The uploaded document.

Throws:

APIException

getFragment

public PSMLFragment getFragment(PSDocument document,
                       PSGroup group,
                       PSMember editor,
                       String fragment)
                         throws APIException

Create the specified document in PageSeeder.

Parameters:

document - The document to create

group - The group the document is part of

editor - The member editing the document

fragment - The fragment ID

Returns:

the corresponding fragment.

Throws:

APIException

putFragment

public PSMLFragment putFragment(PSDocument document,
                       PSGroup group,
                       PSMember editor,
                       PSMLFragment fragment)
                         throws APIException

Edit the specified fragment in PageSeeder by using PUT method.

Parameters:

document - The document to create

group - The group the document is part of

editor - The member editing the document

fragment - The fragment to edit

Returns:

the updated fragment.

Throws:

APIException

postFragment

@Deprecated
public PSMLFragment postFragment(PSDocument document,
                                   PSGroup group,
                                   PSMember editor,
                                   PSMLFragment fragment)
                          throws APIException

Deprecated. Use putFragment(PSDocument, PSGroup, PSMember, PSMLFragment) instead.

Edit the specified fragment in PageSeeder by using POST method.

Parameters:

document - The document to create

group - The group the document is part of

editor - The member editing the document

fragment - The fragment to edit

Returns:

the updated fragment.

Throws:

APIException

getContent

public void getContent(Long uri,
              org.pageseeder.xmlwriter.XMLWriter xml)
                throws APIException

Write the content of the specified document onto the XML writer.

Parameters:

uri - The URI ID of the document.

xml - The XML to write the content

Throws:

APIException

getContent

public void getContent(Long uri,
              org.xml.sax.helpers.DefaultHandler handler)
                throws APIException

Write the content of the specified document onto the XML writer.

Parameters:

uri - The URI ID to find

handler - The handler to handle the content

Throws:

APIException

getContent

public void getContent(String docid,
              org.pageseeder.xmlwriter.XMLWriter xml)
                throws APIException

Write the content of the specified document onto the XML writer.

Parameters:

docid - The document ID to find

xml - The XML to write the content

Throws:

APIException

getContent

public void getContent(String docid,
              org.xml.sax.helpers.DefaultHandler handler)
                throws APIException

Write the content of the specified document onto the XML writer.

Parameters:

docid - The document ID to find

handler - The handler to handle the content

Throws:

APIException

getCache

public static PSEntityCache<PSDocument> getCache()

Returns:

the internal cache used for the groups.

getFoldersCache

public static PSEntityCache<PSFolder> getFoldersCache()

Returns:

the internal cache used for the group folders.

session

public PSSession session()

Returns:

the session used by the class.