org.jdiameter.client.api.annotation.IRecoder Maven / Gradle / Ivy
/*
* TeleStax, Open Source Cloud Communications
* Copyright 2011-2016, TeleStax Inc. and individual contributors
* by the @authors tag.
*
* This program is free software: you can redistribute it and/or modify
* under the terms of the GNU Affero 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* JBoss, Home of Professional Open Source
* Copyright 2007-2011, Red Hat, Inc. and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jdiameter.client.api.annotation;
import org.jdiameter.api.Avp;
import org.jdiameter.api.Message;
import org.jdiameter.api.Request;
/**
* This interface provide methods for create diameter messages from your annotated domain object and create domain
* object from diameter message.
*
* @author [email protected]
* @author Alexandre Mendonca
* @author Bartosz Baranowski
*/
@SuppressWarnings("all") //3rd party lib
public interface IRecoder {
/**
* Create Request message from specified annotated domain object
*
* @param yourDomainMessageObject annotated domain object
* @param additionalAvp additional avp
*
* @return message instance
*
* @throws RecoderException throw if object can not be encoded to diameter message
*/
Message encodeToRequest(Object yourDomainMessageObject, Avp... additionalAvp) throws RecoderException;
/**
* Create Answer message from specified annotated domain object
*
* @param yourDomainMessageObject annotated domain object
* @param request request message
* @param resultCode result code of answer
*
* @return message answer instance
*
* @throws RecoderException throw if object can not be encoded to diameter message
*/
Message encodeToAnswer(Object yourDomainMessageObject, Request request, long resultCode) throws RecoderException;
/**
* Create specified domain object by message and class of object
*
* @param message diameter message
* @param yourDomainMessageObject class of domain object
*
* @return instance of domain object
*
* @throws RecoderException throw if message can not be decoded to domain object
*/
T decode(Message message, java.lang.Class yourDomainMessageObject) throws RecoderException;
}