Package org.alfresco.repo.web.scripts.admin

Class AbstractAdminWebScript

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

org.alfresco.repo.web.scripts.admin.AbstractAdminWebScript

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

Direct Known Subclasses:

RepoRestrictionsGet, RepoUsageGet, RepoUsagePost

public abstract class AbstractAdminWebScript
extends org.springframework.extensions.webscripts.DeclarativeWebScript

Abstract implementation for scripts that access the RepoAdminService.

Since:

3.4

Author:

Derek Hulley

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Field Summary

Fields

Modifier and Type	Field	Description
protected DescriptorService	descriptorService
static String	JSON_KEY_DOCUMENTS
static String	JSON_KEY_ERRORS
static String	JSON_KEY_LAST_UPDATE
static String	JSON_KEY_LEVEL
static String	JSON_KEY_LICENSE_HOLDER
static String	JSON_KEY_LICENSE_MODE
static String	JSON_KEY_LICENSE_VALID_UNTIL
static String	JSON_KEY_READ_ONLY
static String	JSON_KEY_UPDATED
static String	JSON_KEY_USERS
static String	JSON_KEY_WARNINGS
protected org.apache.commons.logging.Log	logger	Logger that can be used by subclasses.
protected RepoAdminService	repoAdminService

Constructor Summary

Constructors

Constructor	Description
AbstractAdminWebScript()

Method Summary

Modifier and Type	Method	Description
protected String	getI18NMessage(String key, Object... args)	Return an I18N'd message for the given key or the key itself if not present
protected void	putUsageInModel(Map<String,Object> model, RepoUsage repoUsage, boolean updated)	Helper to assign JSON return variables based on the repository usage data.
void	setDescriptorService(DescriptorService descriptorService)
void	setRepoAdminService(RepoAdminService repoAdminService)

Methods inherited from class org.springframework.extensions.webscripts.DeclarativeWebScript

execute, executeFinallyImpl, executeImpl, executeImpl, executeImpl, getTemplateModel, renderFormatTemplate

Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript

addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString

Methods inherited from class java.lang.Object

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

Field Detail

JSON_KEY_LAST_UPDATE

public static final String JSON_KEY_LAST_UPDATE

See Also:

Constant Field Values

JSON_KEY_USERS

public static final String JSON_KEY_USERS

See Also:

Constant Field Values

JSON_KEY_DOCUMENTS

public static final String JSON_KEY_DOCUMENTS

See Also:

Constant Field Values

JSON_KEY_LICENSE_MODE

public static final String JSON_KEY_LICENSE_MODE

See Also:

Constant Field Values

JSON_KEY_READ_ONLY

public static final String JSON_KEY_READ_ONLY

See Also:

Constant Field Values

JSON_KEY_UPDATED

public static final String JSON_KEY_UPDATED

See Also:

Constant Field Values

JSON_KEY_LICENSE_VALID_UNTIL

public static final String JSON_KEY_LICENSE_VALID_UNTIL

See Also:

Constant Field Values

JSON_KEY_LICENSE_HOLDER

public static final String JSON_KEY_LICENSE_HOLDER

See Also:

Constant Field Values

JSON_KEY_LEVEL

public static final String JSON_KEY_LEVEL

See Also:

Constant Field Values

JSON_KEY_WARNINGS

public static final String JSON_KEY_WARNINGS

See Also:

Constant Field Values

JSON_KEY_ERRORS

public static final String JSON_KEY_ERRORS

See Also:

Constant Field Values

logger

protected final org.apache.commons.logging.Log logger

Logger that can be used by subclasses.

repoAdminService

protected RepoAdminService repoAdminService

descriptorService

protected DescriptorService descriptorService

Constructor Detail

AbstractAdminWebScript

public AbstractAdminWebScript()

Method Detail

setRepoAdminService

public void setRepoAdminService(RepoAdminService repoAdminService)

Parameters:

repoAdminService - the service that provides the functionality

setDescriptorService

public void setDescriptorService(DescriptorService descriptorService)

Parameters:

descriptorService - the service that provides the functionality

getI18NMessage

protected String getI18NMessage(String key,
                                Object... args)

Return an I18N'd message for the given key or the key itself if not present

Parameters:

args - arguments to replace the variables in the message

putUsageInModel

protected void putUsageInModel(Map<String,Object> model,
                               RepoUsage repoUsage,
                               boolean updated)

Helper to assign JSON return variables based on the repository usage data.