How to use

getDescription

method

in

org.springframework.extensions.webscripts.WebScript

/**
 * Associate Web Script with Path
 * 
 * @param script
 */
public void addScript(WebScript script)
{
  scripts.put(script.getDescription().getId(), script);
}

/**
 * Associate Web Script with Path
 * 
 * @param script WebScript
 */
public void addScript(WebScript script)
{
  scripts.put(script.getDescription().getId(), script);
}

/**
 * Associate Web Script with Path
 * 
 * @param script WebScript
 */
public void addScript(WebScript script)
{
  scripts.put(script.getDescription().getId(), script);
}

public String[] getScriptDocumentPaths(WebScript script) throws IOException
{
  String scriptPaths = script.getDescription().getId() + ".*";
  return getDocumentPaths("/", false, scriptPaths);
}

public String[] getScriptDocumentPaths(WebScript script)
{
  String scriptPaths = script.getDescription().getId() + ".*";
  return getDocumentPathsByRegEx("/", scriptPaths, false);
}

public String[] getScriptDocumentPaths(WebScript script) throws IOException
{
  String scriptPaths = script.getDescription().getId() + ".*";
  return getDocumentPaths("/", false, scriptPaths);
}

public String[] getScriptDocumentPaths(WebScript script) throws IOException
{
  String scriptPaths = script.getDescription().getId() + ".*";
  return getDocumentPaths("/", false, scriptPaths);
}

public String[] getScriptDocumentPaths(WebScript script)
{
  String scriptPaths = script.getDescription().getId() + ".*";
  return getDocumentPathsByRegEx("/", scriptPaths, false);
}

public String[] getScriptDocumentPaths(WebScript script)
{
  String scriptPaths = script.getDescription().getId() + ".*";
  return getDocumentPaths("", false, scriptPaths);
}

public String[] getScriptDocumentPaths(WebScript script)
{
  String scriptPaths = script.getDescription().getId() + ".*";
  return getDocumentPaths("", false, scriptPaths);
}

public String[] getScriptDocumentPaths(WebScript script) throws IOException
{
  String scriptPaths = script.getDescription().getId() + ".*";
  return getDocumentPaths("/", false, scriptPaths);
}

public String[] getScriptDocumentPaths(WebScript script)
{
  String scriptPaths = script.getDescription().getId() + ".*";
  return getDocumentPaths("", false, scriptPaths);
}

public String[] getScriptDocumentPaths(WebScript script) throws IOException
{
  String scriptPaths = script.getDescription().getId() + ".*";
  return getDocumentPaths("/", false, scriptPaths);
}

/**
 * Register a lifecycle
 * 
 * @param script WebScript
 */
private void registerLifecycle(WebScript script)
{
  Description desc = script.getDescription();
  Lifecycle lifecycle = desc.getLifecycle();
      PathImpl path = lifecycleByPath.get("/");
  PathImpl subpath = lifecycleByPath.get(PathImpl.concatPath(path.getPath(), lifecycle.toString()));
  if (subpath == null)
  {
     subpath = path.createChildPath(lifecycle.toString());
     lifecycleByPath.put(subpath.getPath(), subpath);
  }          
  subpath.addScript(script);
}

@Override
protected void executeScript(WebScriptRequest scriptReq, WebScriptResponse scriptRes, Authenticator auth)
  throws IOException
{
  // Set Portlet title based on Web Script
  WebScript script = scriptReq.getServiceMatch().getWebScript();
  Description desc = script.getDescription();
  res.setTitle(desc.getShortName());
  // Note: Do not render script if portlet window is minimized
  if (!WindowState.MINIMIZED.equals(req.getWindowState()))
  {
    super.executeScript(scriptReq, scriptRes, auth);
  }
}

@Override
protected void executeScript(WebScriptRequest scriptReq, WebScriptResponse scriptRes, Authenticator auth)
  throws IOException
{
  // Set Portlet title based on Web Script
  WebScript script = scriptReq.getServiceMatch().getWebScript();
  Description desc = script.getDescription();
  res.setTitle(desc.getShortName());
  // Note: Do not render script if portlet window is minimized
  if (!WindowState.MINIMIZED.equals(req.getWindowState()))
  {
    super.executeScript(scriptReq, scriptRes, auth);
  }
}

public void executeScript(WebScriptRequest scriptReq, WebScriptResponse scriptRes, Authenticator auth)
  throws IOException
{
  // Handle authentication of scripts on a case-by-case basis.
  // Currently we assume that if a webscript servlet has any authenticator
  // applied then it must be for some kind of remote user auth as supplied.
  WebScript script = scriptReq.getServiceMatch().getWebScript();
  script.setURLModelFactory(getUrlModelFactory());
  Description desc = script.getDescription();
  RequiredAuthentication required = desc.getRequiredAuthentication();
  if (auth == null || RequiredAuthentication.none == required || auth.authenticate(required, false))
  {
    script.execute(scriptReq, scriptRes);
  }
}

@Override
protected void executeScript(WebScriptRequest scriptReq, WebScriptResponse scriptRes, Authenticator auth)
  throws IOException
{
  // Set Portlet title based on Web Script
  WebScript script = scriptReq.getServiceMatch().getWebScript();
  Description desc = script.getDescription();
  res.setTitle(desc.getShortName());
  // Note: Do not render script if portlet window is minimized
  if (!WindowState.MINIMIZED.equals(req.getWindowState()))
  {
    super.executeScript(scriptReq, scriptRes, auth);
  }
}

public void executeScript(WebScriptRequest scriptReq, WebScriptResponse scriptRes, Authenticator auth)
  throws IOException
{
  // Handle authentication of scripts on a case-by-case basis.
  // Currently we assume that if a webscript servlet has any authenticator
  // applied then it must be for some kind of remote user auth as supplied.
  WebScript script = scriptReq.getServiceMatch().getWebScript();
  script.setURLModelFactory(getUrlModelFactory());
  Description desc = script.getDescription();
  RequiredAuthentication required = desc.getRequiredAuthentication();
  if (auth == null || RequiredAuthentication.none == required || auth.authenticate(required, false))
  {
    script.execute(scriptReq, scriptRes);
  }
}

public void executeScript(WebScriptRequest scriptReq, WebScriptResponse scriptRes, Authenticator auth)
  throws IOException
{
  // Handle authentication of scripts on a case-by-case basis.
  // Currently we assume that if a webscript servlet has any authenticator
  // applied then it must be for some kind of remote user auth as supplied.
  WebScript script = scriptReq.getServiceMatch().getWebScript();
  script.setURLModelFactory(getUrlModelFactory());
  Description desc = script.getDescription();
  RequiredAuthentication required = desc.getRequiredAuthentication();
  if (auth == null || RequiredAuthentication.none == required || auth.authenticate(required, false))
  {
    script.execute(scriptReq, scriptRes);
  }
}