com.arch.wctp
Class WctpEnterpriseOperations

java.lang.Object
  |
  +--com.arch.wctp.WctpFactory
        |
        +--com.arch.wctp.WctpEnterpriseOperations

public class WctpEnterpriseOperations
extends WctpFactory

WctpEnterpriseOperations
Contains functionality to format WCTP Enterprise packets.
This is beta software that is still in development. Use at your own risk.


New from the previous version 1.1 Beta:
* The method versionQuery(String, boolean) has been added to allow the user to specify if DTDs should be listed.

Copyright 2000-2001, Arch Wireless Holdings, Inc.

Version:
1.2 Beta August 17, 2001

Constructor Summary
WctpEnterpriseOperations()
          WctpEnterpriseOperations constructor comment.
 
Method Summary
 java.lang.String failure(java.lang.String errorCode, java.lang.String errorText, java.lang.String messageText)
          Formats the WCTP packet for a Failure
 java.lang.String pollForMessages(java.lang.String pollerID, java.lang.String securityCode, int maxMessagesInBatch)
          Formats the WCTP packet for a Poll For Messages
 java.lang.String submitMcrRequest(java.lang.String recipientID, java.lang.String messageID, java.lang.String senderID, java.lang.String messageText, java.lang.String[] choices)
          Insert the method's description here.
 java.lang.String submitMcrRequest(java.lang.String recipientID, java.lang.String messageID, java.lang.String senderID, java.lang.String messageText, java.lang.String[] choices, java.lang.String sendResponsesToID)
          Formats the WCTP packet for a submitRequest
 java.lang.String submitRequest(java.lang.String recipientID, java.lang.String payload, java.lang.String senderID, java.lang.String sendResponsesToID, java.lang.String messageID)
          Formats the WCTP packet for a submitRequest
 java.lang.String success(java.lang.String successCode, java.lang.String successText, java.lang.String messageText)
          Formats the WCTP packet for a Success
 java.lang.String versionQuery(java.lang.String inquirer)
          This method formats a WCTP packet for a VersionQuery.
 java.lang.String versionQuery(java.lang.String inquirer, boolean listDTDs)
          This method formats a WCTP packet for a VersionQuery.
 
Methods inherited from class com.arch.wctp.WctpFactory
convertAll, convertAmp, convertApos, convertCR, convertGreaterThan, convertLessThan, convertLF, convertQuote, getTimestamp, readByteResponse, readResponse, sendWctpPacket, sendWctpPacket, sendWctpPacket
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WctpEnterpriseOperations

public WctpEnterpriseOperations()
WctpEnterpriseOperations constructor comment.
Method Detail

failure

public java.lang.String failure(java.lang.String errorCode,
                                java.lang.String errorText,
                                java.lang.String messageText)
Formats the WCTP packet for a Failure
Parameters:
errorCode - the error code
errorText - the error text
messageText - the text to include inside the failure tag
Returns:
the xml document

pollForMessages

public java.lang.String pollForMessages(java.lang.String pollerID,
                                        java.lang.String securityCode,
                                        int maxMessagesInBatch)
Formats the WCTP packet for a Poll For Messages
Parameters:
pollerID -  
securityCode -  
maxMessagesInBatch -  
Returns:
the xml document

submitMcrRequest

public java.lang.String submitMcrRequest(java.lang.String recipientID,
                                         java.lang.String messageID,
                                         java.lang.String senderID,
                                         java.lang.String messageText,
                                         java.lang.String[] choices)
Insert the method's description here. Creation date: (8/2/2001 1:01:11 PM)
Parameters:
recipientID - java.lang.String
messageID - java.lang.String
senderID - java.lang.String
messageText - java.lang.String
choices - java.lang.String[]
notify - boolean
Returns:
java.lang.String

submitMcrRequest

public java.lang.String submitMcrRequest(java.lang.String recipientID,
                                         java.lang.String messageID,
                                         java.lang.String senderID,
                                         java.lang.String messageText,
                                         java.lang.String[] choices,
                                         java.lang.String sendResponsesToID)
Formats the WCTP packet for a submitRequest
Parameters:
recipientID - identifies the recipient of the message (i.e. pager number)
messageID - message reference number
senderID - the sender of the message (i.e. pager number, email address)
Returns:
the xml document

submitRequest

public java.lang.String submitRequest(java.lang.String recipientID,
                                      java.lang.String payload,
                                      java.lang.String senderID,
                                      java.lang.String sendResponsesToID,
                                      java.lang.String messageID)
Formats the WCTP packet for a submitRequest
Parameters:
recipientID - identifies the recipient of the message (i.e. pager number)
messageID - message reference number
the - payload
senderID - the sender of the message (i.e. pager number, email address)
sendResponsesToID - the destination where a receipt should be pushed back to, or null if you do not want this
Returns:
the xml document

success

public java.lang.String success(java.lang.String successCode,
                                java.lang.String successText,
                                java.lang.String messageText)
Formats the WCTP packet for a Success
Parameters:
successCode - the error code
successText - the error text
messageText - the text to include inside the success tag
Returns:
the xml document

versionQuery

public java.lang.String versionQuery(java.lang.String inquirer)
This method formats a WCTP packet for a VersionQuery. Creation date: (4/2/2001 9:45:18 AM)
Parameters:
inquirer - java.lang.String your domain or a some other means to identify yourself.
Returns:
java.lang.String the XML packet

versionQuery

public java.lang.String versionQuery(java.lang.String inquirer,
                                     boolean listDTDs)
This method formats a WCTP packet for a VersionQuery. Creation date: (4/2/2001 9:45:18 AM)
Parameters:
inquirer - java.lang.String your domain or a some other means to identify yourself.
listDTDs - boolean true if you want to list supported DTDs
Returns:
java.lang.String the XML packet