Guvnor - Structure API 6.2.0.CR2

org.guvnor.structure.repositories
Interface Repository

All Superinterfaces:
org.uberfire.commons.data.Cacheable, org.uberfire.security.Resource, org.uberfire.security.authz.RuntimeResource
All Known Implementing Classes:
GitRepository

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


Method Summary
 void addEnvironmentParameter(String key, Object value)
           
 String getAlias()
          Most of the time, this can not be used as an unique ID.
 Collection<String> getBranches()
          Returns "read-only" view of all branches available in this repository.
 org.uberfire.backend.vfs.Path getBranchRoot(String branch)
           
 String getCurrentBranch()
          Returns current branch that is configured for this repository.
 Map<String,Object> getEnvironment()
           
 List<PublicURI> getPublicURIs()
           
 org.uberfire.backend.vfs.Path getRoot()
           
 String getScheme()
           
 String getUri()
           
 boolean isValid()
           
 void setRoot(org.uberfire.backend.vfs.Path root)
           
 
Methods inherited from interface org.uberfire.security.authz.RuntimeResource
getRoles, getSignatureId, getTraits
 
Methods inherited from interface org.uberfire.commons.data.Cacheable
markAsCached, requiresRefresh
 

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

String getScheme()

getEnvironment

Map<String,Object> getEnvironment()

addEnvironmentParameter

void addEnvironmentParameter(String key,
                             Object value)

isValid

boolean isValid()

getUri

String getUri()

getPublicURIs

List<PublicURI> getPublicURIs()

getRoot

org.uberfire.backend.vfs.Path getRoot()

getBranchRoot

org.uberfire.backend.vfs.Path getBranchRoot(String branch)

setRoot

void setRoot(org.uberfire.backend.vfs.Path root)

getBranches

Collection<String> getBranches()
Returns "read-only" view of all branches available in this repository.

Returns:

getCurrentBranch

String getCurrentBranch()
Returns current branch that is configured for this repository. It will always provide branch name even if there was no explicit branch selected/created - which in that case is always 'master'

Returns:

Guvnor - Structure API 6.2.0.CR2

Copyright © 2001-2014 JBoss by Red Hat. All Rights Reserved.