incomingiln.java

Java MSN Library of protocol 12

/*
 * Copyright 2004-2005 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package jml.protocol.incoming;

import jml.*;
import jml.impl.AbstractMessenger;
import jml.impl.MsnContactImpl;
import jml.protocol.MsnIncomingMessage;
import jml.protocol.MsnSession;
import jml.util.NumberUtils;
import jml.util.StringUtils;

/**
 * When user have set the init status, received online user
 * info.
 * <p>
 * Supported Protocol: All
 * <p>
 * MSNP8 Syntax: ILN trId userStatus email displayName clientId
 * <p>
 * MSNP9/MSNP10 Syntax: ILN trId userStatus email displayName clientId msnObject
 *   as of recent update, msnObject is 0 when there is no msnObject, as opposed to not there.
 *
 * @author Roger Chen
 * @author Angel Barragán Chacón
 */
public class IncomingILN extends MsnIncomingMessage {

	/**
	 * Create a new instance of this incoming message.
	 *
	 * @param protocol Instance of the protocol used for the message.
	 */
    public IncomingILN(MsnProtocol protocol) {
        super(protocol);
    }

    ////////////////////////////////////////////////////////////////////////////

    /**
     * Retrieve the contact status.
     *
     * @return Contact current status.
     */
    public MsnUserStatus getUserStatus() {
        return MsnUserStatus.parseStr(getParam(0));
    }

    /**
     * Retrieves the contact e-mail.
     *
     * @return Email for the contact.
     */
    public Email getEmail() {
        return Email.parseStr(getParam(1));
    }

    /**
     * Retrieves the contact display name.
     *
     * @return Conatact display name.
     */
    public String getDisplayName() {
        return StringUtils.urlDecode(getParam(2));
    }

    /**
     * Retrieves the contact id.
     *
     * @return Contact unique id.
     */
    public int getClientId() {
        return NumberUtils.stringToInt(getParam(3));
    }

    /**
     * Retrieves the MsnObject (avatar) for the contact.
     *
     * @return MsnObject instance for the avatar of the contact.
     */
    public MsnObject getMsnObject() {
        String object = getParam(4);
        if (object != null && !object.equals("0")) {
            return MsnObject.parseMsnObject(StringUtils.urlDecode(object));
        }
        return null;
    }

    ////////////////////////////////////////////////////////////////////////////

    @Override
	protected void messageReceived(MsnSession session) {
        super.messageReceived(session);

        MsnContactImpl contact = (MsnContactImpl) session.getMessenger()
                .getContactList().getContactByEmail(getEmail());
        if (contact != null) {
            contact.setDisplayName(getDisplayName());
            contact.setClientId(MsnClientId.parseInt(getClientId()));
            contact.setStatus(getUserStatus());
            MsnObject obj = getMsnObject();
            if (obj != null) {
            	contact.setAvatar(obj);
            }
            ((AbstractMessenger) session.getMessenger()).fireContactStatusChanged(contact);
        }
    }
}