/*
 * VS-Simulator (http://vs-sim.buetow.org)
 * Copyright (c) 2008 - 2009 by Dipl.-Inform. (FH) Paul C. Buetow
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * All icons of the icons/ folder are 	under a Creative Commons
 * Attribution-Noncommercial-Share Alike License a CC-by-nc-sa.
 *
 * The icon's homepage is http://code.google.com/p/ultimate-gnome/
 */

package events.internal;

import java.io.*;

import core.VSInternalProcess;
import events.*;
import protocols.VSAbstractProtocol;
import serialize.VSSerialize;

/**
 * The class VSProtocolEvent, this event is used if a protocol (server or
 * client part) of a process gets enabled or disabled, an object of this class
 * can be for 4 different purporses! Activation of the client protocol,
 * deactivation of the client protocol, activation of the server protocol,
 * deactivation of the server protocol.
 *
 * @author Paul C. Buetow
 */
public class VSProtocolEvent extends VSAbstractInternalEvent
            implements VSCopyableEvent {
    /** The serial version uid */
    private static final long serialVersionUID = 1L;

    /** The protocol classname. */
    private String protocolClassname;

    /** The event is a client protocol if true. Else it is a server protocol */
    private boolean isClientProtocol;

    /** The event is a protocol activation if true. Else it is a deactivation */
    private boolean isProtocolActivation;

    /* (non-Javadoc)
     * @see events.VSCopyableEvent#initCopy(events.VSAbstractEvent)
     */
    public void initCopy(VSAbstractEvent copy) {
        VSProtocolEvent protocolEventCopy = (VSProtocolEvent) copy;
        protocolEventCopy.isClientProtocol(isClientProtocol);
        protocolEventCopy.isProtocolActivation(isProtocolActivation);
        protocolEventCopy.setProtocolClassname(protocolClassname);
    }

    /* (non-Javadoc)
     * @see events.VSAbstractEvent#onInit()
     */
    public void onInit() {
        setClassname(getClass().toString());
    }

    /**
     * Sets if it is a client protocol activation/deactivation.
     *
     * @param isClientProtocol the event is client protocol if true. the event
     * is a server protocol if false.
     */
    public void isClientProtocol(boolean isClientProtocol) {
        this.isClientProtocol = isClientProtocol;
    }

    /**
     * Checks if it is a client protocol activation/deactivation.
     *
     * @return the event is client protocol if true. the event
     * is a server protocol if false.
     */
    public boolean isClientProtocol() {
        return isClientProtocol;
    }

    /**
     * Sets if it is protocol activation.
     *
     * @param isProtocolActivation true, if it is a protocol activation. false,
     *	if it is a protocol deactivation.
     */
    public void isProtocolActivation(boolean isProtocolActivation) {
        this.isProtocolActivation = isProtocolActivation;
    }

    /**
     * Checks if it is protocol activation.
     *
     * @return true, if it is a protocol activation. false, if it is a protocol
     *	deactivation.
     */
    public boolean isProtocolActivation() {
        return isProtocolActivation;
    }

    /**
     * Sets the protocol classname.
     *
     * @param protocolClassname the new protocol classname
     */
    public void setProtocolClassname(String protocolClassname) {
        this.protocolClassname = protocolClassname;
    }

    /* (non-Javadoc)
     * @see events.VSAbstractEvent#onStart()
     */
    public void onStart() {
        VSInternalProcess internalProcess = (VSInternalProcess) process;
        VSAbstractProtocol protocol =
            internalProcess.getProtocolObject(protocolClassname);

        if (isClientProtocol)
            protocol.isClient(isProtocolActivation);
        else
            protocol.isServer(isProtocolActivation);

        StringBuffer buffer = new StringBuffer();
        buffer.append(VSRegisteredEvents.getShortnameByClassname(
                          protocolClassname));

        buffer.append(" ");
        buffer.append(isClientProtocol
                      ? prefs.getString("lang.en.client")
                      : prefs.getString("lang.en.server"));

        buffer.append(" ");
        buffer.append(isProtocolActivation
                      ? prefs.getString("lang.en.activated")
                      : prefs.getString("lang.en.deactivated"));

        log(buffer.toString());
    }

    /* (non-Javadoc)
     * @see serialize.VSSerializable#serialize(serialize.VSSerialize,
     *	java.io.ObjectOutputStream)
     */
    public synchronized void serialize(VSSerialize serialize,
                                       ObjectOutputStream objectOutputStream)
    throws IOException {
        super.serialize(serialize, objectOutputStream);

        /** For later backwards compatibility, to add more stuff */
        objectOutputStream.writeObject(new Boolean(false));

        objectOutputStream.writeObject(protocolClassname);
        objectOutputStream.writeObject(new Boolean(isClientProtocol));
        objectOutputStream.writeObject(new Boolean(isProtocolActivation));

        /** For later backwards compatibility, to add more stuff */
        objectOutputStream.writeObject(new Boolean(false));
    }

    /* (non-Javadoc)
     * @see serialize.VSSerializable#deserialize(serialize.VSSerialize,
     *	java.io.ObjectInputStream)
     */
    @SuppressWarnings("unchecked")
    public synchronized void deserialize(VSSerialize serialize,
                                         ObjectInputStream objectInputStream)
    throws IOException, ClassNotFoundException {
        super.deserialize(serialize, objectInputStream);

        if (VSSerialize.DEBUG)
            System.out.println("Deserializing: VSProtocolEvent");

        /** For later backwards compatibility, to add more stuff */
        objectInputStream.readObject();

        protocolClassname = (String) objectInputStream.readObject();

        isClientProtocol = ((Boolean)
                            objectInputStream.readObject()).booleanValue();;
        isProtocolActivation = ((Boolean)
                                objectInputStream.readObject()).booleanValue();;

        /** For later backwards compatibility, to add more stuff */
        objectInputStream.readObject();
    }
}