org.springframework.extensions.webscripts.Status

/**
 * Execute custom Java logic
 *
 * @param req  Web Script request
 * @param status Web Script status
 * @return  custom service model
 * @deprecated
 */
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status) {
    return executeImpl(req, new WebScriptStatus(status));
}

@Override
protected boolean validateRequest(WebScriptRequest req, Status status) {
    return true;
}

@Override
protected boolean validateRequest(WebScriptRequest req, Status status) {
    // TODO Auto-generated method stub
    return false;
}

@Override
protected boolean validateRequest(WebScriptRequest reg, Status status) {
    return false;
}

@Override
protected boolean validateRequest(WebScriptRequest req, Status status) {
    // TODO Auto-generated method stub
    return true;
}

/**
 * Execute custom Java logic to clean up any resources
 *
 * @param req    Web Script request
 * @param status Web Script status
 * @param cache  Web Script cache
 * @param model  model
 */
private void executeFinallyImpl(WebScriptRequest req, Status status, Cache cache, Map<String, Object> model) {
// This method left intentionally empty
}

/**
 * Execute custom Java logic
 *
 * @param req    Web Script request
 * @param status Web Script status
 * @param cache  Web Script cache
 * @return custom service model
 */
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    return null;
}

/**
 * Execute custom Java logic
 *
 * @param  req  Web Script request
 * @param  status Web Script status
 * @param  cache  Web Script cache
 * @return  custom service model
 */
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    // NOTE: Redirect to those web scripts implemented before cache support and v2.9
    return executeImpl(req, status);
}

@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    WorkspacesPost instance = new WorkspacesPost(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

@Override
protected boolean validateRequest(WebScriptRequest req, Status status) {
    String projectId = getProjectId(req);
    String refId = getRefId(req);
    EmsNodeUtil emsNodeUtil = new EmsNodeUtil(projectId, refId);
    String orgId = emsNodeUtil.getOrganizationFromProject(projectId);
    return checkRequestContent(req) && SitePermission.hasPermissionToBranch(orgId, projectId, refId);
}

/**
 * Validate the request and check some permissions
 */
@Override
protected boolean validateRequest(WebScriptRequest req, Status status) {
    return checkRequestContent(req);
}

@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    WorkspaceGet instance = new WorkspaceGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Webscript entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    SiteGet instance = new SiteGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Validate the request and check some permissions
 */
@Override
protected boolean validateRequest(WebScriptRequest req, Status status) {
    String id = req.getServiceMatch().getTemplateVars().get(REF_ID);
    return checkRequestContent(req) && checkRequestVariable(id, REF_ID);
}

/**
 * Webscript entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    ProjectPost instance = new ProjectPost(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Webscript entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    ProjectDelete instance = new ProjectDelete(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Webscript entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    OrgPost instance = new OrgPost(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Webscript entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    OrgGet instance = new OrgGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

@Override
protected boolean validateRequest(WebScriptRequest req, Status status) {
    String elementId = req.getServiceMatch().getTemplateVars().get("elementid");
    if (elementId != null && !checkRequestVariable(elementId, "elementid")) {
        return false;
    }
    return checkRequestContent(req);
}

/**
 * Entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    MovePost instance = new MovePost(repository, services);
    instance.setServices(getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    MountsGet instance = new MountsGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    ModelSearch instance = new ModelSearch(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    ModelPost instance = new ModelPost(repository, services);
    instance.setServices(getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    ModelGet instance = new ModelGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    ModelDelete instance = new ModelDelete(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    HtmlConverterPost instance = new HtmlConverterPost(repository, services);
    return instance.executeImplImpl(req, status, cache);
}

@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    HistoryGet instance = new HistoryGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Validate the request and check some permissions
 */
@Override
protected boolean validateRequest(WebScriptRequest req, Status status) {
    return true;
}

/**
 * Entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    CfIdsGet instance = new CfIdsGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    ArtifactPost instance = new ArtifactPost(repository, services);
    instance.setServices(getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    ArtifactDelete instance = new ArtifactDelete(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Checks whether the user making the web request (not the run-as user) has permissions to the
 * node and logs results and status as appropriate. If a response object is supplied, a warning
 * is generated when the user does not have the permission.
 *
 * @param permissions Permissions to check
 * @param response
 * @param status
 * @return true if user has specified permissions to node, false otherwise
 */
public boolean checkPermissions(String permissions, StringBuffer response, Status status) {
    if (!hasPermission(permissions)) {
        if (response != null) {
            // replacedume admin role to make sure getProperty() doesn't fail
            // because of permissions.
            String runAsUser = AuthenticationUtil.getRunAsUser();
            boolean changeUser = !ADMIN_USER_NAME.equals(runAsUser);
            if (changeUser) {
                AuthenticationUtil.setRunAsUser(ADMIN_USER_NAME);
            }
            // Get sysmlid
            Object property = getProperty(Acm.CM_NAME);
            // Return to original running user.
            if (changeUser) {
                AuthenticationUtil.setRunAsUser(runAsUser);
            }
            // Log warning for missing permissions.
            if (property != null) {
                String msg = String.format("Warning! No %s privileges to sysmlid: %s.", permissions.toUpperCase(), property.toString());
                response.append(msg);
                if (status != null) {
                    status.setCode(HttpServletResponse.SC_FORBIDDEN, msg);
                }
            }
        }
        return false;
    }
    return true;
}

@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    ReplicationModelBuilder modelBuilder = new ReplicationModelBuilder(nodeService, replicationService, actionTrackingService);
    return buildModel(modelBuilder, req, status, cache);
}

@Override
protected Map<String, Object> executeImpl(final WebScriptRequest req, final Status status, final Cache cache) {
    // Allow all authenticated users in
    return unprotectedExecuteImpl(req, status, cache);
}

@Override
protected Map<String, Object> executeImpl(final WebScriptRequest req, final Status status, final Cache cache) {
    validateCurrentUser();
    return unprotectedExecuteImpl(req, status, cache);
}

/* (non-Javadoc)
     * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse)
     */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status) {
    return null;
}

/**
 * Entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    WorkspacesGet instance = new WorkspacesGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    WorkspaceHistoryGet instance = new WorkspaceHistoryGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

@Override
protected boolean validateRequest(WebScriptRequest req, Status status) {
    String wsId = req.getServiceMatch().getTemplateVars().get(REF_ID);
    return checkRequestContent(req) && checkRequestVariable(wsId, REF_ID);
}

@Override
protected boolean validateRequest(WebScriptRequest req, Status status) {
    String wsId = req.getServiceMatch().getTemplateVars().get(REF_ID);
    return checkRequestVariable(wsId, REF_ID);
}

@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    WorkspaceDelete instance = new WorkspaceDelete(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Webscript entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    UserPreferencesPost instance = new UserPreferencesPost(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Webscript entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    UserPreferencesGet instance = new UserPreferencesGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Webscript entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    OrgDelete instance = new OrgDelete(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    ModelsGet instance = new ModelsGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    ModelIdsGet instance = new ModelIdsGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

@Override
protected boolean validateRequest(WebScriptRequest req, Status status) {
    // get timestamp if specified
    String timestamp = req.getParameter("timestamp");
    Date dateTime = TimeUtils.dateFromTimestamp(timestamp);
    String refId = getRefId(req);
    String projectId = getProjectId(req);
    EmsNodeUtil emsNodeUtil = new EmsNodeUtil(projectId, refId);
    if (refId != null && refId.equalsIgnoreCase(NO_WORKSPACE_ID)) {
        return true;
    } else if (refId != null && !emsNodeUtil.refExists(refId)) {
        log(Level.ERROR, HttpServletResponse.SC_NOT_FOUND, "Reference with id, %s not found", refId + (dateTime == null ? "" : " at " + dateTime));
        return false;
    }
    return true;
}

/**
 * Webscript entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    MmsVersion instance = new MmsVersion(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

/**
 * Webscript entry point
 */
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    MigrateGet instance = new MigrateGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) {
    HostnameGet instance = new HostnameGet(repository, getServices());
    return instance.executeImplImpl(req, status, cache);
}

See More Examples