org.springframework.cloud.deployer.resource.maven

Class MavenResource

java.lang.Object

org.springframework.core.io.AbstractResource

org.springframework.cloud.deployer.resource.maven.MavenResource

All Implemented Interfaces:

org.springframework.core.io.InputStreamSource, org.springframework.core.io.Resource

public class MavenResource
extends org.springframework.core.io.AbstractResource

A Resource implementation for resolving an artifact via maven coordinates.

The MavenResource class contains Maven coordinates for a jar file containing an app/library, or a Bill of Materials pom.

To create a new instance, either use MavenResource.Builder to set the individual fields:

 new MavenResource.Builder()
     .setGroupId("org.springframework.sample")
     .setArtifactId("some-app")
     .setExtension("jar") //optional
     .setClassifier("exec") //optional
     .setVersion("2.0.0")
     .build()
 

...or use parse(String) to parse the coordinates as a colon delimited string: <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>

 MavenResource.parse("org.springframework.sample:some-app:2.0.0);
 MavenResource.parse("org.springframework.sample:some-app:jar:exec:2.0.0);
 

Author:

David Turanski, Mark Fisher, Patrick Peralta, Venil Noronha

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MavenResource.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	URI_SCHEME

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
boolean	exists()
String	getArtifactId()
String	getClassifier()
String	getDescription()
String	getExtension()
File	getFile()
String	getFilename()
String	getGroupId()
InputStream	getInputStream()
URI	getURI()
String	getVersion()
int	hashCode()
static MavenResource	parse(String coordinates) Create a MavenResource for the provided coordinates and default properties.
static MavenResource	parse(String coordinates, MavenProperties properties) Create a MavenResource for the provided coordinates and properties.
String	toString() Returns the coordinates encoded as <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>, conforming to the Aether convention.

Methods inherited from class org.springframework.core.io.AbstractResource

contentLength, createRelative, getFileForLastModifiedCheck, getURL, isFile, isOpen, isReadable, lastModified, readableChannel

Methods inherited from class java.lang.Object

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

Field Detail

URI_SCHEME

public static String URI_SCHEME

Method Detail

getGroupId

public String getGroupId()

See Also:

groupId

getArtifactId

public String getArtifactId()

See Also:

artifactId

getExtension

public String getExtension()

See Also:

extension

getClassifier

public String getClassifier()

See Also:

version

getVersion

public String getVersion()

See Also:

version

getDescription

public String getDescription()

getInputStream

public InputStream getInputStream()
                           throws IOException

Throws:

IOException

getFile

public File getFile()
             throws IOException

Specified by:

getFile in interface org.springframework.core.io.Resource

Overrides:

getFile in class org.springframework.core.io.AbstractResource

Throws:

IOException

getFilename

public String getFilename()

Specified by:

getFilename in interface org.springframework.core.io.Resource

Overrides:

getFilename in class org.springframework.core.io.AbstractResource

exists

public boolean exists()

Specified by:

exists in interface org.springframework.core.io.Resource

Overrides:

exists in class org.springframework.core.io.AbstractResource

equals

public final boolean equals(Object o)

Overrides:

equals in class org.springframework.core.io.AbstractResource

hashCode

public int hashCode()

Overrides:

hashCode in class org.springframework.core.io.AbstractResource

toString

public String toString()

Returns the coordinates encoded as <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>, conforming to the Aether convention.

Overrides:

toString in class org.springframework.core.io.AbstractResource

getURI

public URI getURI()
           throws IOException

Specified by:

getURI in interface org.springframework.core.io.Resource

Overrides:

getURI in class org.springframework.core.io.AbstractResource

Throws:

IOException

parse

public static MavenResource parse(String coordinates)

Create a MavenResource for the provided coordinates and default properties.

Parameters:

coordinates - coordinates encoded as <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>, conforming to the Aether convention.

Returns:

the MavenResource

parse

public static MavenResource parse(String coordinates,
                                  MavenProperties properties)

Create a MavenResource for the provided coordinates and properties.

Parameters:

coordinates - coordinates encoded as <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>, conforming to the Aether convention.

properties - the properties for the repositories, proxies, and authentication

Returns:

the MavenResource