org.alfresco.service.cmr.admin

Interface RepoAdminService

All Known Implementing Classes:

RepoAdminServiceImpl

public interface RepoAdminService

Repository Admin Service. Client facing API for interacting with Alfresco Repository Admin services.

Method Summary

Modifier and Type	Method and Description
org.alfresco.service.namespace.QName	activateModel(String modelFileName) Activate custom model.
org.alfresco.service.namespace.QName	deactivateModel(String modelFileName) Deactivate custom model.
String	deployMessageBundle(String resourceClasspath) Deploy custom message resource bundle (to the 'Messages' space).
void	deployModel(InputStream modelStream, String modelFileName) Deploy custom model (to the 'Models' space).
org.alfresco.service.cmr.repository.NodeRef	deployModel(InputStream modelStream, String modelFileName, boolean activate) Deploy custom model (to the 'Models' space).
List<String>	getMessageBundles() Get deployed custom messages resource bundles.
List<RepoModelDefinition>	getModels() Get list of deployed custom model.
RepoUsage	getRestrictions() Get the currently-active restrictions to the repository usage
RepoUsage	getUsage() Get the repository usage, where known
RepoUsageStatus	getUsageStatus() Get full information on the state of the usage limits, including errors and warnings about limits in play.
void	reloadMessageBundle(String bundleBaseName) Reload custom message resource bundle.
void	undeployMessageBundle(String bundleBaseName) Undeploy custom message resource bundle (from the 'Messages' space).
org.alfresco.service.namespace.QName	undeployModel(String modelFileName) Undeploy custom model (from the 'Models' space).
boolean	updateUsage(RepoUsage.UsageType usageType) Force an update of the usages, providing a hint on the specific updates required.

Method Detail

getModels

@Auditable
List<RepoModelDefinition> getModels()

Get list of deployed custom model.

deployModel

@Auditable(parameters={"modelStream","modelFileName"},
           recordable={false,true})
void deployModel(InputStream modelStream,
                                                                                                            String modelFileName)

Deploy custom model (to the 'Models' space). Allows creation of new models and incremental update of existing models.

deployModel

@Auditable(parameters={"modelStream","modelFileName","activate"},
           recordable={false,true,false})
org.alfresco.service.cmr.repository.NodeRef deployModel(InputStream modelStream,
                                                                                                                                                                    String modelFileName,
                                                                                                                                                                    boolean activate)

Deploy custom model (to the 'Models' space). Allows creation of new models and incremental update of existing models.

Parameters:

modelStream - the model input stream

modelFileName - modelFileName the model file name

activate - whether the model should be activated or not

Returns:

the nodeRef of the created model

undeployModel

@Auditable(parameters="modelFileName")
org.alfresco.service.namespace.QName undeployModel(String modelFileName)

Undeploy custom model (from the 'Models' space). Allows delete of existing models, if not used. Permanently removes the model definition from the repository (all versions).

activateModel

@Auditable(parameters="modelFileName")
org.alfresco.service.namespace.QName activateModel(String modelFileName)

Activate custom model.

deactivateModel

@Auditable(parameters="modelFileName")
org.alfresco.service.namespace.QName deactivateModel(String modelFileName)

Deactivate custom model.

getMessageBundles

@Auditable
List<String> getMessageBundles()

Get deployed custom messages resource bundles.

deployMessageBundle

@Auditable(parameters="resourceClasspath")
String deployMessageBundle(String resourceClasspath)

Deploy custom message resource bundle (to the 'Messages' space).

undeployMessageBundle

@Auditable(parameters="bundleBaseName")
void undeployMessageBundle(String bundleBaseName)

Undeploy custom message resource bundle (from the 'Messages' space).

reloadMessageBundle

@Auditable(parameters="bundleBaseName")
void reloadMessageBundle(String bundleBaseName)

Reload custom message resource bundle.

getRestrictions

@Auditable
RepoUsage getRestrictions()

Get the currently-active restrictions to the repository usage

Since:

3.5

getUsage

RepoUsage getUsage()

Get the repository usage, where known

Returns:

the currently-known repository usage

Since:

3.5

updateUsage

boolean updateUsage(RepoUsage.UsageType usageType)

Force an update of the usages, providing a hint on the specific updates required. If another client is already performing the update, then the calling code will need to determine the severity i.e. is an updated value really needed. Generally clients should accept that the data might be slightly stale, especially since there is no way to guarantee visibility of data being put into the database by other transactions.

Parameters:

usageType - the type of usage update to perform

Returns:

true if the update succeeded or false if some other client was already performing the same update

getUsageStatus

RepoUsageStatus getUsageStatus()

Get full information on the state of the usage limits, including errors and warnings about limits in play.

Returns:

the object containing all the information