org.cmis.interopserver.services.cap1_1
Class CAP1_1SoapBindingImpl

java.lang.Object
  extended by org.cmis.interopserver.services.base.InteropDmisProxyObject
      extended by org.cmis.interopserver.services.base.BaseSoapBindingImpl
          extended by org.cmis.interopserver.services.cap1_1.CAP1_1SoapBindingImpl
All Implemented Interfaces:
java.io.Serializable, java.rmi.Remote, org.cmis.interopserver.services.base.Base, CAP1_1

public class CAP1_1SoapBindingImpl
extends org.cmis.interopserver.services.base.BaseSoapBindingImpl
implements CAP1_1

See Also:
Serialized Form

Field Summary
static java.lang.String PARSE_ERROR
           
 
Fields inherited from class org.cmis.interopserver.services.base.BaseSoapBindingImpl
alCogs, cogNameMapping, GENERIC_INTERNAL_ERROR, INVALID_SESSION_MESSAGE, log, SERVER_ERROR
 
Constructor Summary
CAP1_1SoapBindingImpl()
           
 
Method Summary
static java.lang.String AlertToXML(org.cmis.interopserver.beans.cap1_1.Alert cap)
           
 org.cmis.interopserver.beans.cap1_1.Alert[] getAlertsSentByPostedDate(java.util.Calendar lastupdate)
          Gets all Alerts sent by the caller since the given date-time, exclusive.
 org.cmis.interopserver.beans.cap1_1.Alert[] getAlertsSentBySentDate(java.util.Calendar lastupdate)
          Gets all Alerts sent by the caller since the given date-time, exclusive.
 org.cmis.interopserver.beans.cap1_1.Alert getCAPAlert(java.lang.String messageid)
          Gets the Alert that corresponds to this identifier.
 org.cmis.interopserver.beans.cap1_1.Alert[] getCAPAlerts(java.util.Calendar lastupdate)
          Gets all Alerts since the given date-time, exclusive.
 org.cmis.interopserver.beans.cap1_1.Alert[] getCAPAlerts(java.lang.String[] searchTerms)
           
 org.cmis.interopserver.beans.cap1_1.Alert[] getCAPAlertsByPostedDate(java.util.Calendar lastupdate)
          Gets all Alerts since the given date-time, exclusive.
 org.cmis.interopserver.beans.cap1_1.Alert[] getCAPAlertsGlobalByPostedDate(java.util.Calendar lastupdate)
          Gets all Alerts globally posted across the system since the given date-time, exclusive..
 org.cmis.interopserver.beans.cap1_1.Alert[] getCAPAlertsGlobalBySentDate(java.util.Calendar lastupdate)
          Gets all Alerts globally posted across the system since the given date-time, exclusive..
 org.cmis.interopserver.beans.cap1_1.Alert[] getMyCogsAlertsByPostedDate(java.util.Calendar lastupdate)
          Gets all Alerts posted to the caller since the given date-time, exclusive.
 org.cmis.interopserver.beans.cap1_1.Alert[] getMyCogsAlertsBySentDate(java.util.Calendar lastupdate)
          Gets all Alerts posted to the caller since the given date-time, exclusive.
 java.util.Calendar getServerTime()
          Retrieves the current time on the server; useful for time-synching to ensure that getCAPAlertsByPostedDate() is accurate.
 void postCAPAlert(org.cmis.interopserver.beans.cap1_1.Alert cap)
          Posts this Alert globally across the system.
 void postCAPAlert(org.cmis.interopserver.beans.cap1_1.Alert cap, org.cmis.interopserver.beans.cap1_1.CAPAttachmentDescriptor[] attachments)
           
 void postCAPAlert(org.cmis.interopserver.beans.cap1_1.Alert cap, org.cmis.interopserver.beans.SimpleCOG[] mailList)
          Posts this Alert to the specified list of COGs.
 void postCAPAlert(org.cmis.interopserver.beans.cap1_1.Alert cap, org.cmis.interopserver.beans.SimpleCOG[] mailList, org.cmis.interopserver.beans.cap1_1.CAPAttachmentDescriptor[] attachments)
           
 void postCAPAlertGlobal(org.cmis.interopserver.beans.cap1_1.Alert cap)
          5-3-2006 post to global cog
protected  org.cmis.interopserver.beans.cap1_1.Alert XMLToAlert(java.lang.String string)
           
 
Methods inherited from class org.cmis.interopserver.services.base.BaseSoapBindingImpl
addAttachment, addAttachment, clientNotifyViaSMTP, clientNotifyViaUrl, convertSimpleCogs, getCogNameMapping, getCogs, getDataHandler, getMyCog, ping
 
Methods inherited from class org.cmis.interopserver.services.base.InteropDmisProxyObject
getOperator, getProxy
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.cmis.interopserver.services.cap1_1.CAP1_1
getCogs, getMyCog, ping
 

Field Detail

PARSE_ERROR

public static final java.lang.String PARSE_ERROR
See Also:
Constant Field Values
Constructor Detail

CAP1_1SoapBindingImpl

public CAP1_1SoapBindingImpl()
Method Detail

getCAPAlert

public org.cmis.interopserver.beans.cap1_1.Alert getCAPAlert(java.lang.String messageid)
                                                      throws java.rmi.RemoteException
Description copied from interface: CAP1_1
Gets the Alert that corresponds to this identifier. Since the CAP identifier is unique only for a particular sender, to retrieve a particular CAP alert, concatenate the CAP sender, a colon, and the CAP identifier to use as the "messageId". If the "messageid" does not correspond to a CAP Alert in the DMIS system, an empty value (NULL), will be returned.

Specified by:
getCAPAlert in interface CAP1_1
Parameters:
messageid - String -> messageId (cap sender):(cap identifier)
Returns:
Alert -> Alert that corresponds to this identifier
Throws:
java.rmi.RemoteException

getCAPAlerts

public org.cmis.interopserver.beans.cap1_1.Alert[] getCAPAlerts(java.lang.String[] searchTerms)
                                                         throws java.rmi.RemoteException
Parameters:
searchTerms -
Returns:
Throws:
java.rmi.RemoteException

getCAPAlerts

public org.cmis.interopserver.beans.cap1_1.Alert[] getCAPAlerts(java.util.Calendar lastupdate)
                                                         throws java.rmi.RemoteException
Description copied from interface: CAP1_1
Gets all Alerts since the given date-time, exclusive. This includes Alerts that have been posted directly to the caller's COG, Alerts sent by the caller, as well as those that have been posted globally. The Alerts are returned in chronological order, from newest to oldest. If the date is invalid, an error is returned. If there are no alerts since that date-time, an empty list is returned.

Specified by:
getCAPAlerts in interface CAP1_1
Parameters:
lastupdate - Calendar -> a date-time cutoff for retrieving posted events, please note this value is being compared to the Sent field in the Alert
Returns:
Alert[] -> An array of Alerts since the given date-time.
Throws:
java.rmi.RemoteException

getCAPAlertsByPostedDate

public org.cmis.interopserver.beans.cap1_1.Alert[] getCAPAlertsByPostedDate(java.util.Calendar lastupdate)
                                                                     throws java.rmi.RemoteException
Description copied from interface: CAP1_1
Gets all Alerts since the given date-time, exclusive. This method is almost identical to CAP1_1.getCAPAlerts(Calendar) except that the date-time value is being compared to the actual time that Alert is posted to the DMIS server instead of the sent field in the Alert.

Specified by:
getCAPAlertsByPostedDate in interface CAP1_1
Parameters:
lastupdate - Calendar --> a date-time cutoff for retrieving posted events, please note this value is being compared to the actual time that Alert is posted to the DMIS server.
Returns:
Alert[] --> An array of Alerts since the given date-time.
Throws:
java.rmi.RemoteException

getMyCogsAlertsByPostedDate

public org.cmis.interopserver.beans.cap1_1.Alert[] getMyCogsAlertsByPostedDate(java.util.Calendar lastupdate)
                                                                        throws java.rmi.RemoteException
Description copied from interface: CAP1_1
Gets all Alerts posted to the caller since the given date-time, exclusive. The Alerts are returned in chronological order, from newest to oldest. If the date is invalid, an error is returned. If there are no alerts since that date-time, an empty list is returned.

Specified by:
getMyCogsAlertsByPostedDate in interface CAP1_1
Parameters:
lastupdate - Calendar --> date-time value being compared to the time each Alert is being posted to the DMIS system.
Returns:
Alert[] --> An array of Alerts posted to the caller since the given date.
Throws:
java.rmi.RemoteException

getMyCogsAlertsBySentDate

public org.cmis.interopserver.beans.cap1_1.Alert[] getMyCogsAlertsBySentDate(java.util.Calendar lastupdate)
                                                                      throws java.rmi.RemoteException
Description copied from interface: CAP1_1
Gets all Alerts posted to the caller since the given date-time, exclusive. The Alerts are returned in chronological order, from newest to oldest. If the date is invalid, an error is returned. If there are no alerts since that date-time, an empty list is returned.

Specified by:
getMyCogsAlertsBySentDate in interface CAP1_1
Parameters:
lastupdate - Calendar --> date-time value being compared to the Alert's sent field Alert is being posted to the DMIS system.
Returns:
Alert[] --> An array of Alerts posted to the caller since the given date
Throws:
java.rmi.RemoteException

getAlertsSentBySentDate

public org.cmis.interopserver.beans.cap1_1.Alert[] getAlertsSentBySentDate(java.util.Calendar lastupdate)
                                                                    throws java.rmi.RemoteException
Description copied from interface: CAP1_1
Gets all Alerts sent by the caller since the given date-time, exclusive. The Alerts are returned in chronological order, from newest to oldest. If the date is invalid, an error is returned. If there are no alerts sent since that date-time, an empty list is returned.

Specified by:
getAlertsSentBySentDate in interface CAP1_1
Parameters:
lastupdate - Calendar --> date-time value being compared to each Alert's sent filed of each Alert
Returns:
Alert[] --> An array of Alerts sent by the caller.
Throws:
java.rmi.RemoteException

getAlertsSentByPostedDate

public org.cmis.interopserver.beans.cap1_1.Alert[] getAlertsSentByPostedDate(java.util.Calendar lastupdate)
                                                                      throws java.rmi.RemoteException
Description copied from interface: CAP1_1
Gets all Alerts sent by the caller since the given date-time, exclusive. The Alerts are returned in chronological order, from newest to oldest. If the date is invalid, an error is returned. If there are no alerts sent since that date-time, an empty list is returned.

Specified by:
getAlertsSentByPostedDate in interface CAP1_1
Parameters:
lastupdate - Calendar --> date-time value being compared to the time each Alert is being posted to the DMIS system.
Returns:
Alert[] --> An array of Alerts sent by the caller.
Throws:
java.rmi.RemoteException

getCAPAlertsGlobalByPostedDate

public org.cmis.interopserver.beans.cap1_1.Alert[] getCAPAlertsGlobalByPostedDate(java.util.Calendar lastupdate)
                                                                           throws java.rmi.RemoteException
Description copied from interface: CAP1_1
Gets all Alerts globally posted across the system since the given date-time, exclusive.. If there are no alerts posted globally, an empty list is returned.

Specified by:
getCAPAlertsGlobalByPostedDate in interface CAP1_1
Parameters:
lastupdate - Calendar --> value being compared to the actual time Alert is being posted to DMIS.
Returns:
Alert[] --> An array of Alerts posted globally.
Throws:
java.rmi.RemoteException

getCAPAlertsGlobalBySentDate

public org.cmis.interopserver.beans.cap1_1.Alert[] getCAPAlertsGlobalBySentDate(java.util.Calendar lastupdate)
                                                                         throws java.rmi.RemoteException
Description copied from interface: CAP1_1
Gets all Alerts globally posted across the system since the given date-time, exclusive.. If there are no alerts posted globally, an empty list is returned.

Specified by:
getCAPAlertsGlobalBySentDate in interface CAP1_1
Parameters:
lastupdate - Calendar --> value being compared to the sent field
Returns:
Alert[] --> An array of Alerts posted globally.
Throws:
java.rmi.RemoteException

postCAPAlert

public void postCAPAlert(org.cmis.interopserver.beans.cap1_1.Alert cap,
                         org.cmis.interopserver.beans.SimpleCOG[] mailList,
                         org.cmis.interopserver.beans.cap1_1.CAPAttachmentDescriptor[] attachments)
                  throws java.rmi.RemoteException
Parameters:
cap -
mailList -
attachments -
Throws:
java.rmi.RemoteException

postCAPAlert

public void postCAPAlert(org.cmis.interopserver.beans.cap1_1.Alert cap,
                         org.cmis.interopserver.beans.SimpleCOG[] mailList)
                  throws java.rmi.RemoteException
Description copied from interface: CAP1_1
Posts this Alert to the specified list of COGs. Once posted, the Alert will be accessible to users of any of the COGs on that list, as well as the sender's COG. This is semantically identical to using CAP1_1.postCAPAlert(Alert) with a Private scope and COG ids specified in the address field as described above. This method will ignore the address and scope fields of the Alert and post it only to the COGs specified in the array of SimpleCOG objects supplied. If any of the COGs specified in the COG array are invalid, an error will be returned and no posting will take place. The same is true if there are duplicates in the COG array, or if the sender's COG is specified in the COG array. This method does not return anything; if no error is returned then the posting has succeeded.

Specified by:
postCAPAlert in interface CAP1_1
Parameters:
cap - Alert -> CAP Alert to be posted
mailList - SimpleCOG[] -> a list of COGs to post the CAP Alert
Throws:
java.rmi.RemoteException

postCAPAlertGlobal

public void postCAPAlertGlobal(org.cmis.interopserver.beans.cap1_1.Alert cap)
                        throws java.rmi.RemoteException
5-3-2006 post to global cog

Throws:
java.rmi.RemoteException

postCAPAlert

public void postCAPAlert(org.cmis.interopserver.beans.cap1_1.Alert cap,
                         org.cmis.interopserver.beans.cap1_1.CAPAttachmentDescriptor[] attachments)
                  throws java.rmi.RemoteException
Parameters:
cap -
attachments -
Throws:
java.rmi.RemoteException

postCAPAlert

public void postCAPAlert(org.cmis.interopserver.beans.cap1_1.Alert cap)
                  throws java.rmi.RemoteException
Description copied from interface: CAP1_1
Posts this Alert globally across the system. Once posted, the Alert will be accessible by users of all COGs (including the sender's) via the "getCAPAlert" methods, with the following exception: If the value of the Alert's Alert.scope field is "Private" and the org.cmis.interopserver.beans.cap.Alert#address field contains a space-delimited series COGs in the form "COGx" where x is a valid COG SimpleCOG.id (for example, COG1737 COG1000 COG2) then the Alert will be posted to only those specified COGs. If any of the COG ids are invalid, an error will be returned and no posting will take place. In any other case, the Alert will be posted globally across the DMIS system (to all COGs). This method does not return anything; if no error is returned then the posting has succeeded.

Specified by:
postCAPAlert in interface CAP1_1
Parameters:
cap - Alert to be posted.
Throws:
java.rmi.RemoteException - A remote exception occurred

getServerTime

public java.util.Calendar getServerTime()
                                 throws java.rmi.RemoteException
Description copied from interface: CAP1_1
Retrieves the current time on the server; useful for time-synching to ensure that getCAPAlertsByPostedDate() is accurate. Note that current server time is also returned as a SOAP header with each request; this method is here only for convenience.

Specified by:
getServerTime in interface CAP1_1
Returns:
Throws:
java.rmi.RemoteException

XMLToAlert

protected org.cmis.interopserver.beans.cap1_1.Alert XMLToAlert(java.lang.String string)
                                                        throws java.io.IOException
Parameters:
string -
Returns:
Throws:
java.io.IOException

AlertToXML

public static java.lang.String AlertToXML(org.cmis.interopserver.beans.cap1_1.Alert cap)
                                   throws java.io.IOException
Parameters:
cap -
Returns:
Throws:
java.io.IOException