com.mobius.software.telco.protocols.diameter.commands.sgmb.ReAuthAnswer Maven / Gradle / Ivy

Go to download
package com.mobius.software.telco.protocols.diameter.commands.sgmb;
/*
 * Mobius Software LTD
 * Copyright 2023, Mobius Software LTD 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 
 */

import java.net.Inet4Address;
import java.net.Inet6Address;
import java.util.List;

import com.mobius.software.telco.protocols.diameter.ApplicationIDs;
import com.mobius.software.telco.protocols.diameter.CommandCodes;
import com.mobius.software.telco.protocols.diameter.annotations.DiameterCommandDefinition;
import com.mobius.software.telco.protocols.diameter.primitives.cxdx.SupportedFeatures;
import com.mobius.software.telco.protocols.diameter.primitives.gmb.MBMSStartStopIndicationEnum;
import com.mobius.software.telco.protocols.diameter.primitives.gmb.MBMSUserDataModeIndicationEnum;

import io.netty.buffer.ByteBuf;

/**
*
* @author yulian oifa
*
*/

/*	20.4.2	RE-Auth-Answer Command
	The Re-Auth-Answer (RAA) command, defined in IETF RFC 6733 (DIAMETER BASE) [111], is indicated by the Command-Code set to 258 and the message flags’ ‘R’ bit clear, is sent in response to the RAR. 
	The relevant AVPs that are of use for the SGmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for SGmb purposes and should be ignored by the receiver or processed according to the relevant specifications.
	The bold marked AVPs in the message format indicate new optional AVPs for SGmb, or modified existing AVPs.
	Message Format:
      
      ::= < Diameter Header: 258, PXY >
                 	< Session-Id >
                 	{ Origin-Host }
                 	{ Origin-Realm }
                 	[ Result-Code ]
                 	[ Experimental-Result ]
                 	[ MBMS-StartStop-Indication ]
                 	[ MBMS-GGSN-Address ]             ; for unicast encapsulated user data
                 	[ MBMS-GGSN-Ipv6-Address ]        ; for unicast encapsulated user data
                 	[ MBMS-User-Data-Mode-Indication ]
                 	[ MBMS-GW-UDP-Port]               ; for unicast encapsulated user data
                 	[ Origin-State-Id ]
                 	[ Error-Message ]
                 	[ Error-Reporting-Host ]
                  	[ Failed-AVP ]
                 *	[ Redirected-Host ]
                 	[ Redirected-Host-Usage ]
                 	[ Redirected-Host-Cache-Time ]
                 	[ Proxy-Info ]
                 *	[ Supported-Features ]
                 	[ Restart-Counter ]

	For the MBMS Heartbeat procedure, RAA is sent by the BM-SC to the MBMS GW, or vice-versa. The RAA message shall contain the following AVPs: 
		-	the MBMS-StartStop-Indication AVP set to the value "heartbeat";
		-	the Restart-Counter AVP set to the local restart counter of the sender. 
 */
@DiameterCommandDefinition(applicationId = ApplicationIDs.SGMB, commandCode = CommandCodes.REAUTH, request = false, proxyable = true, name="Re-Auth-Answer")
public interface ReAuthAnswer extends com.mobius.software.telco.protocols.diameter.commands.commons.ReAuthAnswer
{
	MBMSStartStopIndicationEnum getMBMSStartStopIndication();
	
	void setMBMSStartStopIndication(MBMSStartStopIndicationEnum value);
	
	Inet4Address getMBMSGGSNAddress();	
	
	void setMBMSGGSNAddress(Inet4Address value);
	
	Inet6Address getMBMSGGSNIPv6Address();	
	
	void setMBMSGGSNIPv6Address(Inet6Address value);
	
	MBMSUserDataModeIndicationEnum getMBMSUserDataModeIndication();	
	
	void setMBMSUserDataModeIndication(MBMSUserDataModeIndicationEnum value);
	
	ByteBuf getMBMSGWUDPPort();	
	
	void setMBMSGWUDPPort(ByteBuf value);
	
	List getSupportedFeatures();
	
	void setSupportedFeatures(List value);
	
	Long getRestartCounter();
	
	void setRestartCounter(Long value);		
}