filenet.vw.api

Class VWReceiveInstruction

java.lang.Object

filenet.vw.api.VWInstructionDefinition

filenet.vw.api.VWReceiveInstruction

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class VWReceiveInstruction
extends VWInstructionDefinition
implements java.io.Serializable

This class represents a Process Engine workflow step instruction that allows a Process Engine to communicate through a local web service listener and receive either an XML message or a set of Process Engine workflow operation parameters.

Create an instance of this class with VWCompoundStepDefinition.createReceiveInstruction(String,String).

Types of Message Management

This class provides two groups of methods for communication over a partner link, depending on the type of message management desired; an instance of this class should use message management methods from one group or the other, but not both. The two types of partner link-related message management that this class handles are the following:

• Business Process Execution: Contains data in a complex structure that is best expressed with XML expressions.
• Process Engine parameter: Only Process Engine parameter data is passed over the partner link.

  Parameters for Java API Web Service methods are like any Process Engine workflow operation parameter, and must have a data type that is a Process Engine field type.

  Methods in this class for handling the Business Process Execution type of message management include:

  • getMessageExpr()
  • setMessageExpr(String)
  • getMessageFromElementName()
  • setMessageFromElementName(String)
  • getMessageFromSchemaName()
  • setMessageFromSchemaName(String)
  • getCorrelationSetName()
  • setCorrelationSetName(String)
  • getCorrelationSetProperties()
  • setCorrelationSetProperties(String[][])

    Note: When using the Business Process Execution type of message management, the Process Engine matches the work item for the workflow step to a given instance of VWReceiveInstruction by using the correlation set properties.

  Methods in this class for handling the Process Engine parameter type of message management include:

  • createParameter(String, String, int, boolean)
  • deleteParameter(String)
  • deleteAllParameters()
  • getParameterDefinition(int)
  • getParameterDefinitions()
  • getCorrelationParameterSequenceNumber()
  • setCorrelationParameterSequenceNumber(int)
  • getCorrelationValueExpression()
  • setCorrelationValueExpression(String)

    Note: When using the Process Engine parameter type of message management, the Process Engine matches the work item for the workflow step to a given instance of VWReceiveInstruction by using the correlation value expression.
    

See Also:

VWPartnerLinkDefinition, VWWebServiceParameterDefinition, Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
VWWebServiceParameterDefinition	createParameter(java.lang.String theName, java.lang.String theValue, int theType, boolean theIsArray) Creates a parameter with name, direction, value, and type information.
void	deleteAllParameters() Deletes all parameter definitions for this receive instruction.
void	deleteParameter(int theSequenceNumber) Deletes a parameter definition from the set of parameter definitions stored in this receive instruction.
boolean	getAuthentication() Gets the value of theAuthenticationFlag, indicating whether a Web Service security header for caller authentication is generated for this operation.
int	getCorrelationParameterSequenceNumber() Gets the correlation parameter sequence number of this receive instruction; may be -1 if there is no correlation parameter.
java.lang.String	getCorrelationSetName() Gets the correlation set name.
java.lang.String[][]	getCorrelationSetProperties() Gets the correlation set properties.
java.lang.String	getCorrelationValueExpression() Gets an expression that evaluates to the correlation set parameter value for this receive instruction; may be null.
java.lang.String	getMessageExpr() Gets the message expression of this receive instruction.
java.lang.String	getMessageFromElementName() Gets the name of the schema element that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition.
java.lang.String	getMessageFromSchemaName() Gets the name of the schema that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition.
int	getOnlineId() Gets the online ID, if available, or -1.
java.lang.String	getOperationName() Gets the operation name of this receive instruction.
VWWebServiceParameterDefinition	getParameterDefinition(int theSequenceNumber) Gets a parameter definition from the set of parameter definitions stored in this receive instruction.
VWWebServiceParameterDefinition[]	getParameterDefinitions() Gets the parameter definitions stored in this receive instruction.
java.lang.String	getPartnerLinkName() Gets the partner link name of this receive instruction.
java.lang.String[]	getSecurityGroup() Gets the security group assigned for this receive instruction.
java.lang.String	getTimeoutExpr() Gets the timeout expression of this receive instruction, in the same format in which the expression was set.
java.lang.String	getTimeoutMapName() Gets the timeout map name of this receive instruction.
void	setAuthentication(boolean theAuthenticationFlag) Sets the value of theAuthenticationFlag, indicating a Web Service security header authenticating the caller is to be used for this operation.
void	setCorrelationParameterSequenceNumber(int theParamSeqNumber) Sets the correlation parameter sequence number of this receive instruction; may be -1, indicating there is no correlation parameter.
void	setCorrelationSetName(java.lang.String theName) Sets the correlation set name; may be null.
void	setCorrelationSetProperties(java.lang.String[][] theProps) Sets the output correlation set properties.
void	setCorrelationValueExpression(java.lang.String theValueExpr) Sets an expression that evaluates to the correlation set parameter value for this receive instruction; may be null.
void	setMessageExpr(java.lang.String theMsgExpr) Sets the message expression of this receive instruction.
void	setMessageFromElementName(java.lang.String theElement) Sets the name of the schema element that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition.
void	setMessageFromSchemaName(java.lang.String theSchema) Sets the name of the schema that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition.
void	setOperationName(java.lang.String theOperationName) Sets the operation name of this receive instruction, which must be the name of an operation on the port type defined in the associated partner link.
void	setPartnerLinkName(java.lang.String thePartnerLinkName) Sets the partner link name of this receive instruction.
void	setSecurityGroup(java.lang.String[] theSecurityGroup) Sets the security group to use for this receive instruction.
void	setTimeoutExpr(java.lang.String theTimeoutExpr) Sets the timeout expression of this receive instruction; must be a valid time expression.
void	setTimeoutMapName(java.lang.String theTimeoutMapName) Sets the timeout map name of this receive instruction.
java.lang.String	toString() Gets the name of this VWReceiveInstruction instruction
void	toXML(java.lang.StringBuffer theBuffer) Deprecated. Use VWWorkflowDefinition.write(java.io.OutputStream) or VWWorkflowDefinition.writeToFile(String).
void	toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer) Deprecated. Use VWWorkflowCollectionDefinition.write(java.io.OutputStream) or VWWorkflowCollectionDefinition.writeToFile(String).
void	validate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep) Deprecated. Use VWWorkflowDefinition or VWWorkflowCollectionDefinition validate methods.

Methods inherited from class filenet.vw.api.VWInstructionDefinition

getAction, getInstructionId, getStep

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

setTimeoutExpr

public void setTimeoutExpr(java.lang.String theTimeoutExpr)
                    throws VWException

Sets the timeout expression of this receive instruction; must be a valid time expression.

Parameters:

theTimeoutExpr - A Time expression value for this receive instruction.

Throws:

VWException

getTimeoutExpr

public java.lang.String getTimeoutExpr()

Gets the timeout expression of this receive instruction, in the same format in which the expression was set.

Returns:

Timeout expression value for this receive instruction.

See Also:

VWReceiveInstruction.setTimeoutExpr(String)

setTimeoutMapName

public void setTimeoutMapName(java.lang.String theTimeoutMapName)
                       throws VWException

Sets the timeout map name of this receive instruction.

Parameters:

theTimeoutMapName - null or the timeout map name for this receive instruction.

Throws:

VWException

getTimeoutMapName

public java.lang.String getTimeoutMapName()

Gets the timeout map name of this receive instruction.

Returns:

Timeout map name for this receive instruction; may be null.

setMessageExpr

public void setMessageExpr(java.lang.String theMsgExpr)
                    throws VWException

Sets the message expression of this receive instruction. This is a left side String expression, such as the name of a String field in this workflow.

Parameters:

theMsgExpr - Left side String expression: a String expression which is valid on the left side of an assignment statement, such as the name of a String field in this workflow.

Throws:

VWException

See Also:

VWReceiveInstruction.setCorrelationSetName(String), VWReceiveInstruction.setMessageFromSchemaName(String), VWReceiveInstruction.setMessageFromElementName(String), VWReceiveInstruction.getMessageExpr(), Types Of Message Management

getMessageExpr

public java.lang.String getMessageExpr()

Gets the message expression of this receive instruction. This is a left side String expression, such as the name of a String field in this workflow.

Returns:

Message expression

See Also:

VWReceiveInstruction.setCorrelationSetName(String), VWReceiveInstruction.setMessageFromSchemaName(String), VWReceiveInstruction.setMessageFromElementName(String), VWReceiveInstruction.setMessageExpr(String), Types Of Message Management

setPartnerLinkName

public void setPartnerLinkName(java.lang.String thePartnerLinkName)
                        throws VWException

Sets the partner link name of this receive instruction. The partner link name must be the name of a partner link of the same the workflow definition that contains this receive instruction.

Parameters:

thePartnerLinkName - Partner link name

Throws:

VWException - Thrown for various causes, including when the input partner link name is not the name of a partner link contained in workflow associated with this receive instruction.

VWException - Thrown for various causes, including when the input partner link name does not exist on the system.

See Also:

VWPartnerLinkDefinition, VWWorkflowDefinition

getPartnerLinkName

public java.lang.String getPartnerLinkName()

Gets the partner link name of this receive instruction.

Returns:

Partner link name

See Also:

VWReceiveInstruction.setPartnerLinkName(String), VWPartnerLinkDefinition, VWWorkflowDefinition

setOperationName

public void setOperationName(java.lang.String theOperationName)
                      throws VWException

Sets the operation name of this receive instruction, which must be the name of an operation on the port type defined in the associated partner link.

Parameters:

theOperationName - Operation name

Throws:

VWException

See Also:

VWPartnerLinkDefinition

getOperationName

public java.lang.String getOperationName()

Gets the operation name of this receive instruction.

Returns:

Operation name

See Also:

VWReceiveInstruction.setOperationName(String), VWPartnerLinkDefinition

createParameter

public VWWebServiceParameterDefinition createParameter(java.lang.String theName,
                                              java.lang.String theValue,
                                              int theType,
                                              boolean theIsArray)
                                                throws VWException

Creates a parameter with name, direction, value, and type information. Designed for situations involving simple data transfer with a Web Service, parameters may be used in place of the (usually) more complex Business Processing Execution type of message management.

Parameters:

theName - Name of the parameter.

theValue - Parameter definition value.

theType - Integer specifying the field type that applies to the value expression.

theIsArray - boolean expression: true specifies the value expression is an array; false, otherwise.

Returns:

Parameter definition.

Throws:

VWException - Various causes, including the following:

• Invalid symbol in the theName parameter
• Parameter with a name that already exists
• Invalid field type
• Invalid mode type

See Also:

VWModeType, Types Of Message Management

deleteParameter

public void deleteParameter(int theSequenceNumber)
                     throws VWException

Deletes a parameter definition from the set of parameter definitions stored in this receive instruction.

Parameters:

theSequenceNumber - Sequence number of the parameter definition to be deleted.

Throws:

VWException - Thrown for various causes, including when the input parameter name is invalid.

See Also:

VWWebServiceParameterDefinition

deleteAllParameters

public void deleteAllParameters()
                         throws VWException

Deletes all parameter definitions for this receive instruction.

Throws:

VWException

See Also:

VWWebServiceParameterDefinition, VWWebServiceParameterDefinition

getParameterDefinition

public VWWebServiceParameterDefinition getParameterDefinition(int theSequenceNumber)
                                                       throws VWException

Gets a parameter definition from the set of parameter definitions stored in this receive instruction.

Parameters:

theSequenceNumber - A property of the web service parameter which uniquely identifies the web service parameter with an integer.

Returns:

VWWebServiceParameterDefinition object, specified by the input sequence number

Throws:

VWException - Thrown for various causes, including when the parameter cannot be found.

See Also:

Types Of Message Management

getParameterDefinitions

public VWWebServiceParameterDefinition[] getParameterDefinitions()
                                                          throws VWException

Gets the parameter definitions stored in this receive instruction.

Returns:

Array of VWWebServiceParameterDefinition objects containing the parameter definitions for this receive instruction.

Throws:

VWException

See Also:

VWReceiveInstruction.getParameterDefinition(int), Types Of Message Management

toString

public java.lang.String toString()

Gets the name of this VWReceiveInstruction instruction.

Specified by:

toString in class VWInstructionDefinition

Returns:

A String representing this VWReceiveInstruction instruction.

See Also:

VWActionType

validate

public void validate(VWSession theSession,
            java.util.Vector EDefVector,
            VWCompoundStepDefinition myStep)
              throws VWException

Deprecated. Use VWWorkflowDefinition or VWWorkflowCollectionDefinition validate methods.

Validates this instance, appending any validation errors found to the specified Vector object. Although this method does not return a value, EDefVector will be updated to contain any validation errors found.

Specified by:

validate in class VWInstructionDefinition

Parameters:

theSession - The current VWSession object if logged on. This is needed for various parts of the validation process. This can be null; however, areas of validation requiring a logon will not be validated.

EDefVector - A Vector to which will be added a VWValidationError object for each validation error found. This can be null; in this case, a new Vector is used.

Note: Because validate methods having EDefVector in the signature also occur on other classes, the existing Vector can contain validation errors from previous validation calls.

myStep - The VWCompoundStepDefinition object containing this event.

Throws:

VWException - Thrown if an error occurs during the validation.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException

Deprecated. Use VWWorkflowDefinition.write(java.io.OutputStream) or VWWorkflowDefinition.writeToFile(String).

Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Specified by:

toXML in class VWInstructionDefinition

Parameters:

theBuffer - A StringBuffer that will be appended with the XML content.

Throws:

VWException - Thrown if the specified buffer is null.

See Also:

VWWorkflowDefinition

toXPDL

public void toXPDL(java.lang.String indentA,
          java.lang.StringBuffer theBuffer)
            throws VWException

Deprecated. Use VWWorkflowCollectionDefinition.write(java.io.OutputStream) or VWWorkflowCollectionDefinition.writeToFile(String).

Appends an XPDL string representing this instance to the buffer specified.

Warning: This XPDL string is nonextensible, and cannot be modified in any way.

Parameters:

indentA - A String specifying the initial indentation for this XPDL section.

theBuffer - A StringBuffer that will be appended with the XPDL content.

Throws:

VWException - Thrown if the specified buffer is null.

See Also:

VWWorkflowCollectionDefinition

setMessageFromSchemaName

public void setMessageFromSchemaName(java.lang.String theSchema)
                              throws VWException

Sets the name of the schema that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition.

Parameters:

theSchema - A String containing the schema name.

Throws:

VWException

See Also:

VWReceiveInstruction.getMessageFromSchemaName(), VWReceiveInstruction.setCorrelationSetName(String), VWReceiveInstruction.setMessageFromElementName(String), VWReceiveInstruction.setMessageExpr(String), Types Of Message Management

getMessageFromSchemaName

public java.lang.String getMessageFromSchemaName()

Gets the name of the schema that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition.

Returns:

A String containing the schema name.

See Also:

VWReceiveInstruction.setCorrelationSetName(String), VWReceiveInstruction.setMessageFromSchemaName(String), VWReceiveInstruction.setMessageFromElementName(String), VWReceiveInstruction.setMessageExpr(String), Types Of Message Management

setMessageFromElementName

public void setMessageFromElementName(java.lang.String theElement)
                               throws VWException

Sets the name of the schema element that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition.

Parameters:

theElement - A String containing the schema element name.

Throws:

VWException

See Also:

VWReceiveInstruction.setCorrelationSetName(String), VWReceiveInstruction.setMessageFromSchemaName(String), VWReceiveInstruction.getMessageFromElementName(), VWReceiveInstruction.setMessageExpr(String), Types Of Message Management, VWWorkflowDefinition

getMessageFromElementName

public java.lang.String getMessageFromElementName()

Gets the name of the schema element that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition.

Returns:

A String containing the schema element name.

See Also:

VWReceiveInstruction.setCorrelationSetName(String), VWReceiveInstruction.setMessageFromSchemaName(String), VWReceiveInstruction.setMessageFromElementName(String), VWReceiveInstruction.setMessageExpr(String), Types Of Message Management, VWWorkflowDefinition

setAuthentication

public void setAuthentication(boolean theAuthenticationFlag)
                       throws VWException

Sets the value of theAuthenticationFlag, indicating a Web Service security header authenticating the caller is to be used for this operation.

Parameters:

theAuthenticationFlag - A boolean value of true generates a Web Service security header for caller authentication; false indicates no authentication.

Throws:

VWException

See Also:

VWReceiveInstruction.setSecurityGroup(String[]), VWReceiveInstruction.getSecurityGroup(), VWReceiveInstruction.getAuthentication()

getAuthentication

public boolean getAuthentication()

Gets the value of theAuthenticationFlag, indicating whether a Web Service security header for caller authentication is generated for this operation.

Returns:

A boolean value of true indicates a Web Service security header for caller authentication is generated; false indicates no authentication.

See Also:

VWReceiveInstruction.setSecurityGroup(String[]), VWReceiveInstruction.getSecurityGroup(), VWReceiveInstruction.setAuthentication(boolean)

getOnlineId

public int getOnlineId()

Gets the online ID, if available, or -1. A valid online ID is available if the containing workflow definition came from the runtime server, after transfer of the workflow definition. A return value of -1 indicates that this receive instruction does not have an online id, which usually means the receive instruction was not transferred. If the containing workflow definition comes from the runtime server, after transfer of the workflow definition, a valid online ID has been created

Returns:

Online ID, or -1 if the online ID is not available.

setCorrelationSetName

public void setCorrelationSetName(java.lang.String theName)
                           throws VWException

Sets the correlation set name; may be null. A correlation set stores the message state value in a work item, so that the work item can be matched with a particular message. This method is used for Business Process Execution messaging, rather than Process Engine parameter messaging.

Parameters:

theName - Correlation set name, or null. A null value signifies there is no correlation set name, normally because another type of message management is used, or because a state value is not needed. The name can only contain letters, numbers, and underscores, and must not exceed the maximum number of characters, as a field name is generated from the supplied name.

Throws:

VWException - Thrown for various causes, including an illegal character in the input name, or the input name contains more than the allowable number of characters.

See Also:

VWReceiveInstruction.getCorrelationSetName(), VWReceiveInstruction.setMessageFromSchemaName(String), VWReceiveInstruction.setMessageFromElementName(String), VWReceiveInstruction.setMessageExpr(String), VWReceiveInstruction.setCorrelationSetProperties(String[][])

getCorrelationSetName

public java.lang.String getCorrelationSetName()

Gets the correlation set name.

Returns:

Correlation set name.

See Also:

VWReceiveInstruction.setCorrelationSetName(String), VWReceiveInstruction.setMessageFromSchemaName(String), VWReceiveInstruction.setMessageFromElementName(String), VWReceiveInstruction.setMessageExpr(String), Types Of Message Management, VWReceiveInstruction.setCorrelationSetName(String)

setCorrelationSetProperties

public void setCorrelationSetProperties(java.lang.String[][] theProps)
                                 throws VWException

Sets the output correlation set properties. A correlation set stores the message state value in a work item, so that the work item can be matched with a particular message.

Note: When using the Business Process Execution type of message management, the Process Engine matches the work item for the workflow step to a given instance of VWReceiveInstruction by using the correlation set properties.

Parameters:

theProps - Correlation set properties, a two dimensional array (n by 2, where n is the number of properties) which is an array of pairs, each comprised of a property name and its corresponding Process Engine expression query.

Correlation set properties provide a server with a state value for the current instance of the workflow object, so that a specific instance may be identified.

Throws:

VWException - Thrown for various causes including an incorrectly dimensioned input String array, or a null entry in the input array.

See Also:

Types Of Message Management, VWReceiveInstruction.getCorrelationSetProperties(), VWReceiveInstruction.setCorrelationSetName(String), VWReceiveInstruction.setMessageFromSchemaName(String), VWReceiveInstruction.setMessageFromElementName(String), VWReceiveInstruction.setMessageExpr(String)

getCorrelationSetProperties

public java.lang.String[][] getCorrelationSetProperties()

Gets the correlation set properties. A correlation set stores the message state value in a work item, so that the work item can be matched with a particular message.

Note: When using the Business Process Execution type of message management, the Process Engine matches the work item for the workflow step to a given instance of VWReceiveInstruction by using the correlation set properties.

Returns:

Correlation set properties in a two dimensional array (n by 2, where n is the number of properties) which is an array of pairs, each comprised of a property name and its corresponding Process Engine expression query.

See Also:

Types Of Message Management, VWReceiveInstruction.setCorrelationSetProperties(String[][]), VWReceiveInstruction.setCorrelationSetName(String), VWReceiveInstruction.setMessageFromSchemaName(String), VWReceiveInstruction.setMessageFromElementName(String), VWReceiveInstruction.setMessageExpr(String)

setCorrelationParameterSequenceNumber

public void setCorrelationParameterSequenceNumber(int theParamSeqNumber)
                                           throws VWException

Sets the correlation parameter sequence number of this receive instruction; may be -1, indicating there is no correlation parameter. A correlation parameter is the parameter in the incoming message that contains the value used to match the correlation, so that the work item can be matched with a particular message.

Parameters:

theParamSeqNumber - Correlation parameter sequence number for this receive instruction, or -1. A value of -1 signifies that there is no correlation parameter, which is only valid if the receive is a launch receive (a receive immediately following the launch step). A value other than -1 represents the sequence number of one of the parameters defined in this receive instruction.

Throws:

VWException

See Also:

Types of Message Management, VWReceiveInstruction.getCorrelationParameterSequenceNumber(), VWReceiveInstruction.createParameter(String,String,int,boolean), VWReceiveInstruction.setCorrelationValueExpression(String)

getCorrelationParameterSequenceNumber

public int getCorrelationParameterSequenceNumber()

Gets the correlation parameter sequence number of this receive instruction; may be -1 if there is no correlation parameter.

Returns:

Correlation parameter sequence number, or -1 if there is no correlation parameter.

See Also:

Types Of Message Management, VWReceiveInstruction.createParameter(String,String,int,boolean), VWReceiveInstruction.setCorrelationParameterSequenceNumber(int), VWReceiveInstruction.setCorrelationValueExpression(String)

setCorrelationValueExpression

public void setCorrelationValueExpression(java.lang.String theValueExpr)
                                   throws VWException

Sets an expression that evaluates to the correlation set parameter value for this receive instruction; may be null.

Note: When using the Process Engine parameter type of message management, the Process Engine matches the work item for the workflow step to a given instance of VWReceiveInstruction by using the correlation value expression.

Parameters:

theValueExpr - Right side String expression that evaluates to the correlation set parameter value for this receive instruction, or null if there is no expression used to calculate the correlation set parameter value.

Throws:

VWException

See Also:

Types Of Message Management, VWReceiveInstruction.createParameter(String,String,int,boolean), VWReceiveInstruction.setCorrelationParameterSequenceNumber(int), VWReceiveInstruction.getCorrelationValueExpression()

getCorrelationValueExpression

public java.lang.String getCorrelationValueExpression()

Gets an expression that evaluates to the correlation set parameter value for this receive instruction; may be null.

Note: When using the Process Engine parameter type of message management, the Process Engine matches the work item for the workflow step to a given instance of VWReceiveInstruction by using the correlation value expression.

Returns:

Correlation parameter name for this receive instruction, or null if there is no expression used to calculate the correlation set parameter value.

See Also:

Types Of Message Management, VWReceiveInstruction.createParameter(String,String,int,boolean), VWReceiveInstruction.setCorrelationParameterSequenceNumber(int), VWReceiveInstruction.setCorrelationValueExpression(String)

setSecurityGroup

public void setSecurityGroup(java.lang.String[] theSecurityGroup)
                      throws VWException

Sets the security group to use for this receive instruction. If this receive instruction is configured to use authentication (VWReceiveInstruction.getAuthentication() == true), this method specifies the LDAP users and groups allowed to invoke the receive instruction.

Parameters:

theSecurityGroup - A string array of LDAP user and group names. The array can be null, but if not null, it cannot contain any null or empty elements.

Throws:

VWException - if an error occurs.

See Also:

VWReceiveInstruction.getSecurityGroup(), VWReceiveInstruction.setAuthentication(boolean), VWReceiveInstruction.getAuthentication()

getSecurityGroup

public java.lang.String[] getSecurityGroup()

Gets the security group assigned for this receive instruction.

Returns:

A string array of LDAP user and group names.

See Also:

VWReceiveInstruction.setSecurityGroup(String[]), VWReceiveInstruction.setAuthentication(boolean), VWReceiveInstruction.getAuthentication()