Resource (Jahia Server Implementation 8.0.0.0 API)

java.lang.Object
- org.jahia.services.render.Resource

```
public class Resource
extends Object
```
A resource is the aggregation of a node and a specific template It's something that can be handled by the render engine to be displayed.

Author:

toto

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Resource.Option
Deprecated.

Nested Classes
Modifier and Type	Class and Description
`class`	`Resource.Option` Deprecated.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONFIGURATION_GWT`
`static String`	`CONFIGURATION_INCLUDE`
`static String`	`CONFIGURATION_MODULE`
`static String`	`CONFIGURATION_PAGE`
`static String`	`CONFIGURATION_WRAPPEDCONTENT`
`static String`	`CONFIGURATION_WRAPPER`

Constructor Summary

Constructors
Constructor and Description
`Resource(JCRNodeWrapper node, String templateType, String template, String contextConfiguration)` Creates a resource from the specified parameter
`Resource(String path, String canonicalPath, JCRSessionWrapper sessionWrapper, String templateType, String template, String contextConfiguration)` Lazy resource, that take the path instead of a node, the node will be load at first getNode() call using sessionWrapper

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addOption(String wrapper, ExtendedNodeType nodeType)` Deprecated. not used anymore
`boolean`	`equals(Object o)`
`String`	`getContextConfiguration()`
`Set<String>`	`getDependencies()`
`Locale`	`getLocale()`
`List<String>`	`getMissingResources()`
`Map<String,Serializable>`	`getModuleParams()`
`JCRNodeWrapper`	`getNode()` Get the node associated to the current resource, in case of a lazy resource the node will be load from jcr if it's null This function shouldn't not be call before the CacheFilter to avoid loading of node from JCR.
`String`	`getNodePath()`
`List<Resource.Option>`	`getOptions()` Deprecated. not used anymore
`String`	`getPath()`
`Set<String>`	`getRegexpDependencies()`
`String`	`getResolvedTemplate()`
`ExtendedNodeType`	`getResourceNodeType()`
`Script`	`getScript(RenderContext context)` Get the script for the current resource, if the script is null and renderContext is provide as parameter we try do the resolution of the script, then store it in the current resource, so it's available for the rest of the render chain.
`String`	`getTemplate()`
`String`	`getTemplateType()`
`String`	`getWorkspace()`
`int`	`hashCode()`
`boolean`	`hasOptions()` Deprecated. not used anymore
`boolean`	`hasWrapper()`
`boolean`	`hasWrapper(String wrapper)`
`boolean`	`isNodeLoaded()` Know if the JCR Node is available immediately, since the node may require lazy loading from JCR
`String`	`popWrapper()`
`String`	`pushWrapper(String wrapper)`
`void`	`removeOption(ExtendedNodeType mixinNodeType)` Deprecated. not used anymore
`JCRNodeWrapper`	`safeLoadNode()` get the associate Node, but set the flag for lazy load to "It's ok to load the node from JCR if necessary" To avoid warning message about performance.
`void`	`setContextConfiguration(String contextConfiguration)`
`void`	`setNode(JCRNodeWrapper node)`
`void`	`setResourceNodeType(ExtendedNodeType resourceNodeType)`
`void`	`setTemplate(String template)`
`void`	`setTemplateType(String templateType)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CONFIGURATION_PAGE
```
public static final String CONFIGURATION_PAGE
```
    See Also:
    
    Constant Field Values
  - CONFIGURATION_GWT
```
public static final String CONFIGURATION_GWT
```
    See Also:
    
    Constant Field Values
  - CONFIGURATION_MODULE
```
public static final String CONFIGURATION_MODULE
```
    See Also:
    
    Constant Field Values
  - CONFIGURATION_INCLUDE
```
public static final String CONFIGURATION_INCLUDE
```
    See Also:
    
    Constant Field Values
  - CONFIGURATION_WRAPPER
```
public static final String CONFIGURATION_WRAPPER
```
    See Also:
    
    Constant Field Values
  - CONFIGURATION_WRAPPEDCONTENT
```
public static final String CONFIGURATION_WRAPPEDCONTENT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Resource
```
public Resource(JCRNodeWrapper node,
                String templateType,
                String template,
                String contextConfiguration)
```
    Creates a resource from the specified parameter
    
    Parameters:
    
    node - The node to display
    
    templateType - template type
    
    template -
    
    contextConfiguration -
  - Resource
```
public Resource(String path,
                String canonicalPath,
                JCRSessionWrapper sessionWrapper,
                String templateType,
                String template,
                String contextConfiguration)
```
    Lazy resource, that take the path instead of a node, the node will be load at first getNode() call using sessionWrapper
    
    Parameters:
    
    path - The path to the node to display
    
    canonicalPath - If the path is a dereference path canonicalPath contains the reference absolute path, empty if not
    
    sessionWrapper - The session that will be used to load the node
    
    templateType - template type
    
    template -
    
    contextConfiguration -
- Method Detail
  - getNode
```
public JCRNodeWrapper getNode()
```
    Get the node associated to the current resource, in case of a lazy resource the node will be load from jcr if it's null This function shouldn't not be call before the CacheFilter to avoid loading of node from JCR. Since CacheFilter is executed for each fragments now even if there are in cache. If the node is needed it should be requested after the CacheFilter or for cache key generation during aggregation
    
    Returns:
    
    The JCR Node if found, null if not
  - safeLoadNode
```
public JCRNodeWrapper safeLoadNode()
```
    get the associate Node, but set the flag for lazy load to "It's ok to load the node from JCR if necessary" To avoid warning message about performance. This function should be use ONLY after Cache Filter or for key generation.
    
    Returns:
    
    The JCR Node if found, null if not
  - isNodeLoaded
```
public boolean isNodeLoaded()
```
    Know if the JCR Node is available immediately, since the node may require lazy loading from JCR
    
    Returns:
    
    true if JCR Node is available immediately
  - setNode
```
public void setNode(JCRNodeWrapper node)
```
  - getTemplateType
```
public String getTemplateType()
```
  - setTemplateType
```
public void setTemplateType(String templateType)
```
  - getWorkspace
```
public String getWorkspace()
```
  - getLocale
```
public Locale getLocale()
```
  - setTemplate
```
public void setTemplate(String template)
```
  - getContextConfiguration
```
public String getContextConfiguration()
```
  - getResolvedTemplate
```
public String getResolvedTemplate()
```
  - getTemplate
```
public String getTemplate()
```
  - getDependencies
```
public Set<String> getDependencies()
```
  - getRegexpDependencies
```
public Set<String> getRegexpDependencies()
```
  - getMissingResources
```
public List<String> getMissingResources()
```
  - getModuleParams
```
public Map<String,Serializable> getModuleParams()
```
  - hasWrapper
```
public boolean hasWrapper()
```
  - hasWrapper
```
public boolean hasWrapper(String wrapper)
```
  - popWrapper
```
public String popWrapper()
```
  - pushWrapper
```
public String pushWrapper(String wrapper)
```
  - getPath
```
public String getPath()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - addOption
```
@Deprecated
public void addOption(String wrapper,
                                  ExtendedNodeType nodeType)
```
    Deprecated. not used anymore
  - getOptions
```
@Deprecated
public List<Resource.Option> getOptions()
```
    Deprecated. not used anymore
  - hasOptions
```
@Deprecated
public boolean hasOptions()
```
    Deprecated. not used anymore
  - removeOption
```
@Deprecated
public void removeOption(ExtendedNodeType mixinNodeType)
```
    Deprecated. not used anymore
  - getResourceNodeType
```
public ExtendedNodeType getResourceNodeType()
```
  - setContextConfiguration
```
public void setContextConfiguration(String contextConfiguration)
```
  - getScript
```
public Script getScript(RenderContext context)
                 throws javax.jcr.RepositoryException
```
    Get the script for the current resource, if the script is null and renderContext is provide as parameter we try do the resolution of the script, then store it in the current resource, so it's available for the rest of the render chain.
    
    Parameters:
    
    context - renderContext, needed to resolve the script
    
    Returns:
    
    the Script if one is found, null if not
    
    Throws:
    
    javax.jcr.RepositoryException
  - getNodePath
```
public String getNodePath()
```
  - setResourceNodeType
```
public void setResourceNodeType(ExtendedNodeType resourceNodeType)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Resource

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONFIGURATION_PAGE

CONFIGURATION_GWT

CONFIGURATION_MODULE

CONFIGURATION_INCLUDE

CONFIGURATION_WRAPPER

CONFIGURATION_WRAPPEDCONTENT

Constructor Detail

Resource

Resource

Method Detail

getNode

safeLoadNode

isNodeLoaded

setNode

getTemplateType

setTemplateType

getWorkspace

getLocale

setTemplate

getContextConfiguration

getResolvedTemplate

getTemplate

getDependencies

getRegexpDependencies

getMissingResources

getModuleParams

hasWrapper

hasWrapper

popWrapper

pushWrapper

getPath

toString

addOption

getOptions

hasOptions

removeOption

getResourceNodeType

setContextConfiguration

getScript

getNodePath

setResourceNodeType

equals

hashCode