The change is done only if the sync sources to sync are in the given
* syncSourcesToProcess list and the client device id is not in the
* devicesNotToProcess list.
*
* This synclet uses the following context properties:
*
If the DEVICEID_ORIG in the processingContext is null, no change is performed.
*
* @version $Id: ChangeDeviceIdSynclet.java,v 1.3 2007-01-11 19:20:19 nichele Exp $
*/
public class ChangeDeviceIdSynclet
implements InputMessageProcessor, OutputMessageProcessor {
// --------------------------------------------------------------- Constants
private static final String PROPERTY_ORIG_ID =
"funambol.foundation.changedevice.DEVICEID_ORIG";
private static final String CLIENT_DEVICEID = "syncml-phone";
private static final String SYNCLET_NAME = ChangeDeviceIdSynclet.class.getName();
// ------------------------------------------------------------ Private data
private static final FunambolLogger log =
FunambolLoggerFactory.getLogger("engine.pipeline");
/**
* Contain the original client device Id
*/
private String clientDeviceId = null;
/**
* Contains the uri of the sync sources to process.
* If in the message to process, there are a syncsource specified in the list,
* then the message is processed
*/
private ArrayList syncSourcesToProcess = null;
/**
* Contains the list of the known devices of which the ID doesn't have
* to be changed.
*/
private ArrayList devicesNotToProcess = null;
// ---------------------------------------------------------- Public methods
/**
* Process input message and set MessageProcessingContext property.
*
* @param processingContext the message processing context
* @param message the message to be processed
* @throws Sync4jException
*/
public void preProcessMessage(MessageProcessingContext processingContext,
SyncML message) throws Sync4jException {
if (log.isTraceEnabled()) {
log.trace(SYNCLET_NAME + ".preProcessMessage(...)");
}
boolean processMessage = true;
if (clientDeviceId == null) {
processMessage = checkSourceUriToSync(message);
}
if (log.isTraceEnabled()) {
log.trace(SYNCLET_NAME + " - device id replacement " + (processMessage ? "" : "not ") + "required");
}
if (processMessage) {
if (clientDeviceId == null) {
clientDeviceId = message.getSyncHdr().getSource().getLocURI();
}
if (log.isTraceEnabled()) {
log.trace(SYNCLET_NAME + " - original clientDeviceId '" + clientDeviceId + "'");
}
if (!devicesNotToProcess.contains(clientDeviceId)) {
Source source = message.getSyncHdr().getSource();
source.setLocURI(CLIENT_DEVICEID);
processingContext.setRequestProperty(PROPERTY_ORIG_ID, clientDeviceId);
}
}
}
/**
* Process and manipulate the output message.
*
* @param processingContext the message processing context
* @param message the message to be processed
* @throws Sync4jException
*/
public void postProcessMessage(MessageProcessingContext processingContext,
SyncML message) throws Sync4jException {
if (log.isTraceEnabled()) {
log.trace(SYNCLET_NAME + ".postProcessMessage(...)");
}
if (clientDeviceId == null) {
clientDeviceId = (String)processingContext.getRequestProperty(PROPERTY_ORIG_ID);
}
//
// If still null, no processing is required
//
if (clientDeviceId == null) {
if (log.isTraceEnabled()) {
log.trace(SYNCLET_NAME + " - processing not required");
}
} else {
if (log.isTraceEnabled()) {
log.trace(SYNCLET_NAME + " - setting device id to '" + clientDeviceId + "'");
}
Target target = message.getSyncHdr().getTarget();
target.setLocURI(clientDeviceId);
//
// We have also to change the SourceRef in the SyncHdr's status
//
SyncBody body = message.getSyncBody();
AbstractCommand[] allServerCommands =
(AbstractCommand[])body.getCommands().toArray(new AbstractCommand[0]);
ArrayList listStatus =
ProtocolUtil.filterCommands(allServerCommands,
Status.class);
if (listStatus != null && listStatus.size() != 0) {
Status status = (Status) listStatus.get(0);
List sourceRefList = status.getSourceRef();
if (sourceRefList != null && sourceRefList.size() != 0) {
SourceRef sourceRef =
(SourceRef)sourceRefList.get(0);
sourceRef.setValue(clientDeviceId);
}
}
}
}
/**
* Set the syncSourcesToProcess
* @param list the syncSourcesToProcess
*/
public void setSyncSourcesToProcess(ArrayList list) {
this.syncSourcesToProcess = list;
}
/**
* Set the devicesNotToProcess
*
* @param list the devicesNotToProcess
*/
public void setDevicesNotToProcess(ArrayList list) {
this.devicesNotToProcess = list;
}
// --------------------------------------------------------- Private Methods
/**
* Checks if the sync sources that are in the syncml message are present
* in the list syncSourcesToProcess
*
* @param message the message to process
* @return boolean
*/
private boolean checkSourceUriToSync(SyncML message) {
if (syncSourcesToProcess == null) {
return false;
}
SyncBody syncBody = message.getSyncBody();
AbstractCommand[] allClientCommands =
(AbstractCommand[])syncBody.getCommands().toArray(
new AbstractCommand[0]);
ArrayList alertList = ProtocolUtil.filterCommands(allClientCommands,
Alert.class);
Iterator itAlertList = alertList.iterator();
Alert alert = null;
ArrayList items = null;
Iterator itItem = null;
Item item = null;
Target target = null;
String sourceUri = null;
while (itAlertList.hasNext()) {
alert = (Alert)itAlertList.next();
items = alert.getItems();
itItem = items.iterator();
while (itItem.hasNext()) {
item = (Item)itItem.next();
target = item.getTarget();
if (target != null) {
sourceUri = target.getLocURI();
if (syncSourcesToProcess.indexOf(sourceUri) != -1) {
// the source uri is present in the list of the
// sync source to process
return true;
}
}
}
}
return false;
}
}