uk.org.retep.xmpp.XMPPService Maven / Gradle / Ivy
/*
* Copyright (c) 1998-2009, Peter T Mount
* All rights reserved.
*
*
* 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 3 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, see
*
*
* GNU GENERAL PUBLIC LICENSE - CLASSPATH EXCEPTION
*
*
*
* Linking this library statically or dynamically with other modules
* is making a combined work based on this library. Thus, the terms
* and conditions of the GNU General Public License cover the whole
* combination.
*
*
*
* As a special exception, the copyright holders of this library give
* you permission to link this library with independent modules to
* produce an executable, regardless of the license terms of these
* independent modules, and to copy and distribute the resulting
* executable under terms of your choice, provided that you also meet,
* for each linked independent module, the terms and conditions of the
* license of that module.
*
*
*
* An independent module is a module which is either not derived from or based
* on this library, or a module who's classes extend those within this library
* as part of the implementation of the library.
*
*
*
* If you modify this library, you may extend this exception to your version
* of the library, but you are not obligated to do so. If you do not wish to
* do so, delete this exception statement from your version.
*
*/
package uk.org.retep.xmpp;
import javax.xml.bind.JAXBException;
import org.w3c.dom.Node;
import uk.org.retep.util.messaging.MessageException;
import uk.org.retep.xmpp.message.BaseXMPPMessage;
import uk.org.retep.xmpp.jaxb.XMPPUnmarshaller;
/**
*
* @param Type of context
* @author peter
*/
public interface XMPPService
{
/**
* Send a Message. Once it has been submitted, the Message object must not
* be changed in any way. Ownership of that object passes to the MessagingSystem.
* @param Type of message, subclass of {@link BaseXMPPMessage}
* @param message Message to submit
* @throws uk.org.retep.util.messaging.MessageException
*/
void send( final M message )
throws MessageException;
/**
* Marshall a BaseXMPPMessage into a DOM Node
*
* @param obj
* @return
* @throws JAXBException
*/
Node marshall( final BaseXMPPMessage obj )
throws JAXBException;
/**
* Marshall a BaseXMPPMessage into a String. This method is useful for
* debugging purposes.
*
* @param obj
* @return
* @throws JAXBException
*/
String marshallXml( final BaseXMPPMessage obj )
throws JAXBException;
/**
* Convenience method to unmarshall a {@link Node}.
*
* This is the same as {@linkplain XMPPUnmarshaller XMPPUnmarshaller}.getInstance().{@linkplain XMPPUnmarshaller#unmarshall(org.w3c.dom.Node) unmarshall}();
* @param node
* @return
* @throws JAXBException
*/
BaseXMPPMessage unmarshall( final Node node )
throws JAXBException;
/**
* Returns some context for this server
* @return Context
*/
T getContext();
}