us.springett.parsers.cpe

Class Cpe

java.lang.Object

us.springett.parsers.cpe.Cpe

All Implemented Interfaces:

Serializable, Comparable, ICpe

public class Cpe
extends Object
implements ICpe, Serializable

Object representation of a Common Platform Enumeration (CPE).

Author:

Jeremy Long

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Cpe(Part part, String vendor, String product, String version, String update, String edition, String language, String swEdition, String targetSw, String targetHw, String other) Constructs a new immutable CPE object that represents the Well Form Named defined in the CPE 2.3 specification.

Method Summary

Modifier and Type	Method and Description
static Relation	compareAttribute(Part left, Part right)
static Relation	compareAttribute(String left, String right)
protected static boolean	compareAttributes(Part left, Part right) This does not follow the spec precisely because ANY compared to NA is classified as undefined by the spec; however, in this implementation ANY will match NA and return true.
protected static boolean	compareAttributes(String left, String right) This does not follow the spec precisely because ANY compared to NA is classified as undefined by the spec; however, in this implementation ANY will match NA and return true.
int	compareTo(Object o) CompareTo is used for sorting, this does not implement any CPE Matching rules.
protected static int	compareVersions(String left, String right) Compare version numbers to obtain the correct ordering.
boolean	equals(Object obj)
String	getEdition() Gets the edition for the CPE entry.
String	getLanguage() Gets the language for the CPE entry.
String	getOther() Gets the other component for the CPE entry.
Part	getPart() Gets the part for the CPE entry.
String	getProduct() Gets the product for the CPE entry.
String	getSwEdition() Gets the software edition for the CPE entry.
String	getTargetHw() Gets the target hardware environment for the CPE entry.
String	getTargetSw() Gets the target software environment for the CPE entry.
String	getUpdate() Gets the update for the CPE entry.
String	getVendor() Gets the vendor for the CPE entry.
String	getVersion() Gets the version for the CPE entry.
String	getWellFormedEdition() Gets the well formed formatted edition for the CPE entry.
String	getWellFormedLanguage() Gets the well formed formatted language for the CPE entry.
String	getWellFormedOther() Gets the well formed formatted other component for the CPE entry.
String	getWellFormedProduct() Gets the well formed formatted product for the CPE entry.
String	getWellFormedSwEdition() Gets the well formed formatted software edition for the CPE entry.
String	getWellFormedTargetHw() Gets the well formed formatted target hardware environment for the CPE entry.
String	getWellFormedTargetSw() Gets the well formed formatted target software environment for the CPE entry.
String	getWellFormedUpdate() Gets the well formed formatted update for the CPE entry.
String	getWellFormedVendor() Gets the well formed formatted vendor for the CPE entry.
String	getWellFormedVersion() Gets the well formed formatted version for the CPE entry.
int	hashCode()
boolean	matchedBy(ICpe target) Determines if the target CPE matches the CPE.
boolean	matches(ICpe target) Determines if the CPE matches the given target CPE.
String	toCpe22Uri() Converts the CPE into the CPE 2.2 URI format.
String	toCpe23FS() Converts the CPE into the CPE 2.3 Formatted String.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Cpe

public Cpe(Part part,
           String vendor,
           String product,
           String version,
           String update,
           String edition,
           String language,
           String swEdition,
           String targetSw,
           String targetHw,
           String other)
    throws CpeValidationException

Constructs a new immutable CPE object that represents the Well Form Named defined in the CPE 2.3 specification. Specifying null will be set to the default LogicalValue.ANY. All values passed in must be well formed (i.e. special characters quoted with a backslash).

Parameters:

part - the type of entry: application, operating system, or hardware

vendor - the vendor of the CPE entry

product - the product of the CPE entry

version - the version of the CPE entry

update - the update of the CPE entry

edition - the edition of the CPE entry

language - the language of the CPE entry

swEdition - the swEdition of the CPE entry

targetSw - the targetSw of the CPE entry

targetHw - the targetHw of the CPE entry

other - the other of the CPE entry

Throws:

CpeValidationException - thrown if one of the CPE entries is invalid

See Also:

CPE 2.3

Method Detail

getPart

public Part getPart()

Gets the part for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getPart in interface ICpe

Returns:

the part for the CPE entry

getVendor

public String getVendor()

Gets the vendor for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getVendor in interface ICpe

Returns:

the vendor for the CPE entry

getProduct

public String getProduct()

Gets the product for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getProduct in interface ICpe

Returns:

the product for the CPE entry

getVersion

public String getVersion()

Gets the version for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getVersion in interface ICpe

Returns:

the version for the CPE entry

getUpdate

public String getUpdate()

Gets the update for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getUpdate in interface ICpe

Returns:

the update for the CPE entry

getEdition

public String getEdition()

Gets the edition for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getEdition in interface ICpe

Returns:

the edition for the CPE entry

getLanguage

public String getLanguage()

Gets the language for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getLanguage in interface ICpe

Returns:

the language for the CPE entry

getSwEdition

public String getSwEdition()

Gets the software edition for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getSwEdition in interface ICpe

Returns:

the software edition for the CPE entry

getTargetSw

public String getTargetSw()

Gets the target software environment for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getTargetSw in interface ICpe

Returns:

the target software environment for the CPE entry.

getTargetHw

public String getTargetHw()

Gets the target hardware environment for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getTargetHw in interface ICpe

Returns:

the target hardware environment for the CPE entry

getOther

public String getOther()

Gets the other component for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getOther in interface ICpe

Returns:

the other component for the CPE entry

getWellFormedVendor

public String getWellFormedVendor()

Gets the well formed formatted vendor for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getWellFormedVendor in interface ICpe

Returns:

the vendor for the CPE entry

getWellFormedProduct

public String getWellFormedProduct()

Gets the well formed formatted product for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getWellFormedProduct in interface ICpe

Returns:

the product for the CPE entry

getWellFormedVersion

public String getWellFormedVersion()

Gets the well formed formatted version for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getWellFormedVersion in interface ICpe

Returns:

the version for the CPE entry

getWellFormedUpdate

public String getWellFormedUpdate()

Gets the well formed formatted update for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getWellFormedUpdate in interface ICpe

Returns:

the update for the CPE entry

getWellFormedEdition

public String getWellFormedEdition()

Gets the well formed formatted edition for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getWellFormedEdition in interface ICpe

Returns:

the edition for the CPE entry

getWellFormedLanguage

public String getWellFormedLanguage()

Gets the well formed formatted language for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getWellFormedLanguage in interface ICpe

Returns:

the language for the CPE entry

getWellFormedSwEdition

public String getWellFormedSwEdition()

Gets the well formed formatted software edition for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getWellFormedSwEdition in interface ICpe

Returns:

the software edition for the CPE entry

getWellFormedTargetSw

public String getWellFormedTargetSw()

Gets the well formed formatted target software environment for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getWellFormedTargetSw in interface ICpe

Returns:

the target software environment for the CPE entry.

getWellFormedTargetHw

public String getWellFormedTargetHw()

Gets the well formed formatted target hardware environment for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getWellFormedTargetHw in interface ICpe

Returns:

the target hardware environment for the CPE entry

getWellFormedOther

public String getWellFormedOther()

Gets the well formed formatted other component for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Specified by:

getWellFormedOther in interface ICpe

Returns:

the other component for the CPE entry

toCpe22Uri

public String toCpe22Uri()
                  throws CpeEncodingException

Converts the CPE into the CPE 2.2 URI format.

Specified by:

toCpe22Uri in interface ICpe

Returns:

the CPE 2.2 URI format of the CPE

Throws:

CpeEncodingException - thrown if the CPE is not well formed

toCpe23FS

public String toCpe23FS()

Converts the CPE into the CPE 2.3 Formatted String.

Specified by:

toCpe23FS in interface ICpe

Returns:

the CPE 2.3 Formatted String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

matches

public boolean matches(ICpe target)

Determines if the CPE matches the given target CPE. This does not follow the CPE 2.3 Specification exactly as there are cases where undefined comparisons will result in either true or false. For instance, 'ANY' will match 'm+wild cards' and NA will return false when the target has 'm+wild cards'.

Specified by:

matches in interface ICpe

Parameters:

target - the target CPE to evaluate

Returns:

true if the CPE matches the target; otherwise false

matchedBy

public boolean matchedBy(ICpe target)

Determines if the target CPE matches the CPE. This does not follow the CPE 2.3 Specification exactly as there are cases where undefined comparisons will result in either true or false. For instance, 'ANY' will match 'm+wild cards' and NA will return false when the target has 'm+wild cards'.

Specified by:

matchedBy in interface ICpe

Parameters:

target - the CPE to evaluate

Returns:

true if the target CPE matches CPE; otherwise false

compareAttributes

protected static boolean compareAttributes(Part left,
                                           Part right)

This does not follow the spec precisely because ANY compared to NA is classified as undefined by the spec; however, in this implementation ANY will match NA and return true. This will compare the left value to the right value and return true if the left matches the right. Note that it is possible that the right would not match the left value.

Parameters:

left - the left value to compare

right - the right value to compare

Returns:

true if the left value matches the right value; otherwise false

compareAttribute

public static Relation compareAttribute(Part left,
                                        Part right)

compareAttributes

protected static boolean compareAttributes(String left,
                                           String right)

This does not follow the spec precisely because ANY compared to NA is classified as undefined by the spec; however, in this implementation ANY will match NA and return true. This will compare the left value to the right value and return true if the left matches the right. Note that it is possible that the right would not match the left value.

Parameters:

left - the left value to compare

right - the right value to compare

Returns:

true if the left value matches the right value; otherwise false

compareAttribute

public static Relation compareAttribute(String left,
                                        String right)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Object o)

CompareTo is used for sorting, this does not implement any CPE Matching rules.

Specified by:

compareTo in interface Comparable

Parameters:

o - the CPE to compare

Returns:

the sort order

compareVersions

protected static int compareVersions(String left,
                                     String right)

Compare version numbers to obtain the correct ordering.

Parameters:

left - the left hand version for comparison

right - the right hand version for comparison

Returns:

-1 if left is before the right; 0 if the left and right are equal;1 if left is after the right