Package sonia.scm

Class BasicContextProvider

java.lang.Object

sonia.scm.BasicContextProvider

All Implemented Interfaces:

SCMContextProvider

public class BasicContextProvider
extends Object
implements SCMContextProvider

The default implementation of SCMContextProvider.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEVELOPMENT_INSTANCE_ID
static final String	DIRECTORY_DEFAULT	Default name of the SCM-Manager base directory
static final String	DIRECTORY_PROPERTY	Java system property for the SCM-Manager base directory
static final String	MAVEN_PROPERTIES	Path to the maven properties file of the scm-core artifact
static final String	MAVEN_PROPERTY_VERSION	Maven property for the version of the artifact
static final String	VERSION_DEFAULT	Default version String

Constructor Summary

Constructors

Constructor	Description
BasicContextProvider()	Constructs a new BasicContextProvider object.

Method Summary

Modifier and Type	Method	Description
File	getBaseDirectory()	Returns the base directory of the SCM-Manager.
String	getInstanceId()	Returns the instance id of the SCM-Manager used.
Stage	getStage()	Returns the current stage of SCM-Manager.
Throwable	getStartupError()	Returns an exception which is occurred on context startup.
String	getVersion()	Returns the version of the SCM-Manager.
Path	resolve(Path path)	Resolves the given path against the base directory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface sonia.scm.SCMContextProvider

getDocumentationVersion

Field Details

VERSION_DEFAULT

public static final String VERSION_DEFAULT

Default version String

See Also:

• Constant Field Values

DIRECTORY_DEFAULT

public static final String DIRECTORY_DEFAULT

Default name of the SCM-Manager base directory

See Also:

• Constant Field Values

DIRECTORY_PROPERTY

public static final String DIRECTORY_PROPERTY

Java system property for the SCM-Manager base directory

See Also:

• Constant Field Values

MAVEN_PROPERTIES

public static final String MAVEN_PROPERTIES

Path to the maven properties file of the scm-core artifact

See Also:

• Constant Field Values

MAVEN_PROPERTY_VERSION

public static final String MAVEN_PROPERTY_VERSION

Maven property for the version of the artifact

See Also:

• Constant Field Values

DEVELOPMENT_INSTANCE_ID

public static final String DEVELOPMENT_INSTANCE_ID

See Also:

• Constant Field Values

Constructor Details

BasicContextProvider

public BasicContextProvider()

Constructs a new BasicContextProvider object.

Method Details

resolve

public Path resolve(Path path)

Description copied from interface: SCMContextProvider

Resolves the given path against the base directory.

Specified by:

resolve in interface SCMContextProvider

Parameters:

path - path to resolve

Returns:

absolute resolved path

getBaseDirectory

public File getBaseDirectory()

Description copied from interface: SCMContextProvider

Returns the base directory of the SCM-Manager.

Specified by:

getBaseDirectory in interface SCMContextProvider

getStage

public Stage getStage()

Description copied from interface: SCMContextProvider

Returns the current stage of SCM-Manager.

Specified by:

getStage in interface SCMContextProvider

getStartupError

public Throwable getStartupError()

Description copied from interface: SCMContextProvider

Returns an exception which is occurred on context startup. The method returns null if the start was successful.

Specified by:

getStartupError in interface SCMContextProvider

Returns:

startup exception of null

getVersion

public String getVersion()

Returns the version of the SCM-Manager. If the version is not set, the VERSION_DEFAULT is returned.

Specified by:

getVersion in interface SCMContextProvider

getInstanceId

public String getInstanceId()

Description copied from interface: SCMContextProvider

Returns the instance id of the SCM-Manager used.

Specified by:

getInstanceId in interface SCMContextProvider