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 voidclear()Clear the object and reset to defaultsjakarta.json.JsonObjectBuildercreateJson()Convert this object into JSONvoidfromJSONObject(jakarta.json.JsonObject jsonObj)Extract the metadata from the JSON object.org.osgi.framework.VersionRange[]getAllowedVersionRanges()The allowed version rangesorg.apache.sling.feature.ArtifactIdgetArtifactId()Get the artifact idorg.osgi.framework.VersionRange[]getDeniedVersionRanges()Get the denied version rangesStringgetMessage()The validation messageModegetMode()Get the validation mode.booleanisAllowed(org.osgi.framework.Version artifactVersion)Check if a version is allowed according to the rulesvoidsetAllowedVersionRanges(org.osgi.framework.VersionRange[] allowedVersions)Set the allowed version rangesvoidsetArtifactId(org.apache.sling.feature.ArtifactId artifactId)Set the artifact idvoidsetDeniedVersionRanges(org.osgi.framework.VersionRange[] deniedVersions)Set the denied version rangesvoidsetMessage(String message)Set the validation messagevoidsetMode(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:
clearin classAttributeableEntity
-
createJson
public jakarta.json.JsonObjectBuilder createJson() throws IOExceptionConvert this object into JSON- Overrides:
createJsonin classAttributeableEntity- Returns:
- The json object builder
- Throws:
IOException- If generating the JSON fails
-
fromJSONObject
public void fromJSONObject(jakarta.json.JsonObject jsonObj) throws IOExceptionExtract the metadata from the JSON object. This method first callsclear().- Overrides:
fromJSONObjectin 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:
trueif it is allowed,falseotherwise
-
-