org.alfresco.repo.admin.patch.impl

Class SiteLoadPatch

java.lang.Object

org.alfresco.repo.admin.patch.AbstractPatch

org.alfresco.repo.admin.patch.impl.SiteLoadPatch

All Implemented Interfaces:

Patch, org.springframework.context.ApplicationEventPublisherAware

public class SiteLoadPatch
extends AbstractPatch

A Patch based importer which creates and populates a site based on the supplied data

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTIES_CONTENTS
static java.lang.String	PROPERTIES_GROUPS
static java.lang.String	PROPERTIES_PEOPLE
static java.lang.String	PROPERTIES_USERS

Fields inherited from class org.alfresco.repo.admin.patch.AbstractPatch

applicationEventPublisher, authenticationContext, ERR_PROPERTY_NOT_SET, namespaceService, nodeService, searchService, tenantAdminService, transactionHelper, transactionService

Constructor Summary

Constructors

Constructor and Description
SiteLoadPatch()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	applyInternal() This method does the work.
protected void	checkProperties() Check that the schema version properties have been set appropriately.
boolean	isDisabled()
void	setAuthorityService(AuthorityService authorityService) Sets the Authority Service to be used for groups and people
void	setBehaviourFilter(BehaviourFilter behaviourFilter)
void	setBootstrapViews(java.util.Map bootstrapViews) Sets the details of the bootstraps to perform
void	setDescriptorService(DescriptorService descriptorService)
void	setDisabled(boolean disabled)
void	setSiteName(java.lang.String siteName) Sets the name of the site to be bootstrapped.
void	setSiteService(SiteService siteService) Sets the Site Service to be used for importing into
void	setSpacesBootstrap(ImporterBootstrap spacesBootstrap)
void	setUsersBootstrap(ImporterBootstrap usersBootstrap)

Methods inherited from class org.alfresco.repo.admin.patch.AbstractPatch

applies, apply, checkPropertyNotNull, getAlternatives, getDependsOn, getDescription, getFixesFromSchema, getFixesToSchema, getId, getTargetSchema, init, isForce, reportProgress, requiresTransaction, setAlternatives, setApplicationEventPublisher, setApplyToTenants, setAuthenticationContext, setDependsOn, setDescription, setFixesFromSchema, setFixesToSchema, setForce, setId, setNamespaceService, setNodeService, setPatchService, setRequiresTransaction, setSearchService, setTargetSchema, setTenantAdminService, setTransactionService, toString

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTIES_USERS

public static final java.lang.String PROPERTIES_USERS

See Also:

Constant Field Values

PROPERTIES_PEOPLE

public static final java.lang.String PROPERTIES_PEOPLE

See Also:

Constant Field Values

PROPERTIES_GROUPS

public static final java.lang.String PROPERTIES_GROUPS

See Also:

Constant Field Values

PROPERTIES_CONTENTS

public static final java.lang.String PROPERTIES_CONTENTS

See Also:

Constant Field Values

Constructor Detail

SiteLoadPatch

public SiteLoadPatch()

Method Detail

setSiteName

public void setSiteName(java.lang.String siteName)

Sets the name of the site to be bootstrapped.

Parameters:

siteName - The short name of the site

setSpacesBootstrap

public void setSpacesBootstrap(ImporterBootstrap spacesBootstrap)

setUsersBootstrap

public void setUsersBootstrap(ImporterBootstrap usersBootstrap)

setBootstrapViews

public void setBootstrapViews(java.util.Map bootstrapViews)

Sets the details of the bootstraps to perform

setSiteService

public void setSiteService(SiteService siteService)

Sets the Site Service to be used for importing into

Parameters:

siteService - The Site Service

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

Sets the Authority Service to be used for groups and people

Parameters:

authorityService - The Authority Service

setDescriptorService

public void setDescriptorService(DescriptorService descriptorService)

Parameters:

descriptorService - the descriptorService to set

setBehaviourFilter

public void setBehaviourFilter(BehaviourFilter behaviourFilter)

setDisabled

public void setDisabled(boolean disabled)

isDisabled

public boolean isDisabled()

checkProperties

protected void checkProperties()

Description copied from class: AbstractPatch

Check that the schema version properties have been set appropriately. Derived classes can override this method to perform their own validation provided that this method is called by the derived class.

Overrides:

checkProperties in class AbstractPatch

applyInternal

protected java.lang.String applyInternal()
                                  throws java.lang.Exception

Description copied from class: AbstractPatch

This method does the work. All transactions and thread-safety will be taken care of by this class. Any exception will result in the transaction being rolled back. Integrity checks are downgraded for the duration of the transaction.

Specified by:

applyInternal in class AbstractPatch

Returns:

Returns the report (only success messages).

Throws:

java.lang.Exception - anything can be thrown. This must be used for all failures.

See Also:

AbstractPatch.apply()