SlingBindings (Apache Sling 8 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<String,Object>
  - - org.apache.sling.api.scripting.SlingBindings

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>
```
public class SlingBindings
extends HashMap<String,Object>
```
The SlingBindings class is used to prepare global variables for script execution. The constants in this class define names of variables which MUST or MAY be provided for the script execution. Other variables may be define as callers see fit.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FLUSH` The name of the global scripting variable indicating whether the output used by the script should be flushed after the script evaluation ended normally (value is "flush").
`static String`	`LOG` The name of the global scripting variable providing a logger which may be used for logging purposes (value is "log").
`static String`	`OUT` The name of the global scripting variable providing the `java.io.PrintWriter` object to return the response content (value is "out").
`static String`	`READER` The name of the global scripting variable providing the `Reader` object (value is "reader").
`static String`	`REQUEST` The name of the global scripting variable providing the `SlingHttpServletRequest` object (value is "request").
`static String`	`RESOURCE` The name of the global scripting variable providing the `Resource` object (value is "resource").
`static String`	`RESPONSE` The name of the global scripting variable providing the `SlingHttpServletResponse` object (value is "response").
`static String`	`SLING` The name of the global scripting variable providing the `SlingScriptHelper` for the request (value is "sling").

Constructor Summary

Constructors
Constructor and Description

SlingBindings()

Constructors
Constructor and Description
`SlingBindings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected <ObjectType> ObjectType`	`get(String key, Class<ObjectType> type)` Helper method to get an object with a given type from this map.
`boolean`	`getFlush()` Returns the `FLUSH` property if not `null` and a `boolean`.
`org.slf4j.Logger`	`getLog()` Returns the `LOG` property if not `null` and a `org.slf4j.Logger` instance.
`PrintWriter`	`getOut()` Returns the `OUT` property if not `null` and a `PrintWriter` instance.
`Reader`	`getReader()` Returns the `READER` property if not `null` and a `Reader` instance.
`SlingHttpServletRequest`	`getRequest()` Returns the `REQUEST` property if not `null` and a `SlingHttpServletRequest` instance.
`Resource`	`getResource()` Returns the `RESOURCE` property if not `null` and a `Resource` instance.
`SlingHttpServletResponse`	`getResponse()` Returns the `RESPONSE` property if not `null` and a `SlingHttpServletResponse` instance.
`SlingScriptHelper`	`getSling()` Returns the `SLING` property if not `null` and a `SlingScriptHelper` instance.
`protected void`	`safePut(String key, Object value)` Helper method which invokes `HashMap.put(Object, Object)` only if the value is not null.
`void`	`setFlush(boolean flush)` Sets the `FLUSH` property to `flush`.
`void`	`setLog(org.slf4j.Logger log)` Sets the `LOG` property to `log` if not `null`.
`void`	`setOut(PrintWriter out)` Sets the `OUT` property to `out` if not `null`.
`void`	`setReader(Reader reader)` Sets the `READER` property to `reader` if not `null`.
`void`	`setRequest(SlingHttpServletRequest request)` Sets the `REQUEST` property to `request` if not `null`.
`void`	`setResource(Resource resource)` Sets the `RESOURCE` property to `resource` if not `null`.
`void`	`setResponse(SlingHttpServletResponse response)` Sets the `RESPONSE` property to `response` if not `null`.
`void`	`setSling(SlingScriptHelper sling)` Sets the `SLING` property to `sling` if not `null`.

Methods inherited from class java.util.HashMap
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

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

Methods inherited from interface java.util.Map
equals, hashCode

- Field Detail
  - REQUEST
```
public static final String REQUEST
```
    The name of the global scripting variable providing the SlingHttpServletRequest object (value is "request"). The value of the scripting variable is the same as that returned by the SlingScriptHelper.getRequest() method.
    This bound variable is required in the bindings given the script.
    
    See Also:
    
    Constant Field Values
  - RESPONSE
```
public static final String RESPONSE
```
    The name of the global scripting variable providing the SlingHttpServletResponse object (value is "response"). The value of the scripting variable is the same as that returned by the SlingScriptHelper.getResponse() method.
    This bound variable is required in the bindings given the script.
    
    See Also:
    
    Constant Field Values
  - READER
```
public static final String READER
```
    The name of the global scripting variable providing the Reader object (value is "reader").
    This bound variable is required in the bindings given the script.
    
    See Also:
    
    Constant Field Values
  - SLING
```
public static final String SLING
```
    The name of the global scripting variable providing the SlingScriptHelper for the request (value is "sling").
    This bound variable is optional. If existing, the script helper instance must be bound to the same request and response objects as bound with the REQUEST and RESPONSE variables. If this variable is not bound, the script implementation will create it before actually evaluating the script.
    
    See Also:
    
    Constant Field Values
  - RESOURCE
```
public static final String RESOURCE
```
    The name of the global scripting variable providing the Resource object (value is "resource"). The value of the scripting variable is the same as that returned by the SlingScriptHelper.getRequest().getResource() method.
    This bound variable is optional. If existing, the resource must be bound to the same resource as returned by the SlingHttpServletRequest.getResource() method. If this variable is not bound, the script implementation will bind it before actually evaluating the script.
    
    See Also:
    
    Constant Field Values
  - OUT
```
public static final String OUT
```
    The name of the global scripting variable providing the java.io.PrintWriter object to return the response content (value is "out"). The value of the scripting variable is the same as that returned by the SlingScriptHelper.getResponse().getWriter() method.
    Note, that it may be advisable to implement a lazy acquiring writer for the out variable to enable the script to write binary data to the response output stream instead of the writer.
    This bound variable is optional. If existing, the resource must be bound to the same writer as returned by the SlingHttpServletResponse.getWriter() method of the response object bound to the RESPONSE variable. If this variable is not bound, the script implementation will bind it before actually evaluating the script.
    
    See Also:
    
    Constant Field Values
  - FLUSH
```
public static final String FLUSH
```
    The name of the global scripting variable indicating whether the output used by the script should be flushed after the script evaluation ended normally (value is "flush").
    The type of this variable is java.lang.Boolean indicating whether to flush the output (value is TRUE) or not (value is FALSE). If the variable has a non-null value of another type, the output is not flush as if the value would be FALSE.
    
    See Also:
    
    Constant Field Values
  - LOG
```
public static final String LOG
```
    The name of the global scripting variable providing a logger which may be used for logging purposes (value is "log"). The logger provides the API defined by the SLF4J org.slf4j.Logger interface.
    This bound variable is optional. If this variable is not bound, the script implementation will bind it before actually evaluating the script.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SlingBindings
```
public SlingBindings()
```
- Method Detail
  - get
```
protected <ObjectType> ObjectType get(String key,
                                      Class<ObjectType> type)
```
    Helper method to get an object with a given type from this map.
    
    Returns:
    
    The searched object if it has the specified type, otherwise null is returned.
  - safePut
```
protected void safePut(String key,
                       Object value)
```
    Helper method which invokes HashMap.put(Object, Object) only if the value is not null.
  - setFlush
```
public void setFlush(boolean flush)
```
    Sets the FLUSH property to flush.
  - getFlush
```
public boolean getFlush()
```
    Returns the FLUSH property if not null and a boolean. Otherwise false is returned.
  - setLog
```
public void setLog(org.slf4j.Logger log)
```
    Sets the LOG property to log if not null.
  - getLog
```
@CheckForNull
public org.slf4j.Logger getLog()
```
    Returns the LOG property if not null and a org.slf4j.Logger instance. Otherwise null is returned.
  - setOut
```
public void setOut(PrintWriter out)
```
    Sets the OUT property to out if not null.
  - getOut
```
@CheckForNull
public PrintWriter getOut()
```
    Returns the OUT property if not null and a PrintWriter instance. Otherwise null is returned.
  - setRequest
```
public void setRequest(SlingHttpServletRequest request)
```
    Sets the REQUEST property to request if not null.
  - getRequest
```
@CheckForNull
public SlingHttpServletRequest getRequest()
```
    Returns the REQUEST property if not null and a SlingHttpServletRequest instance. Otherwise null is returned.
  - setReader
```
public void setReader(Reader reader)
```
    Sets the READER property to reader if not null.
  - getReader
```
@CheckForNull
public Reader getReader()
```
    Returns the READER property if not null and a Reader instance. Otherwise null is returned.
  - setResource
```
public void setResource(Resource resource)
```
    Sets the RESOURCE property to resource if not null.
  - getResource
```
@CheckForNull
public Resource getResource()
```
    Returns the RESOURCE property if not null and a Resource instance. Otherwise null is returned.
  - setResponse
```
public void setResponse(SlingHttpServletResponse response)
```
    Sets the RESPONSE property to response if not null.
  - getResponse
```
@CheckForNull
public SlingHttpServletResponse getResponse()
```
    Returns the RESPONSE property if not null and a SlingHttpServletResponse instance. Otherwise null is returned.
  - setSling
```
public void setSling(SlingScriptHelper sling)
```
    Sets the SLING property to sling if not null.
  - getSling
```
@CheckForNull
public SlingScriptHelper getSling()
```
    Returns the SLING property if not null and a SlingScriptHelper instance. Otherwise null is returned.

Class SlingBindings

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

REQUEST

RESPONSE

READER

SLING

RESOURCE

OUT

FLUSH

LOG

Constructor Detail

SlingBindings

Method Detail

get

safePut

setFlush

getFlush

setLog

getLog

setOut

getOut

setRequest

getRequest

setReader

getReader

setResource

getResource

setResponse

getResponse

setSling

getSling