syncmanager.java

SyncML的java实现类库 funambol公司发布的

        // the Last overwrite the Next?????????????????
        String timestamp ="<Next>" + src.getNextAnchor() + "</Next>\n";
        
        if (source.getLastAnchor() != 0l) {
            timestamp = "<Last>" + src.getLastAnchor() + "</Last>\n" + timestamp;
        }
        
        sb.append("<Alert>\n");
        sb.append("<CmdID>1</CmdID>\n");
        sb.append("<Data>");
        
        // First, use the syncMode passed as argument,
        // if not valid, use the default for the source
        // as last chance, check the anchor.
        if (syncMode != 0) {
            sb.append(syncMode);
        } else if (src.getSyncMode() != 0) {
            sb.append(SyncML.ALERT_CODE_SLOW);
        } else if (src.getLastAnchor() != 0) {
            sb.append(SyncML.ALERT_CODE_FAST);
        } else {
            sb.append(src.getSyncMode());
        }
        
        SyncFilter f = src.getFilter();
        sb.append("</Data>\n");
        sb.append("<Item>\n");
        sb.append("<Target><LocURI>");
        sb.append(src.getSourceUri());
        sb.append("</LocURI>\n");
        // Apply source filter with a default limit to maxMsgSize.
        // TODO: change it to maxObjSize when the Large Object will be
        // implemented.
        if(f != null) {
            int maxDataSize = maxMsgSize - PROTOCOL_OVERHEAD;
            sb.append(f.toSyncML(maxDataSize));
        }
        sb.append("</Target>\n");
        sb.append("<Source><LocURI>");
        sb.append(src.getName());
        sb.append("</LocURI></Source>\n");
        sb.append("<Meta>\n");
        sb.append("<Anchor xmlns=\"syncml:metinf\">\n");
        sb.append(timestamp);
        sb.append("</Anchor>\n");
        sb.append("</Meta>\n");
        sb.append("</Item>\n");
        sb.append("</Alert>");
        sb.append("\n");
        
        return sb.toString();
    }
    
    /**
     * Constructs the <Put> section of a SyncML initialization message used to
     * carry the device capabilities with the <DevInf> element
     *
     * @param devInf
     *            A reference to the current device configuration (<code>DeviceConfig</code>)
     * @return a String to be added to the initialization SyncML message
     */
    private String createPut(DeviceConfig devInf) {
        StringBuffer sb = new StringBuffer();
        
        //TODO: retrieve most values from the passed DeviceConfig object
        sb.append("<Put>\n")
        .append("<CmdID>2</CmdID>\n")// TODO: this is normally the cmd 2, but...
        .append("<Meta>\n")
        .append("<Type xmlns='syncml:metinf'>application/vnd.syncml-devinf+xml</Type>\n")
        .append("</Meta>\n")
        .append("<Item>\n")
        .append("<Source><LocURI>./devinf12</LocURI></Source>\n")
        .append("<Data>\n")
        
        .append(createDevInf(devInf))
        
        //closing all tags
        .append("</Data>\n")
        .append("</Item>\n")
        .append("</Put>\n");
        
        //reset the flag
        sendDevInf = false;
        
        return sb.toString();
    }
    
    /**
     * Used to build the part of the SyncML modification message containing the
     * device sync capabilities (<Results>) when requested by the server with
     * the command <Get>
     *
     * @param devInf
     *            A reference to the current device configuration (<code>DeviceConfig</code>)
     * @return the string containing the device capabilities part of the SyncML
     *         message sent to the server
     */
    private String createResults(DeviceConfig devInf) {
        StringBuffer sb = new StringBuffer();
        
        sb.append("<Results>\n")
        .append("<CmdID>" + getNextCmdID() + "</CmdID>\n")
        .append("<MsgRef>" + msgIDget + "</MsgRef>\n")
        .append("<CmdRef>" + cmdIDget + "</CmdRef>\n")
        .append("<Meta>\n")
        .append("<Type xmlns='syncml:metinf'>application/vnd.syncml-devinf+xml</Type>\n")
        .append("</Meta>\n")
        .append("<Item>\n")
        .append("<Source><LocURI>./devinf12</LocURI></Source>\n")
        .append("<Data>\n")
        
        .append(createDevInf(devInf))
        
        //closing all tags
        .append("</Data>\n")
        .append("</Item>\n")
        .append("</Results>");
        
        return sb.toString();
    }
    
    /**
     * Used to build the <DevInf> element as part of a SyncML message's <Put> or
     * <Results> section
     *
     * @param devInf
     *            A reference to the current device configuration (<code>DeviceConfig</code>)
     * @return the string containing the device capabilities part of the SyncML
     *         message sent to the server
     */
    private String createDevInf(DeviceConfig devInf) {
        StringBuffer sb = new StringBuffer();
        
        if (devInf.man == null)
            devInf.man = "";
        
        if (devInf.mod == null)
            devInf.mod = "";
        
        if (devInf.oem == null)
            devInf.oem = "";
        
        if (devInf.fwv == null)
            devInf.fwv = "";
        
        if (devInf.swv == null)
            devInf.swv = "";
        
        if (devInf.hwv == null)
            devInf.hwv = "";
        
        if (devInf.devID == null)
            devInf.devID = "";
        
        if (devInf.devType == null)
            devInf.devType = "";
        
        sb.append("<DevInf xmlns='syncml:devinf'>\n")
        .append("<VerDTD>1.2</VerDTD>\n")//mandatory
        .append("<Man>" + devInf.man + "</Man>\n")//mandatory: name of the manufacturer of the device
        .append("<Mod>" + devInf.mod + "</Mod>\n")//mandatory: model name or model number of the device
        .append("<OEM>" + devInf.oem + "</OEM>\n")//optional: Original Equipment Manufacturer
        .append("<FwV>" + devInf.fwv + "</FwV>\n")//mandatory: firmware version of the device or a date
        .append("<SwV>" + devInf.swv + "</SwV>\n")//mandatory: software version of the device or a date
        .append("<HwV>" + devInf.hwv + "</HwV>\n")//mandatory: hardware version of the device or a date
        .append("<DevID>" + devInf.devID + "</DevID>\n")//mandatory: identifier of the source synchronization device
        .append("<DevTyp>" + devInf.devType + "</DevTyp>\n");//mandatory: type of the source synchronization device (see OMA table)
        
        //optional flag (if present, the server SHOULD send time in UTC form)
        if (devInf.utc) {
            sb.append("<UTC/>\n");
        }
        //optional (if present, it specifies that the device supports receiving
        //large objects)
        if (devInf.loSupport) {
            sb.append("<SupportLargeObjs/>\n");
        }
        //optional: server MUST NOT send <NumberOfChanges> if the client has
        //not specified this flag
        if (devInf.nocSupport) {
            sb.append("<SupportNumberOfChanges/>\n");
        }
        
        //<DataStore> one for each of the local datastores
        sb.append("<DataStore>\n")//
        .append("<SourceRef>" + source.getName() + "</SourceRef>\n")
        //required for each specified datastore
        .append("<Rx-Pref>\n")
        .append("<CTType>").append(source.getType()).append("</CTType>\n")
        .append("<VerCT></VerCT>\n")
        .append("</Rx-Pref>\n")
        //required for each specified datastore
        .append("<Tx-Pref>\n")
        .append("<CTType>").append(source.getType()).append("</CTType>\n")
        .append("<VerCT></VerCT>\n")
        .append("</Tx-Pref>\n")
        //SyncCap
        .append("<SyncCap>\n")//mandatory
        .append("<SyncType>1</SyncType>\n")//Support of 'two-way sync'
        .append("<SyncType>2</SyncType>\n")//Support of 'slow two-way sync'
        //TODO: add support of one way?
        .append("<SyncType>7</SyncType>\n")//Support of 'server alerted sync'
        .append("</SyncCap>\n")
        .append("</DataStore>\n")
        .append("</DevInf>\n");
        
        return sb.toString();
    }
    
    /**
     * Checks if in the response from server a <Get> command is present and that
     * the information required by the server with this command is the device
     * capabilities
     *
     * @param response
     *            The SyncML message received from server
     * @return <code>true</code> if the <Get> tag is present in the message
     *         and the required information is the device capabilities
     */
    private boolean isGetCommandFromServer(ChunkedString response) {
        ChunkedString get = null;
        ChunkedString item = null;
        ChunkedString target = null;
        ChunkedString locUri = null;
        ChunkedString syncHdr = null;
        
        if(XmlUtil.getTag(response, "Get") == -1) {
            Log.debug("No <Get> command.");
            return false;
        }
        
        try {
            get = XmlUtil.getTagValue(response, "Get");
            if (get != null) {
                item = XmlUtil.getTagValue(get, "Item");//mandatory if Get present
                target = XmlUtil.getTagValue(item, "Target");
                locUri = XmlUtil.getTagValue(target, "LocURI");
                this.cmdIDget = XmlUtil.getTagValue(get, "CmdID").toString();
                syncHdr = XmlUtil.getTagValue(response, "SyncHdr");
                this.msgIDget = XmlUtil.getTagValue(syncHdr, "MsgID").toString();
            }
        } catch (XmlException e1) {
            e1.printStackTrace();
            Log.error("Invalid get command from server.");
            // TODO: return an error status to the server.
            return false;
        }
        
        //TODO: check if backward compatibility is required (./devinf11)
        if ("./devinf12".equals(locUri)) {
            return true;
        } else {
            return false;
        }
    }
    
    /**
     * This method returns the Add command tag.
     */
    private String getAddCommand(int size) throws SyncException {
        
        SyncItem item = source.getNextNewItem();
        StringBuffer cmdTag = new StringBuffer();
        
        // No item for this source
        if (item == null){
            // No new items -> go to the next state.
            nextState(STATE_SENDING_REPLACE);
            return null;
        }
        
        // Build Add command
        cmdTag.append("<Add>\n")
        .append("<CmdID>" + getNextCmdID() + "</CmdID>\n")
        .append("<Meta><Type xmlns=\"syncml:metinf\">")
        .append(source.getType()).append("</Type>")
        .append(getFormat())
        .append("</Meta>\n");
        
        do {
            cmdTag.append(getItemTag(item));
            // Ask the source for next item
            item = source.getNextNewItem();
            
            // Last new item found
            if(item == null){
                // No new items -> go to the next state.
                nextState(STATE_SENDING_REPLACE);
                break;
            }
        }
        while(size + cmdTag.length() < maxMsgSize);
        
        cmdTag.append("</Add>\n");
        
        return cmdTag.toString();
    }
    
    /**
     * This method returns the Replace command tag.
     */
    private String getReplaceCommand(int size) throws SyncException {
        
        SyncItem item = source.getNextUpdatedItem();
        StringBuffer cmdTag = new StringBuffer();
        
        // No item for this source
        if (item == null){
            // No REPLACE -> go to the next state.
            nextState(STATE_SENDING_DELETE);
            return null;
        }
        
        // Build
        cmdTag.append("<Replace>\n")
        .append("<CmdID>").append(getNextCmdID()).append("</CmdID>\n")
        .append("<Meta><Type xmlns=\"syncml:metinf\">")
        .append(source.getType()).append("</Type>")
        .append(getFormat())
        .append("</Meta>\n");
        
        do {
            cmdTag.append(getItemTag(item));
            // Ask the source for next item
            item = source.getNextUpdatedItem();
            
            // Last item found
            if(item == null){
                // No more ADD/REPLACE/DELETE -> go to the next state.
                nextState(STATE_SENDING_DELETE);
                break;
            }
        }
        while(size + cmdTag.length() < maxMsgSize);
        
        cmdTag.append("</Replace>\n");
        
        return cmdTag.toString();
    }
    
    /**
     * This method returns the Delete command tag.
     */
    private String getDeleteCommand(int