sipwise
/
jitsi
mirror of https://github.com/sipwise/jitsi.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Adds a class that represents an RFC4575 Conference Information document. Intended to be used to merge the SIP and XMPP code that handles such documents and remove code duplication.

Browse Source
cusax-fix
Boris Grozev 13 years ago
parent 2a2cdb89b1
commit 9d31aa5ce8
1 changed files with 511 additions and 0 deletions
Show Stats Download Patch File Download Diff File

511
src/net/java/sip/communicator/util/ConferenceInfoDocument.java
Unescape View File

@ -0,0 +1,511 @@
/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.util;
import org.jitsi.util.xml.*;
import org.w3c.dom.*;
/**
* A class that represents a Conference Information XML document as defined in
* RFC4575. It wraps around a DOM <tt>Document</tt> providing convenience
* functions.
*
* {@link "http://tools.ietf.org/html/rfc4575"}
*
* @author Boris Grozev
* @author Sebastien Vincent
*/
public class ConferenceInfoDocument
{
/**
* The <tt>Logger</tt> used by the <tt>ConferenceInfoDocument</tt> class
* and its instances for logging output.
*/
private static final Logger logger
= Logger.getLogger(ConferenceInfoDocument.class);
/**
* The namespace of the conference-info element.
*/
public static String NAMESPACE = "urn:ietf:params:xml:ns:conference-info";
/**
* The name of the "state" attribute.
*/
public static String STATE_ATTR_NAME = "state";
/**
* The name of the "entity" attribute.
*/
public static String ENTITY_ATTR_NAME = "entity";
/**
* The name of the "version" attribute.
*/
public static String VERSION_ATTR_NAME = "version";
/**
* The <tt>Document</tt> object that we wrap around.
*/
private Document document;
/**
* The single <tt>conference-info</tt> element of <tt>document</tt>
*/
private Element conferenceInfo;
/**
* The <tt>conference-description</tt> child element of
* <tt>conference-info</tt>.
*/
private Element conferenceDescription;
/**
* The <tt>conference-state</tt> child element of <tt>conference-info</tt>.
*/
private Element conferenceState;
/**
* The <tt>conference-state</tt> child element of <tt>conference-state</tt>.
*/
private Element userCount;
/**
* The <tt>users</tt> child element of <tt>conference-info</tt>.
*/
private Element users;
/**
* Creates a new <tt>ConferenceInfoDocument</tt> instance.
*/
public ConferenceInfoDocument()
throws Exception
{
try
{
document = XMLUtils.createDocument();
}
catch (Exception e)
{
logger.error("Failed to create a new document.", e);
throw(e);
}
conferenceInfo = document.createElementNS(NAMESPACE, "conference-info");
document.appendChild(conferenceInfo);
conferenceDescription = document.createElement("conference-description");
conferenceInfo.appendChild(conferenceDescription);
conferenceState = document.createElement("conference-state");
conferenceInfo.appendChild(conferenceState);
userCount = document.createElement("user-count");
userCount.setTextContent("0");
conferenceState.appendChild(userCount);
users = document.createElement("users");
conferenceState.appendChild(users);
}
/**
* Creates a new <tt>ConferenceInfoDocument</tt> instance and populates it
* by parsing the XML in <tt>xml</tt>
*
* @param xml the XML string to parse
*/
public ConferenceInfoDocument(String xml) throws Exception
{
try
{
document = XMLUtils.createDocument(xml);
}
catch (Exception e)
{
logger.error("Failed to create a new document.", e);
}
//XXX this is not tested yet. do we need to set a namespace?
try
{
conferenceInfo = document.getElementById("conference-info");
conferenceDescription = XMLUtils.findChild(conferenceInfo, "conference-description");
conferenceState = XMLUtils.findChild(conferenceInfo, "conference-state");
userCount = XMLUtils.findChild(conferenceState, "user-count");
users = XMLUtils.findChild(conferenceInfo, "users");
}
catch (Exception e)
{
logger.warn("Failed to parse document: " + xml);
throw(e);
}
}
/**
* Returns the value of the <tt>version</tt> attribute of the
* <tt>conference-info</tt> element.
* @return the value of the <tt>version</tt> attribute of the
* <tt>conference-info</tt> element.
*/
public int getVersion()
{
String versionString = conferenceInfo.getAttribute(VERSION_ATTR_NAME);
int version = -1;
try
{
version = Integer.parseInt(versionString);
}
catch (Exception e){}
return version;
}
/**
* Sets the <tt>version</tt> attribute of the <tt>conference-info</tt>
* element.
* @param version the value to set the <tt>version</tt> attribute of the
* <tt>conference-info</tt> element to.
*/
public void setVersion(int version)
{
conferenceInfo.setAttribute(VERSION_ATTR_NAME, Integer.toString(version));
}
/**
* Gets the value of the <tt>state</tt> attribute of the
* <tt>conference-info</tt> element.
* @return the value of the <tt>state</tt> attribute of the
* <tt>conference-info</tt> element.
*/
public State getState()
{
return State.parseString(conferenceInfo.getAttribute(STATE_ATTR_NAME));
}
/**
* Sets the value of the <tt>state</tt> attribute of the
* <tt>conference-info</tt> element.
* @param state the value to set the <tt>state</tt> attribute of the
* <tt>conference-info</tt> element to.
*/
public void setState(State state)
{
conferenceInfo.setAttribute(STATE_ATTR_NAME, state.toString());
}
/**
* Gets the value of the <tt>sid</tt> attribute of the
* <tt>conference-info</tt> element.
* This is not part of RFC4575 and is here because we are temporarily using
* it in our XMPP implementation.
* TODO: remote it when we define another way to handle the Jingle SID
*
* @return the value of the <tt>sid</tt> attribute of the
* <tt>conference-info</tt> element.
*
*/
public String getSid()
{
return conferenceInfo.getAttribute(STATE_ATTR_NAME);
}
/**
* Sets the value of the <tt>sid</tt> attribute of the
* <tt>conference-info</tt> element.
* This is not part of RFC4575 and is here because we are temporarily using
* it in our XMPP implementation.
* TODO: remote it when we define another way to handle the Jingle SID
*
* @param sid the value to set the <tt>sid</tt> attribute of the
* <tt>conference-info</tt> element to.
*
*/
public void setSid(String sid)
{
conferenceInfo.setAttribute("sid", sid);
}
public void setEntity(String entity)
{
conferenceInfo.setAttribute("entity", entity);
}
public void setUserCount(int count)
{
userCount.setTextContent(Integer.toString(count));
}
public int getUserCount()
{
int ret = 0;
try
{
ret = Integer.parseInt(userCount.getTextContent());
}
catch (Exception e)
{
logger.warn("Could not parse user-count field");
}
return ret;
}
public Document getDocument() {
return document;
}
public User addNewUser(String entity)
{
Element userElement = document.createElement("user");
User user = new User(userElement);
user.setEntity(entity);
users.appendChild(user.user);
return user;
}
public enum State
{
FULL("full"),
PARTIAL("partial"),
DELETED("deleted");
private String name;
private State(String name)
{
this.name = name;
}
@Override
public String toString()
{
return name;
}
public static State parseString(String s)
{
if (FULL.toString().equals(s))
return FULL;
else if(PARTIAL.toString().equals(s))
return PARTIAL;
else if(DELETED.toString().equals(s))
return DELETED;
else
return null;
}
}
public class User
{
Element user;
private User(Element user)
{
this.user = user;
}
public void setEntity(String entity)
{
user.setAttribute(ENTITY_ATTR_NAME, entity);
}
public void setState(State state)
{
user.setAttribute(STATE_ATTR_NAME, state.toString());
}
public Endpoint addNewEndpoint(String entity)
{
Element endpointElement = document.createElement("endpoint");
Endpoint endpoint = new Endpoint(endpointElement);
endpoint.setEntity(entity);
user.appendChild(endpoint.endpoint);
return endpoint;
}
public void setDisplayText(String text)
{
Element displayText = document.createElement("display-text");
displayText.setTextContent(text);
user.appendChild(displayText);
}
}
public class Endpoint
{
private Element endpoint;
private Endpoint(Element endpoint)
{
this.endpoint = endpoint;
}
public void setEntity(String entity)
{
endpoint.setAttribute("entity", entity);
}
public void setStatus(EndpointStatusType status)
{
Element statusElement = document.createElement("status");
statusElement.setTextContent(status.toString());
endpoint.appendChild(statusElement);
}
public Media addNewMedia(String id)
{
Element mediaElement = document.createElement("media");
Media media = new Media(mediaElement);
media.setId(id);
endpoint.appendChild(media.media);
return media;
}
}
public class Media
{
Element media;
private Media(Element media)
{
this.media = media;
}
public void setId(String id)
{
media.setAttribute("id", id);
}
public void setSrcId(String srcId)
{
Element element = document.createElement("src-id");
element.setTextContent(srcId);
media.appendChild(element);
}
public void setType(String type)
{
Element element = document.createElement("type");
element.setTextContent(type);
media.appendChild(element);
}
public void setStatus(String status)
{
Element element = document.createElement("status");
element.setTextContent(status);
media.appendChild(element);
}
}
/**
* Endpoint status type.
*
* @author Sebastien Vincent
*/
public enum EndpointStatusType
{
/**
* Pending.
*/
pending("pending"),
/**
* Dialing-out.
*/
dialing_out ("dialing-out"),
/**
* Dialing-in.
*/
dialing_in("dialing-in"),
/**
* Alerting.
*/
alerting("alerting"),
/**
* On-hold.
*/
on_hold("on-hold"),
/**
* Connected.
*/
connected("connected"),
/**
* Muted via focus.
*/
muted_via_focus("mute-via-focus"),
/**
* Disconnecting.
*/
disconnecting("disconnecting"),
/**
* Disconnected.
*/
disconnected("disconnected");
/**
* The name of this type.
*/
private final String type;
/**
* Creates a <tt>EndPointType</tt> instance with the specified name.
*
* @param type type name.
*/
private EndpointStatusType(String type)
{
this.type = type;
}
/**
* Returns the type name.
*
* @return type name
*/
@Override
public String toString()
{
return type;
}
/**
* Returns a <tt>EndPointType</tt>.
*
* @param typeStr the <tt>String</tt> that we'd like to
* parse.
* @return an EndPointType.
*
* @throws IllegalArgumentException in case <tt>typeStr</tt> is
* not a valid <tt>EndPointType</tt>.
*/
public static EndpointStatusType parseString(String typeStr)
throws IllegalArgumentException
{
for (EndpointStatusType value : values())
if (value.toString().equals(typeStr))
return value;
throw new IllegalArgumentException(
typeStr + " is not a valid reason");
}
}
}
Write Preview
Loading…
Cancel
Save