org.apache.sling.feature.io.json

Class FeatureJSONReader

java.lang.Object

org.apache.sling.feature.io.json.FeatureJSONReader

public class FeatureJSONReader
extends Object

This class offers a method to read a Feature using a Reader instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FeatureJSONReader.SubstituteVariables

Field Summary

Fields

Modifier and Type	Field and Description
protected String	exceptionPrefix Exception prefix containing the location (if set)
protected String	location The optional location.

Method Summary

Modifier and Type	Method and Description
protected List<org.apache.sling.feature.Configuration>	addConfigurations(Map<String,Object> map, org.apache.sling.feature.Artifact artifact, org.apache.sling.feature.Configurations container)
protected void	checkType(String key, Object val, Class<?>... types) Check if the value is one of the provided types
protected Map<String,Object>	getJsonMap(javax.json.JsonObject json) Get the JSON object as a map, removing all comments that start with a '#' character
protected String	getProperty(Map<String,Object> map, String key)
protected Object	handleLaunchVars(Object val) Substitutes variables that need to be substituted at launch time.
protected Object	handleResolveVars(Object val) Substitutes variables that need to be specified before the resolver executes.
protected String	minify(Reader reader)
static org.apache.sling.feature.Feature	read(Reader reader, org.apache.sling.feature.ArtifactId providedId, String location, FeatureJSONReader.SubstituteVariables phase) Read a new feature from the reader The reader is not closed.
static org.apache.sling.feature.Feature	read(Reader reader, String location, FeatureJSONReader.SubstituteVariables phase) Read a new feature from the reader The reader is not closed.
protected void	readArtifacts(String section, String artifactType, List<org.apache.sling.feature.Artifact> artifacts, Object listObj, org.apache.sling.feature.Configurations container)
protected void	readBundles(Map<String,Object> map, org.apache.sling.feature.Bundles container, org.apache.sling.feature.Configurations configContainer) Read the bundles / start levels section
protected void	readConfigurations(Map<String,Object> map, org.apache.sling.feature.Configurations container)
protected void	readExtensions(Map<String,Object> map, List<String> keywords, org.apache.sling.feature.Extensions container, org.apache.sling.feature.Configurations configContainer)
protected void	readFrameworkProperties(Map<String,Object> map, org.apache.sling.feature.KeyValueMap container)

Methods inherited from class java.lang.Object

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

Field Detail

location

protected final String location

The optional location.

exceptionPrefix

protected final String exceptionPrefix

Exception prefix containing the location (if set)

Method Detail

read

public static org.apache.sling.feature.Feature read(Reader reader,
                                                    String location,
                                                    FeatureJSONReader.SubstituteVariables phase)
                                             throws IOException

Read a new feature from the reader The reader is not closed. It is up to the caller to close the reader.

Parameters:

reader - The reader for the feature

location - Optional location

phase - If variables need to be substituted, the phase the this should be done for.

Returns:

The read feature

Throws:

IOException - If an IO errors occurs or the JSON is invalid.

read

public static org.apache.sling.feature.Feature read(Reader reader,
                                                    org.apache.sling.feature.ArtifactId providedId,
                                                    String location,
                                                    FeatureJSONReader.SubstituteVariables phase)
                                             throws IOException

Read a new feature from the reader The reader is not closed. It is up to the caller to close the reader.

Parameters:

reader - The reader for the feature

providedId - Optional artifact id

location - Optional location

phase - If variables need to be substituted, the phase the this should be done for.

Returns:

The read feature

Throws:

IOException - If an IO errors occurs or the JSON is invalid.

handleResolveVars

protected Object handleResolveVars(Object val)

Substitutes variables that need to be specified before the resolver executes. These are variables in features, artifacts (such as bundles), requirements and capabilities.

Parameters:

val - The value that may contain a variable.

Returns:

The value with the variable substitiuted.

handleLaunchVars

protected Object handleLaunchVars(Object val)

Substitutes variables that need to be substituted at launch time. These are all variables that are not needed by the resolver.

Parameters:

val - The value that may contain a variable.

Returns:

The value with the variable substitiuted.

minify

protected String minify(Reader reader)
                 throws IOException

Throws:

IOException

getJsonMap

protected Map<String,Object> getJsonMap(javax.json.JsonObject json)

Get the JSON object as a map, removing all comments that start with a '#' character

Parameters:

json - The JSON object to process

Returns:

A map representing the JSON object.

getProperty

protected String getProperty(Map<String,Object> map,
                             String key)
                      throws IOException

Throws:

IOException

readBundles

protected void readBundles(Map<String,Object> map,
                           org.apache.sling.feature.Bundles container,
                           org.apache.sling.feature.Configurations configContainer)
                    throws IOException

Read the bundles / start levels section

Parameters:

map - The map describing the feature

container - The bundles container

configContainer - The configurations container

Throws:

IOException - If the json is invalid.

readArtifacts

protected void readArtifacts(String section,
                             String artifactType,
                             List<org.apache.sling.feature.Artifact> artifacts,
                             Object listObj,
                             org.apache.sling.feature.Configurations container)
                      throws IOException

Throws:

IOException

addConfigurations

protected List<org.apache.sling.feature.Configuration> addConfigurations(Map<String,Object> map,
                                                                         org.apache.sling.feature.Artifact artifact,
                                                                         org.apache.sling.feature.Configurations container)
                                                                  throws IOException

Throws:

IOException

readConfigurations

protected void readConfigurations(Map<String,Object> map,
                                  org.apache.sling.feature.Configurations container)
                           throws IOException

Throws:

IOException

readFrameworkProperties

protected void readFrameworkProperties(Map<String,Object> map,
                                       org.apache.sling.feature.KeyValueMap container)
                                throws IOException

Throws:

IOException

readExtensions

protected void readExtensions(Map<String,Object> map,
                              List<String> keywords,
                              org.apache.sling.feature.Extensions container,
                              org.apache.sling.feature.Configurations configContainer)
                       throws IOException

Throws:

IOException

checkType

protected void checkType(String key,
                         Object val,
                         Class<?>... types)
                  throws IOException

Check if the value is one of the provided types

Parameters:

key - A key for the error message

val - The value to check

types - The allowed types

Throws:

IOException - If the val is not of the specified types