|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.gentics.api.portalnode.action.GenericPluggableAction
public abstract class GenericPluggableAction
abstract base class for pluggable actions. implements basic functionality.
Field Summary | |
---|---|
protected org.apache.log4j.Logger |
logger
logger object used for output of log messages in pluggable actions |
Fields inherited from interface com.gentics.api.portalnode.action.PluggableAction |
---|
CONFIGURATION_ERROR, INCONSISTENT_ERROR |
Constructor Summary | |
---|---|
GenericPluggableAction()
|
Method Summary | |
---|---|
protected boolean |
assertRequiredParametersSet(PluggableActionRequest request,
java.lang.String[] requiredParameters)
Convenience method to check whether all required parameters are really set. |
protected boolean |
assertRequiredParametersSet(PluggableActionRequest request,
java.lang.String[] requiredParameters,
org.apache.log4j.Level logLevel)
Convenience method to check whether all required parameters are really set. |
void |
destroy()
Called by the view when the pluggable action is no longer used. |
protected PluggableActionContext |
getContext()
get the pluggable action context |
protected GenticsPortlet |
getModule()
get the module from the pluggable action context |
void |
init(PluggableActionContext context)
Initialize the pluggable action |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.gentics.api.portalnode.action.PluggableAction |
---|
processAction |
Field Detail |
---|
protected org.apache.log4j.Logger logger
Constructor Detail |
---|
public GenericPluggableAction()
Method Detail |
---|
public void init(PluggableActionContext context) throws PluggableActionException
PluggableAction
init
in interface PluggableAction
context
- context of the pluggable action
PluggableActionException
- when the action cannot be initialized
and shall not be processedpublic void destroy()
PluggableAction
destroy
in interface PluggableAction
protected GenticsPortlet getModule()
protected PluggableActionContext getContext()
protected boolean assertRequiredParametersSet(PluggableActionRequest request, java.lang.String[] requiredParameters, org.apache.log4j.Level logLevel)
request
- pluggable action request holding the parametersrequiredParameters
- array required parameter nameslogLevel
- log level for the generated messages
protected boolean assertRequiredParametersSet(PluggableActionRequest request, java.lang.String[] requiredParameters)
request
- pluggable action request holding the parametersrequiredParameters
- array required parameter names
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |