Class VersionRule
- java.lang.Object
-
- org.apache.sling.feature.extension.apiregions.api.config.AttributeableEntity
-
- org.apache.sling.feature.extension.apiregions.api.artifacts.VersionRule
-
public class VersionRule extends AttributeableEntity
A rule to validate the version of an artifact. This class is not thread safe.
-
-
Constructor Summary
Constructors Constructor Description VersionRule()
Create a new rules object
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Clear the object and reset to defaultsjakarta.json.JsonObjectBuilder
createJson()
Convert this object into JSONvoid
fromJSONObject(jakarta.json.JsonObject jsonObj)
Extract the metadata from the JSON object.org.osgi.framework.VersionRange[]
getAllowedVersionRanges()
The allowed version rangesorg.apache.sling.feature.ArtifactId
getArtifactId()
Get the artifact idorg.osgi.framework.VersionRange[]
getDeniedVersionRanges()
Get the denied version rangesString
getMessage()
The validation messageMode
getMode()
Get the validation mode.boolean
isAllowed(org.osgi.framework.Version artifactVersion)
Check if a version is allowed according to the rulesvoid
setAllowedVersionRanges(org.osgi.framework.VersionRange[] allowedVersions)
Set the allowed version rangesvoid
setArtifactId(org.apache.sling.feature.ArtifactId artifactId)
Set the artifact idvoid
setDeniedVersionRanges(org.osgi.framework.VersionRange[] deniedVersions)
Set the denied version rangesvoid
setMessage(String message)
Set the validation messagevoid
setMode(Mode value)
Set the validation mode-
Methods inherited from class org.apache.sling.feature.extension.apiregions.api.config.AttributeableEntity
getAttributes, getBoolean, getInteger, getNumber, getString, getString, getStringArray, setDefaults, setString, setStringArray, toJSONObject
-
-
-
-
Method Detail
-
clear
public void clear()
Clear the object and reset to defaults- Overrides:
clear
in classAttributeableEntity
-
createJson
public jakarta.json.JsonObjectBuilder createJson() throws IOException
Convert this object into JSON- Overrides:
createJson
in classAttributeableEntity
- Returns:
- The json object builder
- Throws:
IOException
- If generating the JSON fails
-
fromJSONObject
public void fromJSONObject(jakarta.json.JsonObject jsonObj) throws IOException
Extract the metadata from the JSON object. This method first callsclear()
.- Overrides:
fromJSONObject
in classAttributeableEntity
- Parameters:
jsonObj
- The JSON Object- Throws:
IOException
- If JSON parsing fails
-
getMode
public Mode getMode()
Get the validation mode. The default isMode.STRICT
- Returns:
- The mode
-
setMode
public void setMode(Mode value)
Set the validation mode- Parameters:
value
- The validation mode
-
getArtifactId
public org.apache.sling.feature.ArtifactId getArtifactId()
Get the artifact id- Returns:
- the artifactId
-
setArtifactId
public void setArtifactId(org.apache.sling.feature.ArtifactId artifactId)
Set the artifact id- Parameters:
artifactId
- the artifactId to set
-
getMessage
public String getMessage()
The validation message- Returns:
- the message
-
setMessage
public void setMessage(String message)
Set the validation message- Parameters:
message
- the message to set
-
getAllowedVersionRanges
public org.osgi.framework.VersionRange[] getAllowedVersionRanges()
The allowed version ranges- Returns:
- the allowedVersions or
null
-
setAllowedVersionRanges
public void setAllowedVersionRanges(org.osgi.framework.VersionRange[] allowedVersions)
Set the allowed version ranges- Parameters:
allowedVersions
- the allowedVersions to set
-
getDeniedVersionRanges
public org.osgi.framework.VersionRange[] getDeniedVersionRanges()
Get the denied version ranges- Returns:
- the deniedVersions or
null
-
setDeniedVersionRanges
public void setDeniedVersionRanges(org.osgi.framework.VersionRange[] deniedVersions)
Set the denied version ranges- Parameters:
deniedVersions
- the deniedVersions to set
-
isAllowed
public boolean isAllowed(org.osgi.framework.Version artifactVersion)
Check if a version is allowed according to the rules- Parameters:
artifactVersion
- The version- Returns:
true
if it is allowed,false
otherwise
-
-