Class ScmContentProvider
- java.lang.Object
-
- io.jenkins.blueocean.rest.impl.pipeline.ScmContentProvider
-
- All Implemented Interfaces:
ExtensionPoint
- Direct Known Subclasses:
AbstractScmContentProvider
public abstract class ScmContentProvider extends Object implements ExtensionPoint
SCM content specific APIs- Author:
- Vivek Pandey
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description ScmContentProvider()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static ExtensionList<ScmContentProvider>
all()
abstract String
getApiUrl(Item item)
Get the SCM API URL for the provided itemabstract Object
getContent(org.kohsuke.stapler.StaplerRequest staplerRequest, Item item)
Gives content of scm file.abstract String
getScmId()
Get the "scmId" for the content provider as defined in Scm.getId()static ScmContentProvider
resolve(Item item)
ResolveScmContentProvider
for givenItem
.abstract Object
saveContent(org.kohsuke.stapler.StaplerRequest staplerRequest, Item item)
Save contentabstract boolean
support(Item item)
ScmContentProvider
instance that supports givenSCMNavigator
.
-
-
-
Method Detail
-
getScmId
@NonNull public abstract String getScmId()
Get the "scmId" for the content provider as defined in Scm.getId()- Returns:
- SCM identifier
-
getApiUrl
@CheckForNull public abstract String getApiUrl(@NonNull Item item)
Get the SCM API URL for the provided item- Parameters:
item
-Item
item to resolve backing SCM API URL- Returns:
- SCM API URL
-
getContent
@CheckForNull public abstract Object getContent(@NonNull org.kohsuke.stapler.StaplerRequest staplerRequest, @NonNull Item item)
Gives content of scm file.- Parameters:
staplerRequest
-StaplerRequest
request specific to this SCMitem
-Item
in context. e.g.OrganizationFolder
orMultiBranchProject
- Returns:
- scm content
-
saveContent
@CheckForNull public abstract Object saveContent(@NonNull org.kohsuke.stapler.StaplerRequest staplerRequest, @NonNull Item item)
Save content- Parameters:
staplerRequest
-StaplerRequest
request specific to this SCMitem
-Item
in context. e.g.OrganizationFolder
orMultiBranchProject
- Returns:
- SCM specific save content response
-
support
public abstract boolean support(@NonNull Item item)
ScmContentProvider
instance that supports givenSCMNavigator
.- Returns:
- true if this provide can handle it.
-
resolve
public static ScmContentProvider resolve(@NonNull Item item)
ResolveScmContentProvider
for givenItem
.- Parameters:
item
- item for whichScmContentProvider
is resolved- Returns:
- resolved ScmContentProvider
-
all
public static ExtensionList<ScmContentProvider> all()
-
-