Package org.alfresco.repo.rendition
Class RenditionServiceImpl
- java.lang.Object
-
- org.alfresco.repo.rendition.RenditionServiceImpl
-
- All Implemented Interfaces:
CheckOutCheckInServicePolicies.BeforeCheckOut,LockServicePolicies.BeforeLock,ClassPolicy,Policy,RenditionDefinitionPersister,RenditionService
@Deprecated public class RenditionServiceImpl extends java.lang.Object implements RenditionService, RenditionDefinitionPersister, CheckOutCheckInServicePolicies.BeforeCheckOut, LockServicePolicies.BeforeLock
Deprecated.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.alfresco.repo.policy.Policy
Policy.Arg
-
-
Field Summary
-
Fields inherited from interface org.alfresco.repo.coci.CheckOutCheckInServicePolicies.BeforeCheckOut
QNAME
-
Fields inherited from interface org.alfresco.repo.lock.LockServicePolicies.BeforeLock
QNAME
-
Fields inherited from interface org.alfresco.service.cmr.rendition.RenditionService
PARAM_DESTINATION_NODE, PARAM_DESTINATION_PATH_TEMPLATE, PARAM_IS_COMPONENT_RENDITION, PARAM_ORPHAN_EXISTING_RENDITION, PARAM_RENDITION_NODETYPE
-
-
Constructor Summary
Constructors Constructor Description RenditionServiceImpl()Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidbeforeCheckOut(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef destinationParentNodeRef, org.alfresco.service.namespace.QName destinationAssocTypeQName, org.alfresco.service.namespace.QName destinationAssocQName)Deprecated.voidbeforeLock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType)Deprecated.Called before an attempt to lock the given node is made.voidcancelRenditions(org.alfresco.service.cmr.repository.NodeRef sourceNode)Deprecated.Cancels all known cancellable running renditions for the givenNodeRefvia theActionTrackingService.voidcancelRenditions(org.alfresco.service.cmr.repository.NodeRef sourceNode, java.lang.String type)Deprecated.Cancels all known cancellable running renditions for the givenNodeRefand type via theActionTrackingService.CompositeRenditionDefinitioncreateCompositeRenditionDefinition(org.alfresco.service.namespace.QName renditionName)Deprecated.Creates a newCompositeRenditionDefinitionand sets the rendition name and the rendering engine name to the specified values.RenditionDefinitioncreateRenditionDefinition(org.alfresco.service.namespace.QName renditionDefinitionName, java.lang.String renderingEngineName)Deprecated.Creates a newRenditionDefinitionand sets the rendition name and the rendering engine name to the specified values.RenderingEngineDefinitiongetRenderingEngineDefinition(java.lang.String name)Deprecated.Returns theRenderingEngineDefinitionassociated with the specified rendering engine name.java.util.List<RenderingEngineDefinition>getRenderingEngineDefinitions()Deprecated.org.alfresco.service.cmr.repository.ChildAssociationRefgetRenditionByName(org.alfresco.service.cmr.repository.NodeRef node, org.alfresco.service.namespace.QName renditionName)Deprecated.This method gets the rendition of the specified node identified by the provided rendition name.java.util.List<org.alfresco.service.cmr.repository.ChildAssociationRef>getRenditions(org.alfresco.service.cmr.repository.NodeRef node)Deprecated.This method gets all the renditions of the specified node.java.util.List<org.alfresco.service.cmr.repository.ChildAssociationRef>getRenditions(org.alfresco.service.cmr.repository.NodeRef node, java.lang.String mimeTypePrefix)Deprecated.This method gets all the renditions of the specified node filtered by MIME-type prefix.org.alfresco.service.cmr.repository.ChildAssociationRefgetSourceNode(org.alfresco.service.cmr.repository.NodeRef renditionNode)Deprecated.This method gets the source node for the specified rendition node.voidinit()Deprecated.booleanisRendition(org.alfresco.service.cmr.repository.NodeRef node)Deprecated.This method returnstrueif the specified NodeRef is a valid rendition node, elsefalse.RenditionDefinitionloadRenditionDefinition(org.alfresco.service.namespace.QName renditionDefinitionName)Deprecated.This method retrieves aRenditionDefinitionthat has been stored in the repository using thesave()method.java.util.List<RenditionDefinition>loadRenditionDefinitions()Deprecated.This method retrieves theRenditionDefinitions that have been stored in the repository using thesave()method.java.util.List<RenditionDefinition>loadRenditionDefinitions(java.lang.String renditionEngineName)Deprecated.This method retrieves the storedRenditionDefinitions that have been registered for the specified rendering engine name.org.alfresco.service.cmr.repository.ChildAssociationRefrender(org.alfresco.service.cmr.repository.NodeRef sourceNode, RenditionDefinition definition)Deprecated.This method synchronously renders content as specified by the givenRenditionDefinition.voidrender(org.alfresco.service.cmr.repository.NodeRef sourceNode, RenditionDefinition definition, RenderCallback callback)Deprecated.This method asynchronously renders content as specified by the givenRenditionDefinition.org.alfresco.service.cmr.repository.ChildAssociationRefrender(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.namespace.QName renditionDefinitionQName)Deprecated.This method synchronously renders content as specified by the givenrendition name.voidrender(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.namespace.QName renditionDefinitionQName, RenderCallback callback)Deprecated.This method asynchronously renders content as specified by the givenrendition definition name.voidsaveRenditionDefinition(RenditionDefinition renderingAction)Deprecated.This method serializes theRenditionDefinitionand stores it in the repository.voidsetActionService(ActionService actionService)Deprecated.Injects the ActionService bean.voidsetActionTrackingService(ActionTrackingService actionTrackingService)Deprecated.Injects the ActionTrackingService bean.voidsetDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)Deprecated.Injects the DictionaryService bean.voidsetKnownCancellableActionTypes(java.util.List<java.lang.String> knownCancellableActionTypes)Deprecated.Sets the list of known cancellable actions used bycancelRenditions(NodeRef).voidsetPolicyComponent(PolicyComponent policyComponent)Deprecated.Injects the PolicyComponent bean.voidsetRenditionDefinitionPersister(RenditionDefinitionPersister renditionDefinitionPersister)Deprecated.Injects the RenditionDefinitionPersister bean.voidsetRenditionPreventionRegistry(RenditionPreventionRegistry registry)Deprecated.voidsetRenditionService2(RenditionService2Impl renditionService2)Deprecated.voidsetServiceRegistry(ServiceRegistry serviceRegistry)Deprecated.Injects the ServiceRegistry bean.booleanusingRenditionService2(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, RenditionDefinition rendDefn)Deprecated.If a rendition has been created by the newer RenditionService2, this method will return true.
-
-
-
Method Detail
-
setRenditionDefinitionPersister
public void setRenditionDefinitionPersister(RenditionDefinitionPersister renditionDefinitionPersister)
Deprecated.Injects the RenditionDefinitionPersister bean.- Parameters:
renditionDefinitionPersister- RenditionDefinitionPersister
-
setRenditionPreventionRegistry
public void setRenditionPreventionRegistry(RenditionPreventionRegistry registry)
Deprecated.- Since:
- 4.0.1
-
setServiceRegistry
public void setServiceRegistry(ServiceRegistry serviceRegistry)
Deprecated.Injects the ServiceRegistry bean.- Parameters:
serviceRegistry- ServiceRegistry
-
setActionService
public void setActionService(ActionService actionService)
Deprecated.Injects the ActionService bean.- Parameters:
actionService- ActionService
-
setActionTrackingService
public void setActionTrackingService(ActionTrackingService actionTrackingService)
Deprecated.Injects the ActionTrackingService bean.- Parameters:
actionTrackingService- ActionTrackingService
-
setDictionaryService
public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
Deprecated.Injects the DictionaryService bean.- Parameters:
dictionaryService- DictionaryService
-
setPolicyComponent
public void setPolicyComponent(PolicyComponent policyComponent)
Deprecated.Injects the PolicyComponent bean.- Parameters:
policyComponent- PolicyComponent
-
setKnownCancellableActionTypes
public void setKnownCancellableActionTypes(java.util.List<java.lang.String> knownCancellableActionTypes)
Deprecated.Sets the list of known cancellable actions used bycancelRenditions(NodeRef).- Since:
- 4.1.6
-
setRenditionService2
public void setRenditionService2(RenditionService2Impl renditionService2)
Deprecated.
-
init
public void init()
Deprecated.
-
getRenderingEngineDefinition
public RenderingEngineDefinition getRenderingEngineDefinition(java.lang.String name)
Deprecated.Description copied from interface:RenditionServiceReturns theRenderingEngineDefinitionassociated with the specified rendering engine name.- Specified by:
getRenderingEngineDefinitionin interfaceRenditionService- Parameters:
name- The rendering engine name.- Returns:
- The
RenderingEngineDefinitionor null.
-
getRenderingEngineDefinitions
public java.util.List<RenderingEngineDefinition> getRenderingEngineDefinitions()
Deprecated.- Specified by:
getRenderingEngineDefinitionsin interfaceRenditionService- Returns:
- A
Listof all availableRenderingEngineDefinitions.
-
createRenditionDefinition
public RenditionDefinition createRenditionDefinition(org.alfresco.service.namespace.QName renditionDefinitionName, java.lang.String renderingEngineName)
Deprecated.Description copied from interface:RenditionServiceCreates a newRenditionDefinitionand sets the rendition name and the rendering engine name to the specified values.- Specified by:
createRenditionDefinitionin interfaceRenditionService- Parameters:
renditionDefinitionName- A unique identifier used to specify the createdRenditionDefinition.renderingEngineName- The name of the rendering engine associated with thisRenditionDefinition.- Returns:
- the created
RenditionDefinition.
-
createCompositeRenditionDefinition
public CompositeRenditionDefinition createCompositeRenditionDefinition(org.alfresco.service.namespace.QName renditionName)
Deprecated.Description copied from interface:RenditionServiceCreates a newCompositeRenditionDefinitionand sets the rendition name and the rendering engine name to the specified values.- Specified by:
createCompositeRenditionDefinitionin interfaceRenditionService- Parameters:
renditionName- A unique identifier used to specify the createdRenditionDefinition.- Returns:
- the created
CompositeRenditionDefinition.
-
render
public org.alfresco.service.cmr.repository.ChildAssociationRef render(org.alfresco.service.cmr.repository.NodeRef sourceNode, RenditionDefinition definition)Deprecated.Description copied from interface:RenditionServiceThis method synchronously renders content as specified by the givenRenditionDefinition. The content to be rendered is provided by the specified source node.- Specified by:
renderin interfaceRenditionService- Parameters:
sourceNode- the node from which the content is retrieved.definition- this fully specifies the rendition which is to be performed.- Returns:
- a child association reference which is the link from the source node to the newly rendered content.
-
render
public void render(org.alfresco.service.cmr.repository.NodeRef sourceNode, RenditionDefinition definition, RenderCallback callback)Deprecated.Description copied from interface:RenditionServiceThis method asynchronously renders content as specified by the givenRenditionDefinition. The content to be rendered is provided by the specified source node.- Specified by:
renderin interfaceRenditionService- Parameters:
sourceNode- the node from which the content is retrieved.definition- this fully specifies the rendition which is to be performed.callback- a callback object to handle the ultimate result of the rendition.
-
render
public org.alfresco.service.cmr.repository.ChildAssociationRef render(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.namespace.QName renditionDefinitionQName)Deprecated.Description copied from interface:RenditionServiceThis method synchronously renders content as specified by the givenrendition name. The content to be rendered is provided by the specified source node. The Rendition Definition will be loaded from the standard location as system thus allowing rendition definitions to be used even when the Data Dictionary has restricted read access.- Specified by:
renderin interfaceRenditionService- Parameters:
sourceNode- the node from which the content is retrieved.renditionDefinitionQName- the rendition definition which is to be performed.- Returns:
- a child association reference which is the link from the source node to the newly rendered content.
-
render
public void render(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.namespace.QName renditionDefinitionQName, RenderCallback callback)Deprecated.Description copied from interface:RenditionServiceThis method asynchronously renders content as specified by the givenrendition definition name. The content to be rendered is provided by the specified source node. The Rendition Definition will be loaded from the standard location as system thus allowing rendition definitions to be used even when the Data Dictionary has restricted read access.- Specified by:
renderin interfaceRenditionService- Parameters:
sourceNode- the node from which the content is retrieved.renditionDefinitionQName- the rendition definition which is to be performed.callback- a callback object to handle the ultimate result of the rendition.
-
saveRenditionDefinition
public void saveRenditionDefinition(RenditionDefinition renderingAction)
Deprecated.Description copied from interface:RenditionDefinitionPersisterThis method serializes theRenditionDefinitionand stores it in the repository.RenditionDefinitions saved in this way may be retrieved using theload()method.- Specified by:
saveRenditionDefinitionin interfaceRenditionDefinitionPersister- Parameters:
renderingAction- TheRenditionDefinitionto be persisted.
-
loadRenditionDefinition
public RenditionDefinition loadRenditionDefinition(org.alfresco.service.namespace.QName renditionDefinitionName)
Deprecated.Description copied from interface:RenditionDefinitionPersisterThis method retrieves aRenditionDefinitionthat has been stored in the repository using thesave()method. If noRenditionDefinitionexists in the repository with the specified rendition name then this method returns null.- Specified by:
loadRenditionDefinitionin interfaceRenditionDefinitionPersister- Parameters:
renditionDefinitionName- The unique identifier used to specify theRenditionDefinitionto retrieve.- Returns:
- The specified
RenditionDefinitionor null.
-
loadRenditionDefinitions
public java.util.List<RenditionDefinition> loadRenditionDefinitions()
Deprecated.Description copied from interface:RenditionDefinitionPersisterThis method retrieves theRenditionDefinitions that have been stored in the repository using thesave()method. If there are no suchRenditionDefinitions, an empty list is returned.- Specified by:
loadRenditionDefinitionsin interfaceRenditionDefinitionPersister- Returns:
- The
RenditionDefinitions.
-
loadRenditionDefinitions
public java.util.List<RenditionDefinition> loadRenditionDefinitions(java.lang.String renditionEngineName)
Deprecated.Description copied from interface:RenditionDefinitionPersisterThis method retrieves the storedRenditionDefinitions that have been registered for the specified rendering engine name. If there are no such renderingRenditionDefinitions, an empty list is returned.- Specified by:
loadRenditionDefinitionsin interfaceRenditionDefinitionPersister- Parameters:
renditionEngineName- the name of a rendering engine. This is usually the spring bean name.- Returns:
- The
RenditionDefinitions. - See Also:
RenditionDefinitionPersister.saveRenditionDefinition(RenditionDefinition)
-
getRenditions
public java.util.List<org.alfresco.service.cmr.repository.ChildAssociationRef> getRenditions(org.alfresco.service.cmr.repository.NodeRef node)
Deprecated.Description copied from interface:RenditionServiceThis method gets all the renditions of the specified node.- Specified by:
getRenditionsin interfaceRenditionService- Returns:
- a list of ChildAssociationRefs which link the source node to the renditions.
-
getRenditions
public java.util.List<org.alfresco.service.cmr.repository.ChildAssociationRef> getRenditions(org.alfresco.service.cmr.repository.NodeRef node, java.lang.String mimeTypePrefix)Deprecated.Description copied from interface:RenditionServiceThis method gets all the renditions of the specified node filtered by MIME-type prefix. Renditions whose MIME-type string startsWith the prefix will be returned.- Specified by:
getRenditionsin interfaceRenditionService- Parameters:
node- the source node for the renditionsmimeTypePrefix- a prefix to check against the rendition MIME-types. This must not be null and must not be an empty String- Returns:
- a list of ChildAssociationRefs which link the source node to the filtered renditions.
-
getRenditionByName
public org.alfresco.service.cmr.repository.ChildAssociationRef getRenditionByName(org.alfresco.service.cmr.repository.NodeRef node, org.alfresco.service.namespace.QName renditionName)Deprecated.Description copied from interface:RenditionServiceThis method gets the rendition of the specified node identified by the provided rendition name.- Specified by:
getRenditionByNamein interfaceRenditionService- Parameters:
node- the source node for the renditionsrenditionName- the renditionName used to identify a rendition.- Returns:
- the ChildAssociationRef which links the source node to the
rendition or
nullif there is no such rendition.
-
isRendition
public boolean isRendition(org.alfresco.service.cmr.repository.NodeRef node)
Deprecated.Description copied from interface:RenditionServiceThis method returnstrueif the specified NodeRef is a valid rendition node, elsefalse. A nodeRef is a rendition node if it has the rn:rendition aspect (or sub-aspect) applied.- Specified by:
isRenditionin interfaceRenditionService- Parameters:
node- NodeRef- Returns:
trueif a rendition, elsefalse
-
getSourceNode
public org.alfresco.service.cmr.repository.ChildAssociationRef getSourceNode(org.alfresco.service.cmr.repository.NodeRef renditionNode)
Deprecated.Description copied from interface:RenditionServiceThis method gets the source node for the specified rendition node. There should only be one source node for any given rendition node.- Specified by:
getSourceNodein interfaceRenditionService- Parameters:
renditionNode- the nodeRef holding the rendition.- Returns:
- the ChildAssociationRef whose parentNodeRef is the source node, or
nullif there is no source node. - See Also:
RenditionService.isRendition(NodeRef)
-
cancelRenditions
public void cancelRenditions(org.alfresco.service.cmr.repository.NodeRef sourceNode)
Deprecated.Description copied from interface:RenditionServiceCancels all known cancellable running renditions for the givenNodeRefvia theActionTrackingService.- Specified by:
cancelRenditionsin interfaceRenditionService- Parameters:
sourceNode- theNodeRefthe action is acting on
-
cancelRenditions
public void cancelRenditions(org.alfresco.service.cmr.repository.NodeRef sourceNode, java.lang.String type)Deprecated.Description copied from interface:RenditionServiceCancels all known cancellable running renditions for the givenNodeRefand type via theActionTrackingService.- Specified by:
cancelRenditionsin interfaceRenditionService- Parameters:
sourceNode- theNodeRefthe action is acting ontype- the rendition type (rending engine name)
-
beforeCheckOut
public void beforeCheckOut(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef destinationParentNodeRef, org.alfresco.service.namespace.QName destinationAssocTypeQName, org.alfresco.service.namespace.QName destinationAssocQName)Deprecated.- Specified by:
beforeCheckOutin interfaceCheckOutCheckInServicePolicies.BeforeCheckOut- Parameters:
nodeRef- NodeRefdestinationParentNodeRef- NodeRefdestinationAssocTypeQName- QNamedestinationAssocQName- QName
-
beforeLock
public void beforeLock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType)Deprecated.Description copied from interface:LockServicePolicies.BeforeLockCalled before an attempt to lock the given node is made.- Specified by:
beforeLockin interfaceLockServicePolicies.BeforeLock- Parameters:
nodeRef- NodeReflockType- LockType
-
usingRenditionService2
public boolean usingRenditionService2(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, RenditionDefinition rendDefn)Deprecated.Description copied from interface:RenditionServiceIf a rendition has been created by the newer RenditionService2, this method will return true. In this case the original RenditionService should not be used to update an existing rendition if the content changes. These renditions can be identified by the existence of the rendition2 aspect. RenditionService2 also listens for content changes and will perform the rendition. If RenditionService2 has a definition with the same name (matched on the local part of the supplied rendDef's name) and the target mimetype matches, RenditionService2 will also be used. This is being done to help with the conversion of custom transformers and renditions. The basic definitions (called "medium", "doclib", "imgpreview", "avatar", "avatar32", "webpreview", "pdf") already exist. Rather than writing a converter form one definition to the newer one, it is suggested that a newer RenditionDefinition2 is simply defined to avoid having to worry about any complexities in converting TransformationOptions into a simple flat Map structure.- Specified by:
usingRenditionService2in interfaceRenditionService
-
-