io.apiman.common.plugin

Class PluginUtils

java.lang.Object

io.apiman.common.plugin.PluginUtils

public class PluginUtils
extends Object

Some generally useful static methods.

Author:

eric.wittmann@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_SPEC_PATH

Method Summary

Modifier and Type	Method and Description
static Set<URI>	getDefaultMavenRepositories()
static File	getM2Path(File m2Dir, PluginCoordinates coordinates) Find the plugin artifact in the local .m2 directory.
static String	getMavenPath(PluginCoordinates coordinates) Calculates the relative path of the artifact from the given coordinates.
static String	getPluginRelativePath(PluginCoordinates coordinates) Returns the relative path (within a plugin registry's plugins directory) where the plugin with the given coordinates can be found.
static File	getUserM2Repository() Gets the user's local m2 directory or null if not found.
static boolean	isSnapshot(PluginCoordinates coordinates) Returns true if the plugin identified by the given coordinates is a snapshot plugin.
static PluginSpec	readPluginSpecFile(URL pluginSpec) Reads a plugin spec file and returns a PluginSpec.

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_SPEC_PATH

public static final String PLUGIN_SPEC_PATH

See Also:

Constant Field Values

Method Detail

getDefaultMavenRepositories

public static Set<URI> getDefaultMavenRepositories()

Returns:

a set of default maven repositories to search for plugins

getPluginRelativePath

public static String getPluginRelativePath(PluginCoordinates coordinates)

Returns the relative path (within a plugin registry's plugins directory) where the plugin with the given coordinates can be found. For example, if the plugin coordinate are "io.apiman.sample:sample-plugin:1.0.1:classifier:war" then the path will be: io.apiman.sample/sample-plugin/1.0.1/sample-plugin-classifier.war/

Parameters:

coordinates - the coordinates

Returns:

plugin's relative path

readPluginSpecFile

public static PluginSpec readPluginSpecFile(URL pluginSpec)
                                     throws IOException

Reads a plugin spec file and returns a PluginSpec.

Parameters:

pluginSpec - the plugin spec

Returns:

plugin's specification

Throws:

IOException - when an unhandled exception occurs

getUserM2Repository

public static File getUserM2Repository()

Gets the user's local m2 directory or null if not found.

Returns:

user's M2 repo

getM2Path

public static File getM2Path(File m2Dir,
                             PluginCoordinates coordinates)

Find the plugin artifact in the local .m2 directory.

Parameters:

m2Dir - the maven m2 directory

coordinates - the coordinates

Returns:

the M2 path

getMavenPath

public static String getMavenPath(PluginCoordinates coordinates)

Calculates the relative path of the artifact from the given coordinates.

Parameters:

coordinates - the coordinates

Returns:

the maven path

isSnapshot

public static boolean isSnapshot(PluginCoordinates coordinates)

Returns true if the plugin identified by the given coordinates is a snapshot plugin.

Parameters:

coordinates - the plugin coordinates

Returns:

true if the given plugin is a snapshot