Package edu.internet2.middleware.grouper.app.gsh.template

Class GshTemplateExec

java.lang.Object

edu.internet2.middleware.grouper.app.gsh.template.GshTemplateExec

public class GshTemplateExec
extends Object

Use this class to execute a custom gsh template

Sample call

 GshTemplateExec exec = new GshTemplateExec();
 exec.assignConfigId("testGshTemplateConfig");
 exec.assignCurrentUser(subject);
 exec.assignGshTemplateOwnerType(GshTemplateOwnerType.stem);
 exec.assignOwnerStemName(ownerStem.getName());
 GshTemplateInput input = new GshTemplateInput();
 input.assignName("gsh_input_myExtension");
 input.assignValueString("zoomTest");
 exec.addGshTemplateInput(input);
 GshTemplateExecOutput output = exec.execute();
 if (output.getGshTemplateOutput().isError()) {
   // handle this... e.g. from another template: gsh_builtin_gshTemplateOutput.addOutputLine("Error running sub-template");
 }
 if (GrouperUtil.length(output.getGshTemplateOutput().getValidationLines()) > 0) {
   for (GshValidationLine gshValidationLine : output.getGshTemplateOutput().getValidationLines()) {
     // handle this... e.g. from another template 
     // gsh_builtin_gshTemplateOutput.addOutputLine((String)(gshValidationLine.getInputName() + ": " + gshValidationLine.getText()));
   }
 }
 

Constructor Summary

Constructors

Constructor	Description
GshTemplateExec()

Method Summary

Modifier and Type	Method	Description
GshTemplateExec	addGshTemplateInput(GshTemplateInput input)
GshTemplateExec	assignActAsSubject(Subject actAsSubject)
GshTemplateExec	assignConfigId(String configId)
GshTemplateExec	assignCurrentUser(Subject currentUser)
GshTemplateExec	assignGshTemplateOwnerType(GshTemplateOwnerType gshTemplateOwnerType)
GshTemplateExec	assignOwnerGroupName(String ownerGroupName)
GshTemplateExec	assignOwnerStemName(String ownerStemName)
GshTemplateExec	assignRemoteAddr(String remoteAddr)
GshTemplateExec	assignWsInput(Map<String,Object> wsInput)	arbitrary wsInput
GshTemplateExecOutput	execute()	execute the gsh template
GshTemplateV2	executeForTemplateV2instance()	execute the gsh template (calls newInstance).
Subject	getActAsSubject()
String	getConfigId()
Subject	getCurrentUser()
GrouperGroovyRuntime	getGrouperGroovyRuntime()	pass in so you have a reference
GshTemplateExecOutput	getGshTemplateExecOutput()	store the output
List<GshTemplateInput>	getGshTemplateInputs()
GshTemplateOwnerType	getGshTemplateOwnerType()
String	getOwnerGroupName()
String	getOwnerStemName()
ProgressBean	getProgressBean()	have a progress bean to be able to communicate progress to the UI
String	getRemoteAddr()
Map<String,Object>	getWsInput()	arbitrary wsInput
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Constructor Details

GshTemplateExec

public GshTemplateExec()

Method Details

getWsInput

public Map<String,Object> getWsInput()

arbitrary wsInput

Returns:

assignWsInput

public GshTemplateExec assignWsInput(Map<String,Object> wsInput)

arbitrary wsInput

Parameters:

wsInput -

getGrouperGroovyRuntime

public GrouperGroovyRuntime getGrouperGroovyRuntime()

pass in so you have a reference

Returns:

getProgressBean

public ProgressBean getProgressBean()

have a progress bean to be able to communicate progress to the UI

Returns:

the progressBean

getRemoteAddr

public String getRemoteAddr()

assignRemoteAddr

public GshTemplateExec assignRemoteAddr(String remoteAddr)

main

public static void main(String[] args)

assignActAsSubject

public GshTemplateExec assignActAsSubject(Subject actAsSubject)

assignGshTemplateOwnerType

public GshTemplateExec assignGshTemplateOwnerType(GshTemplateOwnerType gshTemplateOwnerType)

assignOwnerStemName

public GshTemplateExec assignOwnerStemName(String ownerStemName)

assignOwnerGroupName

public GshTemplateExec assignOwnerGroupName(String ownerGroupName)

addGshTemplateInput

public GshTemplateExec addGshTemplateInput(GshTemplateInput input)

assignConfigId

public GshTemplateExec assignConfigId(String configId)

assignCurrentUser

public GshTemplateExec assignCurrentUser(Subject currentUser)

getCurrentUser

public Subject getCurrentUser()

getGshTemplateOwnerType

public GshTemplateOwnerType getGshTemplateOwnerType()

getOwnerStemName

public String getOwnerStemName()

getOwnerGroupName

public String getOwnerGroupName()

getGshTemplateInputs

public List<GshTemplateInput> getGshTemplateInputs()

getConfigId

public String getConfigId()

getActAsSubject

public Subject getActAsSubject()

getGshTemplateExecOutput

public GshTemplateExecOutput getGshTemplateExecOutput()

store the output

Returns:

the output

execute

public GshTemplateExecOutput execute()

execute the gsh template

Returns:

executeForTemplateV2instance

public GshTemplateV2 executeForTemplateV2instance()

execute the gsh template (calls newInstance).

Returns: