org.cloudbees.literate.api.v1

Class ProjectModelSource

java.lang.Object

org.cloudbees.literate.api.v1.ProjectModelSource

@Immutable
public class ProjectModelSource
extends Object

A source of ProjectModel instances. The source depends on what SPI implementations are available on the classpath, hence you supply a class loader (or use the context class loader) so that the ServiceLoader can look up the implementations that are within scope.

Constructor Summary

Constructors

Constructor and Description
ProjectModelSource() Constructs an instance from the current thread's context classloader.
ProjectModelSource(ClassLoader classLoader) Constructs an instance from a specific classloader.

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	markerFiles(String basename) Returns the set of marker filename(s) that the source supports based on the supplied basename.
ProjectModel	submit(ProjectModelRequest request) Submits a request and returns the resulting model

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectModelSource

public ProjectModelSource(ClassLoader classLoader)

Constructs an instance from a specific classloader.

Parameters:

classLoader - the classloader.

ProjectModelSource

public ProjectModelSource()

Constructs an instance from the current thread's context classloader.

Method Detail

markerFiles

@NonNull
public Set<String> markerFiles(@NonNull
                              String basename)

Returns the set of marker filename(s) that the source supports based on the supplied basename. The presence of a marker file in a project root indicates that the project root is worth attempting to submit(ProjectModelRequest) (org.cloudbees.literate.api.v1.ProjectModelRequest)} against.

Parameters:

basename - the ProjectModelRequest.getBaseName()

Returns:

the set of marker filename(s).

submit

@NonNull
public ProjectModel submit(@NonNull
                          ProjectModelRequest request)
                    throws IOException,
                           ProjectModelBuildingException

Submits a request and returns the resulting model

Parameters:

request - the request.

Returns:

the ProjectModel.

Throws:

IOException - if there were IO problems connecting to the ProjectModelRequest.getRepository().

ProjectModelBuildingException - if the ProjectModelRequest.getRepository() did not contain a valid model definition.