org.apache.clerezza.platform.scripting.scriptmanager

Class ScriptManager

java.lang.Object

org.apache.clerezza.platform.scripting.scriptmanager.ScriptManager

All Implemented Interfaces:

GlobalMenuItemsProvider

@Services(value={@Service(value=java.lang.Object.class),@Service(value=GlobalMenuItemsProvider.class)})
@Property(name="javax.ws.rs",
          boolValue=true)
public class ScriptManager
extends Object
implements GlobalMenuItemsProvider

Script Manager (/admin/scripting) Allows to install, delete, edit and execute script using a web front end. Also enables creating and deleting of execution URIs for scripts.

Author:

daniel, marc

Constructor Summary

Constructors

Constructor and Description
ScriptManager()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext componentContext) Called when bundle is activated.
javax.ws.rs.core.Response	addExecutionUri(UriRef scriptUri, String generatedResourceUri, javax.ws.rs.core.UriInfo uriInfo) Adds a specified execution URI to a specified script.
javax.ws.rs.core.Response	deleteExecutionUri(UriRef scriptUri, UriRef generatedResourceUri) Deletes a specified executionUri for a given script.
javax.ws.rs.core.Response	deleteScript(String script) Deletes a script.
Object	executeScript(String script) Executes a script.
GraphNode	getExecutionUriOverview() Execution Uri overview page.
GraphNode	getExecutionUris(UriRef script) Returns the executionURIs as RdfList in a GraphNode.
Set<GlobalMenuItem>	getMenuItems() Returns a Set of GlobalMenuItemS.
GraphNode	getScript(UriRef scriptUri) Returns a selected script node which has a property that points to the specified script resource and conains the decoded script code and the available script languages.
GraphNode	getScriptList(UriRef uriRef) Returns the menu with available scripts as GraphNode.
org.wymiwyg.commons.util.dirbrowser.PathNode	getStaticFile(String path) Returns a PathNode of a static file from the staticweb folder.
GraphNode	install() The page that contains the install form.
javax.ws.rs.core.Response	installScript(MultiPartBody form, javax.ws.rs.core.UriInfo uriInfo) Installs a script.
GraphNode	overview(UriRef script) The overview page.
javax.ws.rs.core.Response	redirectToOverviewPage(javax.ws.rs.core.UriInfo uriInfo) Redirects to the overview page
javax.ws.rs.core.Response	updateScript(MultiPartBody form, javax.ws.rs.core.UriInfo uriInfo) Updates a script.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptManager

public ScriptManager()

Method Detail

activate

protected void activate(org.osgi.service.component.ComponentContext componentContext)
                 throws IOException,
                        URISyntaxException

Called when bundle is activated. Registers templates.

Parameters:

componentContext - the context.

Throws:

IOException

URISyntaxException

redirectToOverviewPage

public javax.ws.rs.core.Response redirectToOverviewPage(@Context
                                               javax.ws.rs.core.UriInfo uriInfo)

Redirects to the overview page

Returns:

Redirect to overview page.

overview

public GraphNode overview(UriRef script)

The overview page.

Parameters:

the - script URI

Returns:

Graphnode containing ScriptManagerOverviewPage.

getScript

public GraphNode getScript(UriRef scriptUri)

Returns a selected script node which has a property that points to the specified script resource and conains the decoded script code and the available script languages.

Parameters:

scriptUri - the URI of the script resource.

Returns:

GraphNode containing the selected script.

See Also:

SCRIPTMANAGER.SelectedScript

getScriptList

public GraphNode getScriptList(UriRef uriRef)

Returns the menu with available scripts as GraphNode.

Parameters:

resource - The resource to which to attach the list.

Returns:

GraphNode containing all available script resources.

install

public GraphNode install()

The page that contains the install form.

Returns:

a Graphnode containing a ScriptManagerInstallPage.

installScript

public javax.ws.rs.core.Response installScript(MultiPartBody form,
                                      @Context
                                      javax.ws.rs.core.UriInfo uriInfo)

Installs a script.

Parameters:

form - the install form containing the script data.

Returns:

BAD_REQUEST on invalid data, redirect to overview page otherwise.

updateScript

public javax.ws.rs.core.Response updateScript(MultiPartBody form,
                                     @Context
                                     javax.ws.rs.core.UriInfo uriInfo)

Updates a script.

Parameters:

form - the update form containing the script data.

Returns:

Redirect to overview page.

deleteScript

public javax.ws.rs.core.Response deleteScript(String script)

Deletes a script.

Parameters:

script - the script URI.

Returns:

CREATED Responce if script has been deleted.

getExecutionUriOverview

public GraphNode getExecutionUriOverview()

Execution Uri overview page.

Returns:

A Graphnode containing a ExecutionUriOverviewPage.

getExecutionUris

public GraphNode getExecutionUris(UriRef script)

Returns the executionURIs as RdfList in a GraphNode.

Parameters:

script - The script URI for which to show its execution URIs.

Returns:

A Graphnode containing a ExecutionUriList.

addExecutionUri

public javax.ws.rs.core.Response addExecutionUri(UriRef scriptUri,
                                        String generatedResourceUri,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo)

Adds a specified execution URI to a specified script.

Parameters:

scriptUri - the URI of the script to which the execution URI should be added.

generatedResourceUri - the execution URI to add.

Returns:

Redirect to execution uri overview page.

deleteExecutionUri

public javax.ws.rs.core.Response deleteExecutionUri(UriRef scriptUri,
                                           UriRef generatedResourceUri)

Deletes a specified executionUri for a given script.

Parameters:

scriptUri - The URI of the script to which the execution URI belongs.

generatedResourceUri - The execution URI to delete.

Returns:

A CREATED response if the execution URI could be deleted.

executeScript

public Object executeScript(String script)

Executes a script.

Parameters:

script - The script URI of the script that should be executed.

Returns:

The script return value. Can be GraphNode or a response with the media type of the script output.

Throws:

NoEngineException - If no engine can be found to execute the script.

javax.script.ScriptException - If an error occurs while executing the script.

See Also:

ScriptExecution.execute( org.apache.clerezza.rdf.core.NonLiteral, javax.script.Bindings)

getStaticFile

public org.wymiwyg.commons.util.dirbrowser.PathNode getStaticFile(String path)

Returns a PathNode of a static file from the staticweb folder.

Returns:

PathNode

getMenuItems

public Set<GlobalMenuItem> getMenuItems()

Description copied from interface: GlobalMenuItemsProvider

Returns a Set of GlobalMenuItemS. If there is no GlobalMenuItem available (e.g. the current user has not the needed permissions) then the returned set is empty.

Specified by:

getMenuItems in interface GlobalMenuItemsProvider

Returns: