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

java.lang.Object
  extended by org.springframework.extensions.webscripts.AbstractWebScript
      extended by org.springframework.extensions.webscripts.DeclarativeWebScript
          extended by 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

Nested Class Summary
 
Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript
org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails
 
Field Summary
static java.lang.String JSON_KEY_DOCUMENTS
           
static java.lang.String JSON_KEY_ERRORS
           
static java.lang.String JSON_KEY_LAST_UPDATE
           
static java.lang.String JSON_KEY_LEVEL
           
static java.lang.String JSON_KEY_LICENSE_MODE
           
static java.lang.String JSON_KEY_LICENSE_VALID_UNTIL
           
static java.lang.String JSON_KEY_READ_ONLY
           
static java.lang.String JSON_KEY_UPDATED
           
static java.lang.String JSON_KEY_USERS
           
static java.lang.String JSON_KEY_WARNINGS
           
protected  org.apache.commons.logging.Log logger
          Logger that can be used by subclasses.
protected  org.alfresco.service.cmr.admin.RepoAdminService repoAdminService
           
 
Constructor Summary
AbstractAdminWebScript()
           
 
Method Summary
protected  java.lang.String getI18NMessage(java.lang.String key, java.lang.Object[] args)
          Return an I18N'd message for the given key or the key itself if not present
protected  void putUsageInModel(java.util.Map model, org.alfresco.service.cmr.admin.RepoUsage repoUsage, boolean updated)
          Helper to assign JSON return variables based on the repository usage data.
 void setRepoAdminService(org.alfresco.service.cmr.admin.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
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 java.lang.String JSON_KEY_LAST_UPDATE
See Also:
Constant Field Values

JSON_KEY_USERS

public static final java.lang.String JSON_KEY_USERS
See Also:
Constant Field Values

JSON_KEY_DOCUMENTS

public static final java.lang.String JSON_KEY_DOCUMENTS
See Also:
Constant Field Values

JSON_KEY_LICENSE_MODE

public static final java.lang.String JSON_KEY_LICENSE_MODE
See Also:
Constant Field Values

JSON_KEY_READ_ONLY

public static final java.lang.String JSON_KEY_READ_ONLY
See Also:
Constant Field Values

JSON_KEY_UPDATED

public static final java.lang.String JSON_KEY_UPDATED
See Also:
Constant Field Values

JSON_KEY_LICENSE_VALID_UNTIL

public static final java.lang.String JSON_KEY_LICENSE_VALID_UNTIL
See Also:
Constant Field Values

JSON_KEY_LEVEL

public static final java.lang.String JSON_KEY_LEVEL
See Also:
Constant Field Values

JSON_KEY_WARNINGS

public static final java.lang.String JSON_KEY_WARNINGS
See Also:
Constant Field Values

JSON_KEY_ERRORS

public static final java.lang.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 org.alfresco.service.cmr.admin.RepoAdminService repoAdminService
Constructor Detail

AbstractAdminWebScript

public AbstractAdminWebScript()
Method Detail

setRepoAdminService

public void setRepoAdminService(org.alfresco.service.cmr.admin.RepoAdminService repoAdminService)
Parameters:
repoAdminService - the service that provides the functionality

getI18NMessage

protected java.lang.String getI18NMessage(java.lang.String key,
                                          java.lang.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(java.util.Map model,
                               org.alfresco.service.cmr.admin.RepoUsage repoUsage,
                               boolean updated)
Helper to assign JSON return variables based on the repository usage data.



Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.