Module sharingPluginPlatform

Package org.codeability.sharing.plugins.api

Class SharingPluginConfig.Action

java.lang.Object

org.codeability.sharing.plugins.api.SharingPluginConfig.Action

Enclosing class:

SharingPluginConfig

public static class SharingPluginConfig.Action
extends Object

the actions that a plugin supports. It contains a name, a command name, and an importService URL (not a REST URL, but a callback via Browser redirect)

Author:

Michael Breu

Field Summary

Fields

Modifier and Type	Field	Description
String	actionId	the id of this action.
String	actionName	a descriptive name of the action.
String	actionTransferURL	the call back for this action (in order to be called back).
String	filterELExpression	a boolean expression on the exercise meta data to filter the relevant exercises for this action.

Constructor Summary

Constructors

Constructor	Description
Action()	empty constructor for JSON.
Action(String actionId, String actionTransferURL, String actionName, String filterELExpression)

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

actionId

public String actionId

the id of this action. An arbitrary String, unique for this plugin.

actionTransferURL

public String actionTransferURL

the call back for this action (in order to be called back). When the action is invoked the call back URL is extended by

1. the shoppingBasketToken
2. the apiBaseURL for a REST based callback as query parameter
3. the returnURL a URL that should be redirected to, to get back to the original application, as query parameter

e.g. http://localhost:8081/sharingImport/10e1a1b5-74da-43a9-80eb-67a2b9cd0f93?returnURL=http://localhost:8080&apiBaseURL=http://localhost:8080/api

actionName

public String actionName

a descriptive name of the action. For presentation to the end user. E.g. "Export to Artemis"

filterELExpression

public String filterELExpression

a boolean expression on the exercise meta data to filter the relevant exercises for this action. The expression is defined in java expression language (see https://docs.oracle.com/javaee/6/tutorial/doc/gjddd.html). e.g. "metadata.type.externalName=='programming exercise"

Constructor Details

Action

public Action(String actionId,
 String actionTransferURL,
 String actionName,
 String filterELExpression)

Parameters:

actionName - the name of the action

actionTransferURL - the transfer url, to which the action should forward the browser to

actionId - the id of the action

filterELExpression - some filter expression in the EL expression language

Action

public Action()

empty constructor for JSON.