public class ADMRemoteStore extends BaseRemoteStore
This implementation of the RemoteStore is tied to the current SiteService implementation.
It remaps incoming generic document path requests to the appropriate folder structure in the Sites folder. Dashboard pages and component bindings are remapped to take advantage of inherited permissions in the appropriate root site folder, ensuring that only valid users can write to the appropriate configuration objects.
for the available API methods.
Modifier and Type | Field and Description |
---|---|
protected org.alfresco.service.cmr.repository.ContentService |
contentService |
protected org.alfresco.service.cmr.model.FileFolderService |
fileFolderService |
protected org.alfresco.repo.model.filefolder.HiddenAspect |
hiddenAspect |
protected org.alfresco.service.namespace.NamespaceService |
namespaceService |
protected org.alfresco.service.cmr.repository.NodeService |
nodeService |
protected org.alfresco.service.cmr.site.SiteService |
siteService |
protected org.alfresco.service.cmr.repository.NodeService |
unprotNodeService |
defaultStore, mimetypeService, REQUEST_PARAM_STORE, REQUEST_PARAM_WEBAPP, TOKEN_STORE, TOKEN_WEBAPP, transformer, TRANSFORMER_FACTORY
Constructor and Description |
---|
ADMRemoteStore() |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
buildUserConfigSearchPattern(java.lang.String userName)
Generate the search pattern for a Surf config location for a user name.
|
protected void |
createDocument(org.springframework.extensions.webscripts.WebScriptResponse res,
java.lang.String store,
java.lang.String path,
java.io.InputStream content)
Creates a document.
|
protected void |
createDocuments(org.springframework.extensions.webscripts.WebScriptResponse res,
java.lang.String store,
java.io.InputStream in)
Creates multiple XML documents encapsulated in a single one.
|
protected void |
deleteDocument(org.springframework.extensions.webscripts.WebScriptResponse res,
java.lang.String store,
java.lang.String path)
Deletes an existing document.
|
protected void |
getDocument(org.springframework.extensions.webscripts.WebScriptResponse res,
java.lang.String store,
java.lang.String path)
Gets a document.
|
protected org.alfresco.query.PagingResults |
getFileNodes(org.alfresco.service.cmr.model.FileInfo fileInfo,
java.lang.String pattern,
boolean recurse) |
protected org.alfresco.service.cmr.repository.NodeRef |
getGlobalComponentsNodeRef() |
protected org.alfresco.service.cmr.repository.NodeRef |
getGlobalUserFolderNodeRef() |
protected java.lang.String |
getPathRunAsUser(java.lang.String path)
Get the RunAs user need to execute a Write operation on the given path.
|
protected org.alfresco.service.cmr.repository.NodeRef |
getSurfConfigNodeRef(org.alfresco.service.cmr.repository.NodeRef rootRef,
boolean create)
Return the "surf-config" noderef under the given root.
|
protected void |
hasDocument(org.springframework.extensions.webscripts.WebScriptResponse res,
java.lang.String store,
java.lang.String path)
Determines if the document exists.
|
protected void |
lastModified(org.springframework.extensions.webscripts.WebScriptResponse res,
java.lang.String store,
java.lang.String path)
Gets the last modified timestamp for the document.
|
protected void |
listDocuments(org.springframework.extensions.webscripts.WebScriptResponse res,
java.lang.String store,
java.lang.String path,
boolean recurse)
Lists the document paths under a given path.
|
protected void |
listDocuments(org.springframework.extensions.webscripts.WebScriptResponse res,
java.lang.String store,
java.lang.String path,
java.lang.String pattern)
Lists the document paths matching a file pattern under a given path.
|
void |
setBehaviourFilter(org.alfresco.repo.policy.BehaviourFilter behaviourFilter) |
void |
setContentService(org.alfresco.service.cmr.repository.ContentService contentService) |
void |
setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService) |
void |
setHiddenAspect(org.alfresco.repo.model.filefolder.HiddenAspect hiddenAspect) |
void |
setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService) |
void |
setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) |
void |
setSiteService(org.alfresco.service.cmr.site.SiteService siteService) |
void |
setUnprotectedNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) |
protected void |
updateDocument(org.springframework.extensions.webscripts.WebScriptResponse res,
java.lang.String store,
java.lang.String path,
java.io.InputStream content)
Updates an existing document.
|
protected void |
writeDocument(java.lang.String path,
java.io.InputStream content) |
encodePath, execute, getPathParts, setMimetypeService, setStore
addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString
protected org.alfresco.service.cmr.repository.NodeService nodeService
protected org.alfresco.service.cmr.repository.NodeService unprotNodeService
protected org.alfresco.service.cmr.model.FileFolderService fileFolderService
protected org.alfresco.service.namespace.NamespaceService namespaceService
protected org.alfresco.service.cmr.site.SiteService siteService
protected org.alfresco.service.cmr.repository.ContentService contentService
protected org.alfresco.repo.model.filefolder.HiddenAspect hiddenAspect
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
nodeService
- the NodeService to setpublic void setUnprotectedNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
nodeService
- the NodeService to setpublic void setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)
fileFolderService
- the FileFolderService to setpublic void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
namespaceService
- the NamespaceService to setpublic void setSiteService(org.alfresco.service.cmr.site.SiteService siteService)
siteService
- the SiteService to setpublic void setContentService(org.alfresco.service.cmr.repository.ContentService contentService)
contentService
- the ContentService to setpublic void setHiddenAspect(org.alfresco.repo.model.filefolder.HiddenAspect hiddenAspect)
public void setBehaviourFilter(org.alfresco.repo.policy.BehaviourFilter behaviourFilter)
protected void lastModified(org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String store, java.lang.String path) throws java.io.IOException
The output will be the last modified date as a long toString().
lastModified
in class BaseRemoteStore
path
- document path to an existing documentstore
- the store idjava.io.IOException
protected void getDocument(org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String store, java.lang.String path)
The output will be the document content stream.
getDocument
in class BaseRemoteStore
path
- document pathstore
- the store idprotected void hasDocument(org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String store, java.lang.String path) throws java.io.IOException
hasDocument
in class BaseRemoteStore
path
- document pathstore
- the store idjava.io.IOException
protected void createDocument(org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String store, java.lang.String path, java.io.InputStream content)
Create methods are user authenticated, so the creation of site config must be allowed for the current user.
createDocument
in class BaseRemoteStore
path
- document pathcontent
- content of the document to writestore
- the store idprotected void createDocuments(org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String store, java.io.InputStream in)
createDocuments
in class BaseRemoteStore
content
- XML document containing multiple document contents to writeprotected void writeDocument(java.lang.String path, java.io.InputStream content)
protected java.lang.String getPathRunAsUser(java.lang.String path)
path
- Document pathprotected void updateDocument(org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String store, java.lang.String path, java.io.InputStream content)
Update methods are user authenticated, so the modification of site config must be allowed for the current user.
updateDocument
in class BaseRemoteStore
path
- document path to updatecontent
- content to update the document withstore
- the store idprotected void deleteDocument(org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String store, java.lang.String path)
Delete methods are user authenticated, so the deletion of the document must be allowed for the current user.
deleteDocument
in class BaseRemoteStore
path
- document pathstore
- the store idprotected void listDocuments(org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String store, java.lang.String path, boolean recurse) throws java.io.IOException
The output will be the list of relative document paths found under the path. Separated by newline characters.
listDocuments
in class BaseRemoteStore
path
- document pathrecurse
- true to peform a recursive list, false for direct children only.store
- the store idjava.io.IOException
- if an error occurs listing the documentsprotected void listDocuments(org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String store, java.lang.String path, java.lang.String pattern) throws java.io.IOException
listDocuments
in class BaseRemoteStore
path
- document pathpattern
- file pattern to match - allows wildcards e.g. page.*.site.xmlstore
- the store idjava.io.IOException
- if an error occurs listing the documentsprotected org.alfresco.service.cmr.repository.NodeRef getSurfConfigNodeRef(org.alfresco.service.cmr.repository.NodeRef rootRef, boolean create)
Adds the "isIndexed = false" property to the surf-config folder node.
rootRef
- Root node reference where the "surf-config" folder should livecreate
- True to create the folder if missing, false otherwiseprotected org.alfresco.service.cmr.repository.NodeRef getGlobalComponentsNodeRef()
protected org.alfresco.service.cmr.repository.NodeRef getGlobalUserFolderNodeRef()
protected java.lang.String buildUserConfigSearchPattern(java.lang.String userName)
userName
- to build pattern forprotected org.alfresco.query.PagingResults getFileNodes(org.alfresco.service.cmr.model.FileInfo fileInfo, java.lang.String pattern, boolean recurse)
Copyright © 2005 - 2013 Alfresco Software, Inc. All Rights Reserved.