ilog.views.util.servlet

Class IlvAbstractServerActionParser

java.lang.Object

ilog.views.util.servlet.IlvAbstractServerActionParser

Direct Known Subclasses:

IlvChartServerActionParser, IlvGanttServerActionsParser, IlvServerActionParser

public abstract class IlvAbstractServerActionParser
extends Object

The abstract server action parser.

Since:

JViews 8.8

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ITEM_END The constant for representing "]".
protected static String	ITEM_START The constant for representing "[".
protected static Logger	LOG The Logger instance for class.
static String	SERVER_ACTIONS_INIT_PARAM The parameter that used to configure in web.xml for servlets.

Constructor Summary

Constructors

Constructor and Description
IlvAbstractServerActionParser() The default constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addServerAction(String actionName, EventListener actionListener) Add server action listener to servlet support.
protected abstract Map<String,IlvEventListenerCollection<EventListener>>	getActionTable() Gets the action table of servlet support.
protected abstract IlvServletSupport	getServletSupport() Gets the servlet support.
void	parserServerActionAnnotation(jakarta.servlet.http.HttpServlet servlet) This method is used to parser the annotations of servlet for dynamically configure the server action listeners.
void	parserServerActionWebXML(jakarta.servlet.ServletConfig config) Parser the server action from web.xml configuration.
protected abstract void	removeServerAction(String actionName, EventListener actionListener) Remove server action listener from servlet support.

Methods inherited from class java.lang.Object

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

Field Detail

ITEM_END

protected static final String ITEM_END

The constant for representing "]".

See Also:

Constant Field Values

ITEM_START

protected static final String ITEM_START

The constant for representing "[".

See Also:

Constant Field Values

SERVER_ACTIONS_INIT_PARAM

public static final String SERVER_ACTIONS_INIT_PARAM

The parameter that used to configure in web.xml for servlets.

See Also:

Constant Field Values

LOG

protected static final Logger LOG

The Logger instance for class.

Constructor Detail

IlvAbstractServerActionParser

public IlvAbstractServerActionParser()

The default constructor.

Method Detail

parserServerActionAnnotation

public final void parserServerActionAnnotation(jakarta.servlet.http.HttpServlet servlet)

This method is used to parser the annotations of servlet for dynamically configure the server action listeners.
For example:

@IlvServerActions(parameters={
@IlvServerActionParam(actionName=YourServerAction.NOT_EXIST,actionListener=YourServerAction.class),
@IlvServerActionParam(actionName=YourServerAction.EXIST,actionListener=MyServerAction.class),
@IlvServerActionParam(actionName=YourServerAction.EXIST))
})
public class YourServlet{...}

• If IlvServerActionParam#actionName is not exit in IlvChartServletSupport#getActionTable, then will addIlvServerActionParam#actionListener instance into server action listener list.
• If IlvServerActionParam#actionName is exit in IlvChartServletSupport#getActionTable, then the IlvServerActionParam#actionListener instance will replace the old action listener.
• If IlvServerActionParam#actionName is exit in IlvChartServletSupport#getActionTable, and IlvServerActionParam#actionListener is default value Object.class, then will remove the server action lister which used to deal with IlvServerActionParam#name action.

Parameters:

servlet - The HttpServlet object.

parserServerActionWebXML

public void parserServerActionWebXML(jakarta.servlet.ServletConfig config)

Parser the server action from web.xml configuration.

For example:
<init-param>
<param-name>serverActions</param-name>
<param-value>
[beforeZoom,bank.MyZoomActionListener]
[facesSelectAction, ]
[]
</param-value>
</init-param>

Parameters:

config - the ServletConfig object.

getActionTable

protected abstract Map<String,IlvEventListenerCollection<EventListener>> getActionTable()

Gets the action table of servlet support.

getServletSupport

protected abstract IlvServletSupport getServletSupport()

Gets the servlet support.

addServerAction

protected abstract void addServerAction(String actionName,
                                        EventListener actionListener)

Add server action listener to servlet support.

Parameters:

actionName - The action name.

actionListener - The action listener.

removeServerAction

protected abstract void removeServerAction(String actionName,
                                           EventListener actionListener)

Remove server action listener from servlet support.

Parameters:

actionName - The action name.

actionListener - The action listener.