org.globus.mds.trigger.types
Class TriggerRuleType

java.lang.Object
  org.globus.mds.trigger.types.TriggerRuleType

All Implemented Interfaces:

Serializable

public class TriggerRuleType

extends Object

implements Serializable

See Also:

Serialized Form

Constructor Summary

TriggerRuleType()

TriggerRuleType(String matchingRule, String[] namespaceMappings, String outputXSL, String actionScript, Integer minimumFiringInterval, Integer minimumMatchTime, Boolean enableFilteredActionScriptInput, Boolean disableUnmodifiedActionScriptInput, String triggerID, TriggerInvalidityTime[] invalidityTime)

Method Summary

boolean	equals(Object obj)
String	getActionScript() Gets the actionScript value for this TriggerRuleType.
static Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Boolean	getDisableUnmodifiedActionScriptInput() Gets the disableUnmodifiedActionScriptInput value for this TriggerRuleType.
Boolean	getEnableFilteredActionScriptInput() Gets the enableFilteredActionScriptInput value for this TriggerRuleType.
TriggerInvalidityTime[]	getInvalidityTime() Gets the invalidityTime value for this TriggerRuleType.
TriggerInvalidityTime	getInvalidityTime(int i)
String	getMatchingRule() Gets the matchingRule value for this TriggerRuleType.
Integer	getMinimumFiringInterval() Gets the minimumFiringInterval value for this TriggerRuleType.
Integer	getMinimumMatchTime() Gets the minimumMatchTime value for this TriggerRuleType.
String[]	getNamespaceMappings() Gets the namespaceMappings value for this TriggerRuleType.
String	getNamespaceMappings(int i)
String	getOutputXSL() Gets the outputXSL value for this TriggerRuleType.
static Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
String	getTriggerID() Gets the triggerID value for this TriggerRuleType.
static TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setActionScript(String actionScript) Sets the actionScript value for this TriggerRuleType.
void	setDisableUnmodifiedActionScriptInput(Boolean disableUnmodifiedActionScriptInput) Sets the disableUnmodifiedActionScriptInput value for this TriggerRuleType.
void	setEnableFilteredActionScriptInput(Boolean enableFilteredActionScriptInput) Sets the enableFilteredActionScriptInput value for this TriggerRuleType.
void	setInvalidityTime(int i, TriggerInvalidityTime _value)
void	setInvalidityTime(TriggerInvalidityTime[] invalidityTime) Sets the invalidityTime value for this TriggerRuleType.
void	setMatchingRule(String matchingRule) Sets the matchingRule value for this TriggerRuleType.
void	setMinimumFiringInterval(Integer minimumFiringInterval) Sets the minimumFiringInterval value for this TriggerRuleType.
void	setMinimumMatchTime(Integer minimumMatchTime) Sets the minimumMatchTime value for this TriggerRuleType.
void	setNamespaceMappings(int i, String _value)
void	setNamespaceMappings(String[] namespaceMappings) Sets the namespaceMappings value for this TriggerRuleType.
void	setOutputXSL(String outputXSL) Sets the outputXSL value for this TriggerRuleType.
void	setTriggerID(String triggerID) Sets the triggerID value for this TriggerRuleType.

Methods inherited from class java.lang.Object

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

Constructor Detail

TriggerRuleType

public TriggerRuleType()

TriggerRuleType

public TriggerRuleType(String matchingRule,
                       String[] namespaceMappings,
                       String outputXSL,
                       String actionScript,
                       Integer minimumFiringInterval,
                       Integer minimumMatchTime,
                       Boolean enableFilteredActionScriptInput,
                       Boolean disableUnmodifiedActionScriptInput,
                       String triggerID,
                       TriggerInvalidityTime[] invalidityTime)

Method Detail

getMatchingRule

public String getMatchingRule()

Gets the matchingRule value for this TriggerRuleType.

Returns:

matchingRule * The XPath expression to be applied against incoming data. Note: there is no way with the present AXIS deserialisers to resolve XPath namespaces from surrounding context. In order to reference namespaces (via prefix) in the matchingRule statement, the registered matchingRule must be accompanied by a populated namespaceMappings array, which should map all of the prefixes used in the matchingRule to valid XML namespaces that will then be used to resolve namespace context(s) for the query.

setMatchingRule

public void setMatchingRule(String matchingRule)

Sets the matchingRule value for this TriggerRuleType.

Parameters:

matchingRule - * The XPath expression to be applied against incoming data. Note: there is no way with the present AXIS deserialisers to resolve XPath namespaces from surrounding context. In order to reference namespaces (via prefix) in the matchingRule statement, the registered matchingRule must be accompanied by a populated namespaceMappings array, which should map all of the prefixes used in the matchingRule to valid XML namespaces that will then be used to resolve namespace context(s) for the query.

getNamespaceMappings

public String[] getNamespaceMappings()

Gets the namespaceMappings value for this TriggerRuleType.

Returns:

namespaceMappings * An array of string namespace mappings in the form xmlns:foo=http://foo.bar. This array of namespace mappings will be used to resolve namespace prefixes used in the XPath matchingRule statement.

setNamespaceMappings

public void setNamespaceMappings(String[] namespaceMappings)

Sets the namespaceMappings value for this TriggerRuleType.

Parameters:

namespaceMappings - * An array of string namespace mappings in the form xmlns:foo=http://foo.bar. This array of namespace mappings will be used to resolve namespace prefixes used in the XPath matchingRule statement.

getNamespaceMappings

public String getNamespaceMappings(int i)

setNamespaceMappings

public void setNamespaceMappings(int i,
                                 String _value)

getOutputXSL

public String getOutputXSL()

Gets the outputXSL value for this TriggerRuleType.

Returns:

outputXSL * Identifier of XSLT optionally used to format data sent to action script. If unspecified, the matching XML will be passed untransformed. This feature is currently not implemented and this parameter will be ignored. Set enableFilteredActionScriptInput to true in order to have the service pass the result output from the application of the XPath matchingRule to the action script, in addition to the unmodified trigger input message.

setOutputXSL

public void setOutputXSL(String outputXSL)

Sets the outputXSL value for this TriggerRuleType.

Parameters:

outputXSL - * Identifier of XSLT optionally used to format data sent to action script. If unspecified, the matching XML will be passed untransformed. This feature is currently not implemented and this parameter will be ignored. Set enableFilteredActionScriptInput to true in order to have the service pass the result output from the application of the XPath matchingRule to the action script, in addition to the unmodified trigger input message.

getActionScript

public String getActionScript()

Gets the actionScript value for this TriggerRuleType.

Returns:

actionScript * Identifier of action script. This is a symbolic name for a valid executable file found in $GLOBUS_LOCATION/libexec/trigger. The mapping of these symbolic names to the actual file name is contained in the Trigger service's jndi-config.xml file.

setActionScript

public void setActionScript(String actionScript)

Sets the actionScript value for this TriggerRuleType.

Parameters:

actionScript - * Identifier of action script. This is a symbolic name for a valid executable file found in $GLOBUS_LOCATION/libexec/trigger. The mapping of these symbolic names to the actual file name is contained in the Trigger service's jndi-config.xml file.

getMinimumFiringInterval

public Integer getMinimumFiringInterval()

Gets the minimumFiringInterval value for this TriggerRuleType.

Returns:

minimumFiringInterval * The actionScript will not be executed more often than once every this number of seconds. If unspecified, the actionScript will be executed every time the trigger service receives information that matches the matchingRule.

setMinimumFiringInterval

public void setMinimumFiringInterval(Integer minimumFiringInterval)

Sets the minimumFiringInterval value for this TriggerRuleType.

Parameters:

minimumFiringInterval - * The actionScript will not be executed more often than once every this number of seconds. If unspecified, the actionScript will be executed every time the trigger service receives information that matches the matchingRule.

getMinimumMatchTime

public Integer getMinimumMatchTime()

Gets the minimumMatchTime value for this TriggerRuleType.

Returns:

minimumMatchTime * The matchingRule must match for at least this number of seconds before the actionScript will be executed. If unspecified, any match will cause the actionScript to be run.

setMinimumMatchTime

public void setMinimumMatchTime(Integer minimumMatchTime)

Sets the minimumMatchTime value for this TriggerRuleType.

Parameters:

minimumMatchTime - * The matchingRule must match for at least this number of seconds before the actionScript will be executed. If unspecified, any match will cause the actionScript to be run.

getEnableFilteredActionScriptInput

public Boolean getEnableFilteredActionScriptInput()

Gets the enableFilteredActionScriptInput value for this TriggerRuleType.

Returns:

enableFilteredActionScriptInput * If this value is present and set to true, the service will pass the filtered output result of the XPath matchingRule as additional input to the stdin actionScript, in addition to the original input to which the matching rule was applied.

setEnableFilteredActionScriptInput

public void setEnableFilteredActionScriptInput(Boolean enableFilteredActionScriptInput)

Sets the enableFilteredActionScriptInput value for this TriggerRuleType.

Parameters:

enableFilteredActionScriptInput - * If this value is present and set to true, the service will pass the filtered output result of the XPath matchingRule as additional input to the stdin actionScript, in addition to the original input to which the matching rule was applied.

getDisableUnmodifiedActionScriptInput

public Boolean getDisableUnmodifiedActionScriptInput()

Gets the disableUnmodifiedActionScriptInput value for this TriggerRuleType.

Returns:

disableUnmodifiedActionScriptInput * If this value is present and set to true the service will NOT pass the original trigger message input (to which the matching rule was applied) to the action script. The default behavior is to always pass the entire input message to the action scripts. Action scripts which do not need to consume the unmodified input may set this variable to true, in order to increase performance.

setDisableUnmodifiedActionScriptInput

public void setDisableUnmodifiedActionScriptInput(Boolean disableUnmodifiedActionScriptInput)

Sets the disableUnmodifiedActionScriptInput value for this TriggerRuleType.

Parameters:

disableUnmodifiedActionScriptInput - * If this value is present and set to true the service will NOT pass the original trigger message input (to which the matching rule was applied) to the action script. The default behavior is to always pass the entire input message to the action scripts. Action scripts which do not need to consume the unmodified input may set this variable to true, in order to increase performance.

getTriggerID

public String getTriggerID()

Gets the triggerID value for this TriggerRuleType.

Returns:

triggerID * This is an optional server assigned value that may be set and used by the implementation to associate TriggerRule and TriggerStatus pairs.

setTriggerID

public void setTriggerID(String triggerID)

Sets the triggerID value for this TriggerRuleType.

Parameters:

triggerID - * This is an optional server assigned value that may be set and used by the implementation to associate TriggerRule and TriggerStatus pairs.

getInvalidityTime

public TriggerInvalidityTime[] getInvalidityTime()

Gets the invalidityTime value for this TriggerRuleType.

Returns:

invalidityTime * An array of invalidity time ranges during which the trigger will not fire under any condition. If the current trigger fire time falls within any of the time ranges present, the trigger will not fire.

setInvalidityTime

public void setInvalidityTime(TriggerInvalidityTime[] invalidityTime)

Sets the invalidityTime value for this TriggerRuleType.

Parameters:

invalidityTime - * An array of invalidity time ranges during which the trigger will not fire under any condition. If the current trigger fire time falls within any of the time ranges present, the trigger will not fire.

getInvalidityTime

public TriggerInvalidityTime getInvalidityTime(int i)

setInvalidityTime

public void setInvalidityTime(int i,
                              TriggerInvalidityTime _value)

equals

public boolean equals(Object obj)

hashCode

public int hashCode()

getTypeDesc

public static TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static Serializer getSerializer(String mechType,
                                       Class _javaType,
                                       QName _xmlType)

Get Custom Serializer

getDeserializer

public static Deserializer getDeserializer(String mechType,
                                           Class _javaType,
                                           QName _xmlType)

Get Custom Deserializer