com.alveole.studio.web.managers.struts2editor
Class Struts2Tools

java.lang.Object
  com.alveole.studio.web.managers.struts2editor.Struts2Tools

public class Struts2Tools
extends java.lang.Object

This toolkit class performs some help methods on Struts2 specific plugins.

Author:

sylvain

Field Summary

static java.lang.String[]	defaultStruts2Interceptors Default Struts2 interceptors.
static java.lang.String[]	defaultStruts2ResultTypes Default Struts2 result-types.
static java.lang.String	pluginID This plugin ID.
static java.lang.String	xmlns XML namespace for this service.

Constructor Summary

Struts2Tools()

Method Summary

static org.w3c.dom.Element	createPackage(org.w3c.dom.Element strutsElementContainer, java.lang.String name, java.lang.String namespace, java.lang.String parent) Creates a new package.
static java.util.ArrayList<org.w3c.dom.Element>	getAllInheritedGlobalResults(org.w3c.dom.Element strutsElementContainer, org.w3c.dom.Element pack) Get a list of available result globally defined for package, including inherited ones.
static java.lang.String[]	getAllInheritedGlobalResultsNames(org.w3c.dom.Element strutsElementContainer, org.w3c.dom.Element pack) Get a list of all available globally defined results' names in a given package.
static java.util.ArrayList<org.w3c.dom.Element>	getAllInheritedInterceptors(org.w3c.dom.Element strutsElementContainer, org.w3c.dom.Element pack) Get a list of available interceptors for the given package including inherited ones.
static java.lang.String[]	getAllInheritedInterceptorsNames(org.w3c.dom.Element strutsElementContainer, org.w3c.dom.Element pack) Get a list of all available interceptors' names in a given package.
static java.lang.String[]	getAllInheritedInterceptorsNamesWithDefaults(org.w3c.dom.Element strutsElementContainer, org.w3c.dom.Element pack) Get a list of all available interceptors' names in a given package.
static java.util.ArrayList<org.w3c.dom.Element>	getAllInheritedResultTypes(org.w3c.dom.Element strutsElementContainer, org.w3c.dom.Element pack) Get a list of available result-types for the given package including inherited ones.
static java.lang.String[]	getAllInheritedResultTypesNames(org.w3c.dom.Element strutsElementContainer, org.w3c.dom.Element pack) Get a list of all available result-types' names in a given package.
static java.lang.String[]	getAllInheritedResultTypesNamesWithDefaults(org.w3c.dom.Element strutsElementContainer, org.w3c.dom.Element pack) Get a list of all available result-types' names in a given package.
static org.w3c.dom.Element[]	getBeanElements(org.w3c.dom.Element beans) Get all beans.
static org.w3c.dom.Element	getBeansElement(org.w3c.dom.Element struts2base) Get beans.
static org.w3c.dom.Element[]	getConstantElements(org.w3c.dom.Element constants) Get all constants.
static org.w3c.dom.Element	getConstantsElement(org.w3c.dom.Element struts2base) Get constants.
static org.w3c.dom.Element	getDeclaredDefaultInterceptor(org.w3c.dom.Element pack) Get the default interceptor-ref in the given package, if defined.
static org.w3c.dom.Element	getDefaultActionRef(org.w3c.dom.Element pack) Get the default-action-ref in the given package, if defined.
static java.lang.String	getDefaultPackage(org.w3c.dom.Element strutsElementContainer) Get default package name.
static java.lang.String[]	getDefinedPackages(org.w3c.dom.Element strutsElementContainer) Gets a list of all struts 2 defined packages.
static java.lang.String	getDirectTextContents(org.w3c.dom.Node tag) Get Text direct contents of a node.
static org.w3c.dom.Element[]	getGlobalExceptionMappingElements(org.w3c.dom.Element globalex) Get all global exception mappings defined inside a global-exception-mappings element.
static org.w3c.dom.Element	getGlobalExceptionMappingsElement(org.w3c.dom.Element pack) Get global-exception-mappings.
static org.w3c.dom.Element[]	getGlobalResultElements(org.w3c.dom.Element globalresults) Get all global results defined inside a global-results element.
static org.w3c.dom.Element	getGlobalResultsElement(org.w3c.dom.Element pack) Get all global-results.
static org.w3c.dom.Element[]	getInterceptorRefs(org.w3c.dom.Element stack) Get all interceptor-refs from a stack.
static org.w3c.dom.Element[]	getInterceptorsAndStacks(org.w3c.dom.Element pack) Get all interceptors from a package.
static org.w3c.dom.Element	getInterceptorsElement(org.w3c.dom.Element pack) Get all interceptors.
static javax.xml.namespace.NamespaceContext	getNsContext() Gets a namespace context.
static javax.xml.namespace.NamespaceContext	getNSContext() Gets Struts2 namespace context.
static org.w3c.dom.Element	getPackageByName(org.w3c.dom.Element strutsElementContainer, java.lang.String name) Get default package name.
static java.lang.String	getPackageName(org.w3c.dom.Element pack) Get package name.
static org.w3c.dom.Element[]	getPackagesElements(org.w3c.dom.Element strutsElementContainer) Get all packages.
static java.lang.String[][]	getParameters(org.w3c.dom.Element parent) Get a list of parameters, given a parent tag.
static org.w3c.dom.Element[]	getResultTypes(org.w3c.dom.Element resultTypes) Get all result-type elements.
static org.w3c.dom.Element	getResultTypesElement(org.w3c.dom.Element pack) Get all result-types.
static org.w3c.dom.Element	getStruts2Properties(ProjectContext context) Get the XML element that stores specific Struts2 properties.
static java.lang.String	getTextContents(org.w3c.dom.Node tag) Get Text contents of a node.
static org.eclipse.core.runtime.IPath	getWebContents(ProjectContext ctx) Get WebContents directory, given a project.
static void	initializeFirstAlveolePackage(org.w3c.dom.Element strutsElementContainer) Initializes first default alveole package.
static boolean	isDefaultPackage(org.w3c.dom.Element strutsElementContainer, org.w3c.dom.Element pack) Check wether a given package is the default one.
static boolean	isDefaultPackage(org.w3c.dom.Element strutsElementContainer, java.lang.String name) Check wether a given package is the default one.
static void	setDefaultPackage(org.w3c.dom.Element strutsElementContainer, java.lang.String name) Get default package name.
static void	setParameters(org.w3c.dom.Element parent, java.lang.String[][] params) Sets a list of parameters, given a parent tag.

Methods inherited from class java.lang.Object

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

Field Detail

defaultStruts2Interceptors

public static final java.lang.String[] defaultStruts2Interceptors

Default Struts2 interceptors.

defaultStruts2ResultTypes

public static final java.lang.String[] defaultStruts2ResultTypes

Default Struts2 result-types.

pluginID

public static final java.lang.String pluginID

This plugin ID.

See Also:

Constant Field Values

xmlns

public static final java.lang.String xmlns

XML namespace for this service.

See Also:

Constant Field Values

Constructor Detail

Struts2Tools

public Struts2Tools()

Method Detail

getWebContents

public static org.eclipse.core.runtime.IPath getWebContents(ProjectContext ctx)

Get WebContents directory, given a project. The path is relative to current project.

getStruts2Properties

public static org.w3c.dom.Element getStruts2Properties(ProjectContext context)

Get the XML element that stores specific Struts2 properties.

Parameters:

context -

Returns:

createPackage

public static org.w3c.dom.Element createPackage(org.w3c.dom.Element strutsElementContainer,
                                                java.lang.String name,
                                                java.lang.String namespace,
                                                java.lang.String parent)

Creates a new package.

getDefinedPackages

public static java.lang.String[] getDefinedPackages(org.w3c.dom.Element strutsElementContainer)

Gets a list of all struts 2 defined packages.

Parameters:

strutsElementContainer -

Returns:

getNsContext

public static final javax.xml.namespace.NamespaceContext getNsContext()

Gets a namespace context.

getDefaultPackage

public static java.lang.String getDefaultPackage(org.w3c.dom.Element strutsElementContainer)

Get default package name.

getPackageByName

public static org.w3c.dom.Element getPackageByName(org.w3c.dom.Element strutsElementContainer,
                                                   java.lang.String name)

Get default package name.

setDefaultPackage

public static void setDefaultPackage(org.w3c.dom.Element strutsElementContainer,
                                     java.lang.String name)

Get default package name.

getPackageName

public static java.lang.String getPackageName(org.w3c.dom.Element pack)

Get package name.

getPackagesElements

public static org.w3c.dom.Element[] getPackagesElements(org.w3c.dom.Element strutsElementContainer)

Get all packages.

isDefaultPackage

public static boolean isDefaultPackage(org.w3c.dom.Element strutsElementContainer,
                                       java.lang.String name)

Check wether a given package is the default one.

isDefaultPackage

public static boolean isDefaultPackage(org.w3c.dom.Element strutsElementContainer,
                                       org.w3c.dom.Element pack)

Check wether a given package is the default one.

initializeFirstAlveolePackage

public static void initializeFirstAlveolePackage(org.w3c.dom.Element strutsElementContainer)

Initializes first default alveole package.

getDeclaredDefaultInterceptor

public static org.w3c.dom.Element getDeclaredDefaultInterceptor(org.w3c.dom.Element pack)

Get the default interceptor-ref in the given package, if defined. This method does not walks through inherited pakages.

getDefaultActionRef

public static org.w3c.dom.Element getDefaultActionRef(org.w3c.dom.Element pack)

Get the default-action-ref in the given package, if defined. This method does not walks through inherited pakages.

getAllInheritedInterceptorsNames

public static java.lang.String[] getAllInheritedInterceptorsNames(org.w3c.dom.Element strutsElementContainer,
                                                                  org.w3c.dom.Element pack)

Get a list of all available interceptors' names in a given package.

getAllInheritedInterceptorsNamesWithDefaults

public static java.lang.String[] getAllInheritedInterceptorsNamesWithDefaults(org.w3c.dom.Element strutsElementContainer,
                                                                              org.w3c.dom.Element pack)

Get a list of all available interceptors' names in a given package. Add struts2 defaultly defined interceptors.

getAllInheritedInterceptors

public static java.util.ArrayList<org.w3c.dom.Element> getAllInheritedInterceptors(org.w3c.dom.Element strutsElementContainer,
                                                                                   org.w3c.dom.Element pack)

Get a list of available interceptors for the given package including inherited ones.

getAllInheritedResultTypesNames

public static java.lang.String[] getAllInheritedResultTypesNames(org.w3c.dom.Element strutsElementContainer,
                                                                 org.w3c.dom.Element pack)

Get a list of all available result-types' names in a given package.

getAllInheritedResultTypesNamesWithDefaults

public static java.lang.String[] getAllInheritedResultTypesNamesWithDefaults(org.w3c.dom.Element strutsElementContainer,
                                                                             org.w3c.dom.Element pack)

Get a list of all available result-types' names in a given package. Add struts2 defaultly defined result-types.

getAllInheritedResultTypes

public static java.util.ArrayList<org.w3c.dom.Element> getAllInheritedResultTypes(org.w3c.dom.Element strutsElementContainer,
                                                                                  org.w3c.dom.Element pack)

Get a list of available result-types for the given package including inherited ones.

getAllInheritedGlobalResultsNames

public static java.lang.String[] getAllInheritedGlobalResultsNames(org.w3c.dom.Element strutsElementContainer,
                                                                   org.w3c.dom.Element pack)

Get a list of all available globally defined results' names in a given package.

getAllInheritedGlobalResults

public static java.util.ArrayList<org.w3c.dom.Element> getAllInheritedGlobalResults(org.w3c.dom.Element strutsElementContainer,
                                                                                    org.w3c.dom.Element pack)

Get a list of available result globally defined for package, including inherited ones.

getTextContents

public static java.lang.String getTextContents(org.w3c.dom.Node tag)

Get Text contents of a node.

getDirectTextContents

public static java.lang.String getDirectTextContents(org.w3c.dom.Node tag)

Get Text direct contents of a node.

getParameters

public static java.lang.String[][] getParameters(org.w3c.dom.Element parent)

Get a list of parameters, given a parent tag.

setParameters

public static void setParameters(org.w3c.dom.Element parent,
                                 java.lang.String[][] params)

Sets a list of parameters, given a parent tag.

getInterceptorsElement

public static org.w3c.dom.Element getInterceptorsElement(org.w3c.dom.Element pack)

Get all interceptors.

getGlobalResultsElement

public static org.w3c.dom.Element getGlobalResultsElement(org.w3c.dom.Element pack)

Get all global-results.

getBeansElement

public static org.w3c.dom.Element getBeansElement(org.w3c.dom.Element struts2base)

Get beans.

getConstantsElement

public static org.w3c.dom.Element getConstantsElement(org.w3c.dom.Element struts2base)

Get constants.

getGlobalExceptionMappingsElement

public static org.w3c.dom.Element getGlobalExceptionMappingsElement(org.w3c.dom.Element pack)

Get global-exception-mappings.

getGlobalResultElements

public static org.w3c.dom.Element[] getGlobalResultElements(org.w3c.dom.Element globalresults)

Get all global results defined inside a global-results element.

getBeanElements

public static org.w3c.dom.Element[] getBeanElements(org.w3c.dom.Element beans)

Get all beans.

getConstantElements

public static org.w3c.dom.Element[] getConstantElements(org.w3c.dom.Element constants)

Get all constants.

getGlobalExceptionMappingElements

public static org.w3c.dom.Element[] getGlobalExceptionMappingElements(org.w3c.dom.Element globalex)

Get all global exception mappings defined inside a global-exception-mappings element.

getResultTypesElement

public static org.w3c.dom.Element getResultTypesElement(org.w3c.dom.Element pack)

Get all result-types.

getResultTypes

public static org.w3c.dom.Element[] getResultTypes(org.w3c.dom.Element resultTypes)

Get all result-type elements.

getInterceptorsAndStacks

public static org.w3c.dom.Element[] getInterceptorsAndStacks(org.w3c.dom.Element pack)

Get all interceptors from a package.

getInterceptorRefs

public static org.w3c.dom.Element[] getInterceptorRefs(org.w3c.dom.Element stack)

Get all interceptor-refs from a stack.

getNSContext

public static javax.xml.namespace.NamespaceContext getNSContext()

Gets Struts2 namespace context.