nl.toolforge.karma.core.boot
Class AdminStore

java.lang.Object
  nl.toolforge.karma.core.boot.AdminStore

All Implemented Interfaces:

Store

Direct Known Subclasses:

LocationStore, ManifestStore

public abstract class AdminStore

extends java.lang.Object

implements Store

Version:

$Id: AdminStore.java,v 1.6 2004/11/11 10:47:45 hippe Exp $

Author:

D.A. Smedes

Field Summary

static ErrorCode	AUTHENTICATOR_NOT_FOUND
protected Module	module
static ErrorCode	STORE_CONNECTION_FAILURE
static ErrorCode	STORE_MODULE_NO_IN_REPOSITORY

Constructor Summary

AdminStore(WorkingContext workingContext)

AdminStore(WorkingContext workingContext, java.lang.String moduleName, Location location)

Method Summary

ErrorCode	checkConfiguration() Checks if the configuration of the store is ok.
boolean	exists()
Location	getLocation()
java.lang.String	getModuleName()
protected WorkingContext	getWorkingContext()
void	setLocation(Location location) Assigns this Store a Location.
void	setModuleName(java.lang.String moduleName) Sets the module name for this ManifestStore.
void	update() Updates the local checkout of the manifest store.

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.toolforge.karma.core.boot.Store

getModule

Field Detail

STORE_CONNECTION_FAILURE

public static final ErrorCode STORE_CONNECTION_FAILURE

AUTHENTICATOR_NOT_FOUND

public static final ErrorCode AUTHENTICATOR_NOT_FOUND

STORE_MODULE_NO_IN_REPOSITORY

public static final ErrorCode STORE_MODULE_NO_IN_REPOSITORY

module

protected Module module

Constructor Detail

AdminStore

public AdminStore(WorkingContext workingContext)

AdminStore

public AdminStore(WorkingContext workingContext,
                  java.lang.String moduleName,
                  Location location)

Method Detail

getWorkingContext

protected final WorkingContext getWorkingContext()

setLocation

public final void setLocation(Location location)

Description copied from interface: Store

Assigns this Store a Location. The Location contains a module with administrative files for Karma to run.

Specified by:

setLocation in interface Store

Parameters:

location - The location for this store.

getLocation

public final Location getLocation()

update

public final void update()
                  throws AuthenticationException,
                         VersionControlException

Description copied from interface: Store

Updates the local checkout of the manifest store.

Specified by:

update in interface Store

Throws:

VersionControlException - When the update failed.

AuthenticationException - When the location for this Store cannot be authenticated.

setModuleName

public final void setModuleName(java.lang.String moduleName)

Description copied from interface: Store

Sets the module name for this ManifestStore. This name is assumed to be the name of the module in a version control repository. The moduleName should be including any offset-directory in the version control system.

Specified by:

setModuleName in interface Store

Parameters:

moduleName - The module name for the manifest store.

getModuleName

public final java.lang.String getModuleName()

Specified by:

getModuleName in interface Store

exists

public final boolean exists()

checkConfiguration

public ErrorCode checkConfiguration()

Description copied from interface: Store

Checks if the configuration of the store is ok.

Specified by:

checkConfiguration in interface Store

Returns:

An ErrorCode instance with the first encountered error, or null if none happened.