com.github.packageurl

Class PackageURL

java.lang.Object

com.github.packageurl.PackageURL

All Implemented Interfaces:

Serializable

public final class PackageURL
extends Object
implements Serializable

purl stands for package URL. A purl is a URL composed of seven components: scheme:type/namespace/name@version?qualifiers#subpath Components are separated by a specific character for unambiguous parsing. A purl must NOT contain a URL Authority i.e. there is no support for username, password, host and port components. A namespace segment may sometimes look like a host but its interpretation is specific to a type. SPEC: https://github.com/package-url/purl-spec

Since:

1.0.0

Author:

Steve Springett

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PackageURL.StandardTypes Convenience constants that defines common PackageURL 'type's.

Constructor Summary

Constructors

Constructor and Description
PackageURL(String purl) Constructs a new PackageURL object by parsing the specified string.
PackageURL(String type, String name) Constructs a new PackageURL object by specifying only the required parameters necessary to create a valid PackageURL.
PackageURL(String type, String namespace, String name, String version, TreeMap<String,String> qualifiers, String subpath) Constructs a new PackageURL object.

Method Summary

Modifier and Type	Method and Description
String	canonicalize() Returns a canonicalized representation of the purl.
String	getName() Returns the name of the package.
String	getNamespace() Returns the name prefix such as a Maven groupid, a Docker image owner, a GitHub user or organization.
Map	getQualifiers() Returns extra qualifying data for a package such as an OS, architecture, a distro, etc.
String	getScheme() Returns the package url scheme.
String	getSubpath() Returns extra subpath within a package, relative to the package root.
String	getType() Returns the package "type" or package "protocol" such as maven, npm, nuget, gem, pypi, etc.
String	getVersion() Returns the version of the package.

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageURL

public PackageURL(String purl)
           throws MalformedPackageURLException

Constructs a new PackageURL object by parsing the specified string.

Parameters:

purl - a valid package URL string to parse

Throws:

MalformedPackageURLException - if parsing fails

Since:

1.0.0

PackageURL

public PackageURL(String type,
                  String name)
           throws MalformedPackageURLException

Constructs a new PackageURL object by specifying only the required parameters necessary to create a valid PackageURL.

Parameters:

type - the type of package (i.e. maven, npm, gem, etc)

name - the name of the package

Throws:

MalformedPackageURLException - if parsing fails

Since:

1.0.0

PackageURL

public PackageURL(String type,
                  String namespace,
                  String name,
                  String version,
                  TreeMap<String,String> qualifiers,
                  String subpath)
           throws MalformedPackageURLException

Constructs a new PackageURL object.

Parameters:

type - the type of package (i.e. maven, npm, gem, etc)

namespace - the name prefix (i.e. group, owner, organization)

name - the name of the package

version - the version of the package

qualifiers - an array of key/value pair qualifiers

subpath - the subpath string

Throws:

MalformedPackageURLException - if parsing fails

Since:

1.0.0

Method Detail

getScheme

public String getScheme()

Returns the package url scheme.

Returns:

the scheme

Since:

1.0.0

getType

public String getType()

Returns the package "type" or package "protocol" such as maven, npm, nuget, gem, pypi, etc.

Returns:

the type

Since:

1.0.0

getNamespace

public String getNamespace()

Returns the name prefix such as a Maven groupid, a Docker image owner, a GitHub user or organization.

Returns:

the namespace

Since:

1.0.0

getName

public String getName()

Returns the name of the package.

Returns:

the name of the package

Since:

1.0.0

getVersion

public String getVersion()

Returns the version of the package.

Returns:

the version of the package

Since:

1.0.0

getQualifiers

public Map getQualifiers()

Returns extra qualifying data for a package such as an OS, architecture, a distro, etc.

Returns:

qualifiers

Since:

1.0.0

getSubpath

public String getSubpath()

Returns extra subpath within a package, relative to the package root.

Returns:

the subpath

Since:

1.0.0

canonicalize

public String canonicalize()

Returns a canonicalized representation of the purl.

Returns:

a canonicalized representation of the purl

Since:

1.0.0