Package org.apache.axis2.scripting

Class ScriptModule

java.lang.Object

org.apache.axis2.scripting.ScriptModule

All Implemented Interfaces:

Module

public class ScriptModule
extends Object
implements Module

Axis2 module to initialize script services. Uses a ScriptDeploymentEngine to find all the scripts in the scriptServices directory and deploy them as Axis2 services.

Constructor Summary

Constructors

Constructor	Description
ScriptModule()

Method Summary

Modifier and Type	Method	Description
void	applyPolicy(org.apache.neethi.Policy policy, AxisDescription axisDescription)	Evaluates specified policy for the specified AxisDescription.
boolean	canSupportAssertion(org.apache.neethi.Assertion assertion)	Evaluate whether it can support the specified assertion and returns true if the assertion can be supported.
void	engageNotify(AxisDescription axisDescription)	When engaging this module to some service or operation , module will be notify by calling this method there module author can validate , add policy and do any thing that he want , and he can refuse the engage as well
protected File	getScriptServicesDirectory(AxisConfiguration axisConfig)	Gets the repo directory for the scripts.
void	init(ConfigurationContext configContext, AxisModule module)	Init by creating and deploying AxisServices for each script
void	shutdown(ConfigurationContext configurationContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptModule

public ScriptModule()

Method Detail

init

public void init(ConfigurationContext configContext,
                 AxisModule module)
          throws AxisFault

Init by creating and deploying AxisServices for each script

Specified by:

init in interface Module

Throws:

AxisFault

getScriptServicesDirectory

protected File getScriptServicesDirectory(AxisConfiguration axisConfig)
                                   throws DeploymentException

Gets the repo directory for the scripts. The scripts directory is a sub-directory of the Axis2 repository directory. Its name may be defined by a 'scriptServicesDir' property in the axis2.xml otherwise it defaults a to a directory named 'scriptServices'.

Throws:

DeploymentException

applyPolicy

public void applyPolicy(org.apache.neethi.Policy policy,
                        AxisDescription axisDescription)
                 throws AxisFault

Description copied from interface: Module

Evaluates specified policy for the specified AxisDescription. It computes the configuration that is appropriate to support the policy and stores it the appropriate description.

Specified by:

applyPolicy in interface Module

Parameters:

policy - the policy that is applicable for the specified AxisDescription

Throws:

AxisFault - if anything goes wrong.

canSupportAssertion

public boolean canSupportAssertion(org.apache.neethi.Assertion assertion)

Description copied from interface: Module

Evaluate whether it can support the specified assertion and returns true if the assertion can be supported.

Specified by:

canSupportAssertion in interface Module

Parameters:

assertion - the assertion that the module must decide whether it can support or not.

Returns:

true if the specified assertion can be supported by the module

engageNotify

public void engageNotify(AxisDescription axisDescription)
                  throws AxisFault

Description copied from interface: Module

When engaging this module to some service or operation , module will be notify by calling this method there module author can validate , add policy and do any thing that he want , and he can refuse the engage as well

Specified by:

engageNotify in interface Module

Throws:

AxisFault

shutdown

public void shutdown(ConfigurationContext configurationContext)
              throws AxisFault

Specified by:

shutdown in interface Module

Throws:

AxisFault