Package org.guvnor.structure.repositories

Interface Repository

All Superinterfaces:

org.uberfire.commons.data.Cacheable, org.uberfire.security.ContributorResource, org.uberfire.security.Resource, org.uberfire.security.authz.RuntimeContentResource, org.uberfire.security.authz.RuntimeResource

All Known Implementing Classes:

GitRepository

public interface Repository
extends org.uberfire.security.ContributorResource, org.uberfire.security.authz.RuntimeContentResource, org.uberfire.commons.data.Cacheable

Field Summary

Fields

Modifier and Type	Field	Description
static RepositoryResourceType	RESOURCE_TYPE

Method Summary

Modifier and Type	Method	Description
void	addEnvironmentParameter(String key, Object value)
String	getAlias()	Most of the time, this can not be used as an unique ID.
Optional<Branch>	getBranch(String branch)
Optional<Branch>	getBranch(org.uberfire.backend.vfs.Path branchRoot)
Collection<Branch>	getBranches()	Returns "read-only" view of all branches available in this repository.
Optional<Branch>	getDefaultBranch()	In the case of Git repository this would be master.
Map<String,Object>	getEnvironment()
Collection<String>	getGroups()
List<PublicURI>	getPublicURIs()
org.uberfire.spaces.SpacesAPI.Scheme	getScheme()
org.uberfire.spaces.Space	getSpace()
String	getUri()
boolean	isValid()

Methods inherited from interface org.uberfire.commons.data.Cacheable

markAsCached, requiresRefresh

Methods inherited from interface org.uberfire.security.ContributorResource

getContributors

Methods inherited from interface org.uberfire.security.Resource

getDependencies, getIdentifier, getResourceType, isType

Field Detail

RESOURCE_TYPE

static final RepositoryResourceType RESOURCE_TYPE

Method Detail

getAlias

String getAlias()

Most of the time, this can not be used as an unique ID. If the Repository has branches each branch has the same alias.

Returns:

short name for the repository

getScheme

org.uberfire.spaces.SpacesAPI.Scheme getScheme()

getSpace

org.uberfire.spaces.Space getSpace()

getEnvironment

Map<String,Object> getEnvironment()

addEnvironmentParameter

void addEnvironmentParameter(String key,
                             Object value)

isValid

boolean isValid()

getUri

String getUri()

getPublicURIs

List<PublicURI> getPublicURIs()

getBranch

Optional<Branch> getBranch(String branch)

getBranch

Optional<Branch> getBranch(org.uberfire.backend.vfs.Path branchRoot)

getGroups

Collection<String> getGroups()

getBranches

Collection<Branch> getBranches()

Returns "read-only" view of all branches available in this repository.

Returns:

getDefaultBranch

Optional<Branch> getDefaultBranch()

In the case of Git repository this would be master.

Returns:

empty if there are no branches.