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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
|
/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* 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 net.java.sip.communicator.impl.protocol.jabber.extensions.jibri;
import org.jitsi.util.*;
import org.jivesoftware.smack.packet.*;
import java.util.*;
/**
* The IQ used to control conference recording with Jibri component.
*
* Start the recording:
*
* 1. Send Jibri IQ with {@link Action#START} to Jibri.
* 2. Jibri replies with RESULT and status {@link Status#PENDING}.
* 3. Jibri sends SET IQ with status {@link Status#ON} once recording actually
* starts.
*
* Stop the recording:
*
* 1. Send Jibri IQ with {@link Action#STOP} to Jibri.
* 2. Jibri replies with {@link Status#OFF} immediately if the recording has
* been stopped already or sends separate Jibri SET IQ later on if it takes
* more time.
*
* @author lishunyang
* @author Pawel Domas
*/
public class JibriIq
extends IQ
{
/**
* Attribute name of "action".
*/
public static final String ACTION_ATTR_NAME = "action";
/**
* XML element name of the Jibri IQ.
*/
public static final String ELEMENT_NAME = "jibri";
/**
* XML namespace of the Jibri IQ.
*/
public static final String NAMESPACE = "http://jitsi.org/protocol/jibri";
/**
* The name of XML attribute which stores the recording status.
*/
static final String STATUS_ATTR_NAME = "status";
/**
* The name of XML attribute which stores the stream id.
*/
static final String STREAM_ID_ATTR_NAME = "streamid";
/**
* The name of XML attribute which stores the name of the conference room to
* be recorded.
*/
static final String ROOM_ATTR_NAME = "room";
/**
* Holds the action.
*/
private Action action = Action.UNDEFINED;
/**
* XMPPError stores error details for {@link Status#FAILED}.
*/
private XMPPError error;
/**
* Holds recording status.
*/
private Status status = Status.UNDEFINED;
/**
* The ID of the stream which will be used to record the conference. The
* value depends on recording service provider.
*/
private String streamId = null;
/**
* The name of the conference room to be recorded.
*/
private String room = null;
/**
* Returns the value of {@link #STREAM_ID_ATTR_NAME} attribute.
* @return a <tt>String</tt> which contains the value of "stream id"
* attribute or <tt>null</tt> if empty.
*/
public String getStreamId()
{
return streamId;
}
/**
* Sets the value for {@link #STREAM_ID_ATTR_NAME} attribute.
* @param streamId a <tt>String</tt> for the stream id attribute or
* <tt>null</tt> to remove it from XML element.
*/
public void setStreamId(String streamId)
{
this.streamId = streamId;
}
/**
* Returns the value of {@link #ROOM_ATTR_NAME} attribute.
* @return a <tt>String</tt> which contains the value of the room attribute
* or <tt>null</tt> if empty.
* @see #room
*/
public String getRoom()
{
return room;
}
/**
* Sets the value for {@link #ROOM_ATTR_NAME} attribute.
* @param room a <tt>String</tt> for the room attribute or <tt>null</tt> to
* remove it from XML element.
* @see #room
*/
public void setRoom(String room)
{
this.room = room;
}
/**
* {@inheritDoc}
*/
@Override
public String getChildElementXML()
{
StringBuilder xml = new StringBuilder();
xml.append('<').append(ELEMENT_NAME);
xml.append(" xmlns='").append(NAMESPACE).append("' ");
if (action != Action.UNDEFINED)
{
printStringAttribute(xml, ACTION_ATTR_NAME, action.toString());
}
if (status != Status.UNDEFINED)
{
printStringAttribute(xml, STATUS_ATTR_NAME, status.toString());
}
if (room != null)
{
printStringAttribute(xml, ROOM_ATTR_NAME, room);
}
if (streamId != null)
{
printStringAttribute(xml, STREAM_ID_ATTR_NAME, streamId);
}
Collection<PacketExtension> extensions = getExtensions();
if (extensions.size() > 0)
{
xml.append(">");
for (PacketExtension extension : extensions)
{
xml.append(extension.toXML());
}
xml.append("</").append(ELEMENT_NAME).append(">");
}
else
{
xml.append("/>");
}
return xml.toString();
}
private void printStringAttribute(
StringBuilder xml, String attrName, String attr)
{
if (!StringUtils.isNullOrEmpty(attr))
{
attr = org.jivesoftware.smack.util.StringUtils.escapeForXML(attr);
xml.append(attrName).append("='")
.append(attr).append("' ");
}
}
/**
* Sets the value of 'action' attribute.
*
* @param action the value to be set as 'action' attribute of this IQ.
*/
public void setAction(Action action)
{
this.action = action;
}
/**
* Returns the value of 'action' attribute.
*/
public Action getAction()
{
return action;
}
/**
* Sets the value of 'status' attribute.
*/
public void setStatus(Status status)
{
this.status = status;
}
/**
* Returns the value of 'status' attribute.
*/
public Status getStatus()
{
return status;
}
/**
* Sets the <tt>XMPPError</tt> which will provide details about Jibri
* failure. It is expected to be set when this IQ's status value is
* {@link Status#FAILED}.
*
* @param error <tt>XMPPError</tt> to be set on this <tt>JibriIq</tt>
* instance.
*/
public void setXMPPError(XMPPError error)
{
this.error = error;
}
/**
* Returns {@link XMPPError} with Jibri error details when the status is
* {@link Status#FAILED}.
*/
public XMPPError getError()
{
return error;
}
/**
* Enumerative value of attribute "action" in recording extension.
*
* @author lishunyang
* @author Pawel Domas
*
*/
public enum Action
{
/**
* Start the recording.
*/
START("start"),
/**
* Stop the recording.
*/
STOP("stop"),
/**
* Unknown/uninitialized
*/
UNDEFINED("undefined");
private String name;
Action(String name)
{
this.name = name;
}
@Override
public String toString()
{
return name;
}
/**
* Parses <tt>Action</tt> from given string.
*
* @param action the string representation of <tt>Action</tt>.
*
* @return <tt>Action</tt> value for given string or
* {@link #UNDEFINED} if given string does not
* reflect any of valid values.
*/
public static Action parse(String action)
{
if (StringUtils.isNullOrEmpty(action))
return UNDEFINED;
try
{
return Action.valueOf(action.toUpperCase());
}
catch(IllegalArgumentException e)
{
return UNDEFINED;
}
}
}
/**
* The enumeration of recording status values.
*/
public enum Status
{
/**
* Recording is in progress.
*/
ON("on"),
/**
* Recording stopped.
*/
OFF("off"),
/**
* Starting the recording process.
*/
PENDING("pending"),
/**
* The recorder has failed and the service is retrying on another
* instance.
*/
RETRYING("retrying"),
/**
* An error occurred any point during startup, recording or shutdown.
*/
FAILED("failed"),
/**
* There are Jibri instances connected to the system, but all of them
* are currently busy.
*/
BUSY("busy"),
/**
* Unknown/uninitialized.
*/
UNDEFINED("undefined");
/**
* Status name holder.
*/
private String name;
/**
* Creates new {@link Status} instance.
* @param name a string corresponding to one of {@link Status} values.
*/
Status(String name)
{
this.name = name;
}
/**
* {@inheritDoc}
*/
@Override
public String toString()
{
return name;
}
/**
* Parses <tt>Status</tt> from given string.
*
* @param status the string representation of <tt>Status</tt>.
*
* @return <tt>Status</tt> value for given string or
* {@link #UNDEFINED} if given string does not
* reflect any of valid values.
*/
public static Status parse(String status)
{
if (StringUtils.isNullOrEmpty(status))
return UNDEFINED;
try
{
return Status.valueOf(status.toUpperCase());
}
catch(IllegalArgumentException e)
{
return UNDEFINED;
}
}
}
}
|