summaryrefslogtreecommitdiff
path: root/sources/events/internal/VSProtocolEvent.java
blob: 39f5fdd6cfa5f159cfb62e4ca995a89933c09998 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/*
 * Copyright (c) 2008 Paul C. Buetow, vs@dev.buetow.org
 *
 * 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;
//import simulator.VSSimulatorVisualization;

/**
 * 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.client")
                      : prefs.getString("lang.server"));

        buffer.append(" ");
        buffer.append(isProtocolActivation
                      ? prefs.getString("lang.activated")
                      : prefs.getString("lang.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();

    }
}