Package org.alfresco.repo.virtual.ref

Class VanillaProtocol

java.lang.Object

org.alfresco.repo.virtual.ref.Protocol

org.alfresco.repo.virtual.ref.VirtualProtocol

org.alfresco.repo.virtual.ref.VanillaProtocol

All Implemented Interfaces:

Serializable

public class VanillaProtocol
extends VirtualProtocol

A VirtualProtocol extension that uses a scripted processor virtual template in order to process a so-called vanilla JSON static template definition on template execution.
Vanilla references store have an extra ResourceParameter for the vanilla-JSON template.

Author:

Bogdan Horje

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	VANILLA_TEMPLATE_PARAM_INDEX

Fields inherited from class org.alfresco.repo.virtual.ref.VirtualProtocol

ACTUAL_NODE_LOCATION_PARAM_INDEX, CLASS_TEMPLATE_PATH_TOKEN, NODE_TEMPLATE_PATH_TOKEN, TEMPLATE_PATH_PARAM_INDEX

Fields inherited from class org.alfresco.repo.virtual.ref.Protocol

DEFAULT_ENCODING, name

Constructor Summary

Constructors

Constructor	Description
VanillaProtocol()

Method Summary

Modifier and Type	Method	Description
<R> R	dispatch(ProtocolMethod<R> method, Reference reference)	ProtocolMethod double-dispatch/visitor protocol type selector.
Resource	getVanillaTemplateResource(Reference reference)
Reference	newReference(String vanillaProcessorClasspath, String templatePath, NodeRef actualNodeRef, String templateSysPath)
Reference	newReference(String vanillaProcessorClasspath, String templatePath, NodeRef actualNodeRef, NodeRef templateRef)
Reference	newReference(Encoding encoding, Resource virtualTemplateResource, String templatePath, Resource actualResource, Resource vanillTemplateResource, List<Parameter> extraParameters)

Methods inherited from class org.alfresco.repo.virtual.ref.VirtualProtocol

createSystemPathResource, getActualNodeLocation, getTemplatePath, newReference, newReference, newReference, newReference, replaceTemplatePath

Methods inherited from class org.alfresco.repo.virtual.ref.Protocol

addParameter, addParameter, getParameter, propagateNodeRefMutations, replaceParameter, replaceParameter, toString

Methods inherited from class java.lang.Object

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

Field Detail

VANILLA_TEMPLATE_PARAM_INDEX

public static final int VANILLA_TEMPLATE_PARAM_INDEX

See Also:

Constant Field Values

Constructor Detail

VanillaProtocol

public VanillaProtocol()

Method Detail

dispatch

public <R> R dispatch(ProtocolMethod<R> method,
                      Reference reference)
               throws ProtocolMethodException

Description copied from class: Protocol

ProtocolMethod double-dispatch/visitor protocol type selector. Subclasses should override this method to select the appropriate type bound method.
This particular implementation calls the default ProtocolMethod.execute(Protocol, Reference) default method implementation.

Overrides:

dispatch in class VirtualProtocol

Returns:

the value returned by the type bond method

Throws:

ProtocolMethodException

newReference

public Reference newReference(String vanillaProcessorClasspath,
                              String templatePath,
                              NodeRef actualNodeRef,
                              NodeRef templateRef)

newReference

public Reference newReference(Encoding encoding,
                              Resource virtualTemplateResource,
                              String templatePath,
                              Resource actualResource,
                              Resource vanillTemplateResource,
                              List<Parameter> extraParameters)

getVanillaTemplateResource

public Resource getVanillaTemplateResource(Reference reference)

newReference

public Reference newReference(String vanillaProcessorClasspath,
                              String templatePath,
                              NodeRef actualNodeRef,
                              String templateSysPath)
                       throws ProtocolMethodException

Throws:

ProtocolMethodException