public interface Message
For further information please see MSDN Network Developer Platform Center
Modifier and Type | Method and Description |
---|---|
java.lang.String |
asString()
Deprecated.
use
asString(String) instead. |
java.lang.String |
asString(java.lang.String charset)
Let the underlying implementation try and decipher the body into a String.
|
int |
getAck()
The Ack property specifies the type of acknowledgment messages that Message
Queuing will post (in the administration queue) when acknowledgments are
requested.
|
int |
getAppSpecific()
The AppSpecific property of the MSMQMessage object specifies
application-generated information, such as single integer values or
application-defined message classes.
|
java.util.Date |
getArrivedTime()
The ArrivedTime property of the MSMQMessage object indicates when the
message arrived at the queue.
|
java.lang.String |
getAuthenticationProviderName()
The AuthenticationProviderName property of the MSMQMessage object specifies
the name of the cryptographic provider used to generate the digital
signature attached to the message.
|
int |
getAuthenticationProviderType()
The AuthenticationProviderType property of the MSMQMessage object specifies
the type of cryptographic provider used to generate the digital signature
attached to the message.
|
int |
getAuthLevel()
The AuthLevel property of the MSMQMessage object specifies whether the
message should be authenticated and what type of digital signature is used.
|
java.lang.String |
getBody()
The Body property of the MSMQMessage object specifies the contents of the
message.
|
byte[] |
getBodyBytes()
The Body property of the MSMQMessage object specifies the contents of the
message.
|
int |
getBodyLength()
The BodyLength property of the MSMQMessage object provides the length of
the message body in bytes.
|
short |
getBodyType()
Get the underlying type of the message body.
|
int |
getClass_()
The Class property of the MSMQMessage object provides the message type set
by Message Queuing.
|
byte[] |
getCompoundMessage()
The CompoundMessage property of the MSMQMessage object provides the entire
contents of an SRMP message, including the SOAP envelope and the SOAP
attachments associated with it.
|
java.lang.String |
getConnectorTypeGuid()
The ConnectorTypeGuid property of the MSMQMessage object indicates that
some message properties that are typically set by Message Queuing were set
by the sending application.
|
byte[] |
getCorrelationId()
The CorrelationId property of the MSMQMessage object identifies the message
using a 20-byte, correlation identifier.
|
int |
getDelivery()
The Delivery property of the MSMQMessage object specifies how Message
Queuing delivers the message.
|
byte[] |
getDestinationSymmetricKey()
The DestinationSymmetricKey property of the MSMQMessage object specifies
the symmetric key used to encrypt the message.
|
int |
getEncryptAlgorithm()
The EncryptAlgorithm property of the MSMQMessage object specifies the
encryption algorithm used to encrypt the message body of a private message.
|
byte[] |
getExtension()
The Extension property of the MSMQMessage object specifies additional
application-defined information that is associated with the message.
|
int |
getHashAlgorithm()
The HashAlgorithm property of the MSMQMessage object specifies the hashing
algorithm used by Message Queuing when authenticating messages.
|
byte[] |
getId()
The Id property of the MSMQMessage object identifies the message using an
MSMQ-generated message identifier.
|
short |
getIsAuthenticated()
The IsAuthenticated property of the MSMQMessage object indicates whether
the message was authenticated at the request of the sending application.
|
boolean |
getIsAuthenticated2()
The IsAuthenticated2 property of the MSMQMessage object indicates whether
the message was authenticated at the request of the sending application.
|
short |
getIsFirstInTransaction()
The IsFirstInTransaction property of the MSMQMessage object indicates
whether the message was the first message sent in its transaction.
|
boolean |
getIsFirstInTransaction2()
The IsFirstInTransaction2 property of the MSMQMessage object indicates
whether the message was the first message sent to the queue within a
specific transaction.
|
short |
getIsLastInTransaction()
The IsLastInTransaction property of the MSMQMessage object indicates
whether the message was the last message sent in its transaction.
|
boolean |
getIsLastInTransaction2()
The IsLastInTransaction2 property of the MSMQMessage object indicates
whether the message was the last message sent to the queue within a
specific transaction.
|
int |
getJournal()
The Journal property of the MSMQMessage object specifies whether Message
Queuing stores copies of the message as it is routed to the destination
queue.
|
java.lang.String |
getLabel()
The Label property of the MSMQMessage object specifies a description of the
message.
|
java.lang.String |
getLookupId()
The LookupId property of the MSMQMessage object provides the lookup
identifier of the message.
|
int |
getMaxTimeToReachQueue()
The MaxTimeToReachQueue property of the MSMQMessage object specifies a time
limit (in seconds) for the message to reach the queue.
|
int |
getMaxTimeToReceive()
The MaxTimeToReceive property of the MSMQMessage object specifies a time
limit (in seconds) for the message to be retrieved from the target queue.
|
int |
getMsgClass()
The MsgClass property of the MSMQMessage object indicates the message type.
|
int |
getPriority()
The Priority property of the MSMQMessage object specifies the message's
priority.
|
int |
getPrivLevel()
The PrivLevel property of the MSMQMessage object specifies privacy level of
the message.
|
short |
getReceivedAuthenticationLevel()
The ReceivedAuthenticationLevel property of the MSMQMessage object
indicates whether the message was authenticated at the request of the
sending application and indicates what type of digital signature was used.
|
byte[] |
getSenderCertificate()
The SenderCertificate property of the MSMQMessage object provides an array
of bytes that represents the user certificate.
|
byte[] |
getSenderId()
The SenderId property of the MSMQMessage object is an array of bytes that
represents the identifier of the sending user.
|
int |
getSenderIdType()
The SenderIdType property of the MSMQMessage object specifies the type of
sender identifier found by MSMQ.
|
int |
getSenderVersion()
The SenderVersion property of the MSMQMessage object specifies the wire
format used to send the message.
|
java.util.Date |
getSentTime()
The SentTime property of the MSMQMessage object indicates when a message is
sent.
|
byte[] |
getSignature()
The Signature property of the MSMQMessage object specifies the MSMQ 1.0
signature or application-generated signature that is attached to the
message.
|
java.lang.String |
getSoapEnvelope()
The SoapBody property of the MSMQMessage object specifies
application-generated SOAP body elements for inclusion in the SOAP envelope
of an SRMP message
|
java.lang.String |
getSourceMachineGuid()
The SourceMachineGuid property of the MSMQMessage object provides the
identifier of the source computer that sent the message.
|
int |
getTrace()
The Trace property of the MSMQMessage object specifies how Message Queuing
traces the route of the message.
|
byte[] |
getTransactionId()
The TransactionId property provides the identifier of the transaction that
sent the message.
|
void |
release()
Release any resources held by underlying COM objects.
|
void |
setAck(int i) |
void |
setAppSpecific(int i) |
void |
setAuthenticationProviderName(java.lang.String i) |
void |
setAuthenticationProviderType(int i) |
void |
setAuthLevel(int i) |
void |
setBody(byte[] s) |
void |
setBody(java.lang.String s) |
void |
setConnectorTypeGuid(java.lang.String s) |
void |
setCorrelationId(byte[] b) |
void |
setDelivery(int i) |
void |
setDestinationSymmetricKey(byte[] b) |
void |
setEncryptAlgorithm(int i) |
void |
setExtension(byte[] b) |
void |
setHashAlgorithm(int i) |
void |
setJournal(int i) |
void |
setLabel(java.lang.String s) |
void |
setMaxTimeToReachQueue(int i) |
void |
setMaxTimeToReceive(int i) |
void |
setMsgClass(int i) |
void |
setPriority(int i) |
void |
setPrivLevel(int i) |
void |
setSenderCertificate(byte[] b) |
void |
setSenderId(byte[] b) |
void |
setSenderIdType(int i) |
void |
setSignature(byte[] b) |
void |
setSoapBody(java.lang.String s)
The SoapBody property of the MSMQMessage object specifies
application-generated SOAP body elements for inclusion in the SOAP envelope
of an SRMP message.
|
void |
setSoapHeader(java.lang.String s) |
void |
setTrace(int i) |
void release() throws MSMQException
MSMQException
- wrapping any underlying exception.short getBodyType() throws MSMQException
MSMQException
- wrapping any underlying exception.VarType
int getAck() throws MSMQException
MSMQException
int getAppSpecific() throws MSMQException
MSMQException
java.util.Date getArrivedTime() throws MSMQException
MSMQException
int getAuthLevel() throws MSMQException
MSMQException
MQMSGAUTHLEVEL
java.lang.String getAuthenticationProviderName() throws MSMQException
MSMQException
int getAuthenticationProviderType() throws MSMQException
MSMQException
java.lang.String asString() throws MSMQException
asString(String)
instead.MSMQException
java.lang.String asString(java.lang.String charset) throws MSMQException, java.io.IOException
charset
- the Character set to use, if null, then the system default
encoding is applied.MSMQException
- wrapping any underying MSMQ operation.java.io.UnsupportedEncodingException
- if the character encoding is not
supported.java.io.IOException
java.lang.String getBody() throws MSMQException
MSMQException
byte[] getBodyBytes() throws MSMQException
MSMQException
int getBodyLength() throws MSMQException
MSMQException
int getClass_() throws MSMQException
MSMQException
byte[] getCompoundMessage() throws MSMQException
MSMQException
java.lang.String getConnectorTypeGuid() throws MSMQException
MSMQException
byte[] getCorrelationId() throws MSMQException
MSMQException
int getDelivery() throws MSMQException
MSMQException
byte[] getDestinationSymmetricKey() throws MSMQException
MSMQException
int getEncryptAlgorithm() throws MSMQException
MSMQException
byte[] getExtension() throws MSMQException
MSMQException
int getHashAlgorithm() throws MSMQException
MSMQException
byte[] getId() throws MSMQException
MSMQException
short getIsAuthenticated() throws MSMQException
MSMQException
boolean getIsAuthenticated2() throws MSMQException
MSMQException
short getIsFirstInTransaction() throws MSMQException
MSMQException
boolean getIsFirstInTransaction2() throws MSMQException
MSMQException
short getIsLastInTransaction() throws MSMQException
MSMQException
boolean getIsLastInTransaction2() throws MSMQException
MSMQException
int getJournal() throws MSMQException
MSMQException
java.lang.String getLabel() throws MSMQException
MSMQException
java.lang.String getLookupId() throws MSMQException
MSMQException
int getMaxTimeToReachQueue() throws MSMQException
MSMQException
int getMaxTimeToReceive() throws MSMQException
MSMQException
int getMsgClass() throws MSMQException
MSMQException
int getPriority() throws MSMQException
MSMQException
int getPrivLevel() throws MSMQException
MSMQException
MQMSGPRIVLEVEL
short getReceivedAuthenticationLevel() throws MSMQException
MSMQException
byte[] getSenderCertificate() throws MSMQException
MSMQException
byte[] getSenderId() throws MSMQException
MSMQException
int getSenderIdType() throws MSMQException
MSMQException
int getSenderVersion() throws MSMQException
MSMQException
java.util.Date getSentTime() throws MSMQException
MSMQException
byte[] getSignature() throws MSMQException
MSMQException
java.lang.String getSoapEnvelope() throws MSMQException
MSMQException
java.lang.String getSourceMachineGuid() throws MSMQException
MSMQException
int getTrace() throws MSMQException
MSMQException
MQMSGTRACE
byte[] getTransactionId() throws MSMQException
MSMQException
void setAck(int i) throws MSMQException
MSMQException
getAck()
void setAppSpecific(int i) throws MSMQException
MSMQException
getAppSpecific()
void setAuthLevel(int i) throws MSMQException
MSMQException
getAuthLevel()
void setAuthenticationProviderName(java.lang.String i) throws MSMQException
MSMQException
getAuthenticationProviderName()
void setAuthenticationProviderType(int i) throws MSMQException
MSMQException
getAuthenticationProviderType()
void setBody(java.lang.String s) throws MSMQException
MSMQException
getBody()
void setBody(byte[] s) throws MSMQException
MSMQException
getBody()
void setConnectorTypeGuid(java.lang.String s) throws MSMQException
MSMQException
getConnectorTypeGuid()
void setCorrelationId(byte[] b) throws MSMQException
MSMQException
getCorrelationId()
void setDelivery(int i) throws MSMQException
MSMQException
getDelivery()
void setDestinationSymmetricKey(byte[] b) throws MSMQException
MSMQException
getDestinationSymmetricKey()
void setEncryptAlgorithm(int i) throws MSMQException
MSMQException
getEncryptAlgorithm()
void setExtension(byte[] b) throws MSMQException
MSMQException
getExtension()
void setHashAlgorithm(int i) throws MSMQException
MSMQException
getHashAlgorithm()
void setJournal(int i) throws MSMQException
MSMQException
getJournal()
void setLabel(java.lang.String s) throws MSMQException
MSMQException
getLabel()
void setMaxTimeToReachQueue(int i) throws MSMQException
MSMQException
getMaxTimeToReachQueue()
void setMaxTimeToReceive(int i) throws MSMQException
MSMQException
getMaxTimeToReceive()
void setMsgClass(int i) throws MSMQException
MSMQException
void setPriority(int i) throws MSMQException
MSMQException
getPriority()
void setPrivLevel(int i) throws MSMQException
MSMQException
getPrivLevel()
void setSenderCertificate(byte[] b) throws MSMQException
MSMQException
getSenderCertificate()
void setSenderId(byte[] b) throws MSMQException
MSMQException
getSenderId()
void setSenderIdType(int i) throws MSMQException
MSMQException
getSenderIdType()
void setSignature(byte[] b) throws MSMQException
MSMQException
getSignature()
void setSoapBody(java.lang.String s) throws MSMQException
MSMQException
getSoapEnvelope()
void setSoapHeader(java.lang.String s) throws MSMQException
MSMQException
getSoapEnvelope()
void setTrace(int i) throws MSMQException
MSMQException
getTrace()
Copyright Adaptris