Package org.jibx.ws.wsdl.model
Class MessageReference
- java.lang.Object
-
- org.jibx.ws.wsdl.model.MessageReference
-
public class MessageReference extends java.lang.Object
Reference to a message within an operation. Since messages may be referenced as input, output, or fault messages, the appropriate type is tracked by this class, along with the actual message.- Author:
- Dennis M. Sosnoski
-
-
Field Summary
Fields Modifier and Type Field Description static int
FAULT_REFERENCE
Reference to message as fault.static int
INPUT_REFERENCE
Reference to message as input.private Message
m_message
Actual message.private java.lang.String
m_name
Name for this reference.private int
m_usage
Type of message reference.static int
OUTPUT_REFERENCE
Reference to message as output.
-
Constructor Summary
Constructors Modifier Constructor Description private
MessageReference(int usage)
Internal constructor used with JiBX binding.MessageReference(int usage, Message msg)
Constructor from part and element names.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static MessageReference
faultReferenceFactory()
Factory for creating fault message reference templates.Message
getMessage()
Get referenced message.java.lang.String
getName()
Get name for this reference.private static MessageReference
inputReferenceFactory()
Factory for creating input message reference templates.boolean
isFault()
Check if reference is to message as fault.boolean
isInput()
Check if reference is to message as input.boolean
isOutput()
Check if reference is to message as output.private static MessageReference
outputReferenceFactory()
Factory for creating output message reference templates.void
setName(java.lang.String name)
Set name for this reference.
-
-
-
Field Detail
-
INPUT_REFERENCE
public static final int INPUT_REFERENCE
Reference to message as input.- See Also:
- Constant Field Values
-
OUTPUT_REFERENCE
public static final int OUTPUT_REFERENCE
Reference to message as output.- See Also:
- Constant Field Values
-
FAULT_REFERENCE
public static final int FAULT_REFERENCE
Reference to message as fault.- See Also:
- Constant Field Values
-
m_usage
private int m_usage
Type of message reference.
-
m_name
private java.lang.String m_name
Name for this reference.
-
m_message
private Message m_message
Actual message.
-
-
Constructor Detail
-
MessageReference
private MessageReference(int usage)
Internal constructor used with JiBX binding.- Parameters:
usage
- reference type code
-
MessageReference
public MessageReference(int usage, Message msg)
Constructor from part and element names.- Parameters:
usage
- reference type codemsg
- referenced message
-
-
Method Detail
-
isInput
public boolean isInput()
Check if reference is to message as input.- Returns:
true
if input reference,false
if not
-
isOutput
public boolean isOutput()
Check if reference is to message as output.- Returns:
true
if output reference,false
if not
-
isFault
public boolean isFault()
Check if reference is to message as fault.- Returns:
true
if fault reference,false
if not
-
getName
public java.lang.String getName()
Get name for this reference.- Returns:
- reference name
-
setName
public void setName(java.lang.String name)
Set name for this reference.- Parameters:
name
-
-
getMessage
public Message getMessage()
Get referenced message.- Returns:
- referenced message
-
inputReferenceFactory
private static MessageReference inputReferenceFactory()
Factory for creating input message reference templates. The actual referenced message information needs to be set separately.- Returns:
- created reference
-
outputReferenceFactory
private static MessageReference outputReferenceFactory()
Factory for creating output message reference templates. The actual referenced message information needs to be set separately.- Returns:
- created reference
-
faultReferenceFactory
private static MessageReference faultReferenceFactory()
Factory for creating fault message reference templates. The actual referenced message information needs to be set separately.- Returns:
- created reference
-
-