com.mobius.software.telco.protocols.diameter.commands.s9.TriggerEstablishmentRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of diameter-api Show documentation
There is a newer version: 10.0.0-17-java11
package com.mobius.software.telco.protocols.diameter.commands.s9;
/*
 * 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.InetAddress;

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.commands.commons.AuthenticationRequest;
import com.mobius.software.telco.protocols.diameter.exceptions.MissingAvpException;
import com.mobius.software.telco.protocols.diameter.primitives.common.AuthSessionStateEnum;
import com.mobius.software.telco.protocols.diameter.primitives.creditcontrol.SubscriptionId;
import com.mobius.software.telco.protocols.diameter.primitives.rfc7683.OCSupportedFeatures;
import com.mobius.software.telco.protocols.diameter.primitives.rfc7944.DRMPEnum;
import com.mobius.software.telco.protocols.diameter.primitives.s9.DRABindingEnum;

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

/*
 * 	5.5.7	Trigger-Establishment-Request (TER) Command
	The TER command, indicated by the Command-Code field set to 8388656 and the 'R' bit set in the Command Flags field, is sent by the H-PCRF to the V-PCRF in order to trigger the S9 Session Establishment. It is also sent by the H-PCRF to the V-DRA in order to remove the DRA binding information created during the S9 Session Establishment Trigger procedure.
	Message Format:

	 ::= < Diameter Header: 8388656, REQ, PXY >
				 < Session-Id >
				 [ DRMP ]
				 { Auth-Application-Id }
				 { Origin-Host }
				 { Origin-Realm }
				 { Destination-Realm }
				 { Destination-Host }
				 [ Auth-Session-State ]
				 [ Origin-State-Id ]
				 [ Subscription-Id ]
				 [ OC-Supported-Features ]
				 [ Called-Station-Id ]
				 [ UE-Local-IP-Address ]
				 [ HeNB-Local-IP-Address ]
				 [ DRA-Binding ]
				 [ UDP-Source-Port ] 
				*[ Proxy-Info ]
				*[ Route-Record ]
				*[ AVP ]
 */
@DiameterCommandDefinition(applicationId = ApplicationIDs.S9, commandCode = CommandCodes.TRIGGER_ESTABLIHMENT, request = true, proxyable = true, name="Trigger-Establishment-Request")
public interface TriggerEstablishmentRequest extends AuthenticationRequest
{
	DRMPEnum getDRMP();
	
	void setDRMP(DRMPEnum value);
	
	public AuthSessionStateEnum getAuthSessionState();
	
	void setAuthSessionState(AuthSessionStateEnum value) throws MissingAvpException;

	public SubscriptionId getSubscriptionId();
	
	void setSubscriptionId(SubscriptionId value);

	OCSupportedFeatures getOCSupportedFeatures();
	
	void setOCSupportedFeatures(OCSupportedFeatures value);
	
	String getCalledStationId();
	
	void setCalledStationId(String value);	
	
	InetAddress getUELocalIPAddress();
	
	void setUELocalIPAddress(InetAddress value);	
	
	InetAddress getHeNBLocalIPAddress();
	
	void setHeNBLocalIPAddress(InetAddress value);	
	
	DRABindingEnum getDRABinding();
	
	void setDRABinding(DRABindingEnum value);
	
	Long getUDPSourcePort();
	
	void setUDPSourcePort(Long value);	
}