com.mobius.software.telco.protocols.diameter.primitives.s6a.SubscriptionDataFlags Maven / Gradle / Ivy

Go to download
package com.mobius.software.telco.protocols.diameter.primitives.s6a;
/*
 * 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 com.mobius.software.telco.protocols.diameter.TgppAvpCodes;
import com.mobius.software.telco.protocols.diameter.VendorIDs;
import com.mobius.software.telco.protocols.diameter.annotations.DiameterAvpDefinition;
import com.mobius.software.telco.protocols.diameter.primitives.DiameterBitmask32;

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

/*
	7.3.165	Subscription-Data-Flags
	The Subscription-Data-Flags is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in 
	Table 7.3.165/1: Subscription-Data-Flags

	Bit Name
	Description

	0 PS-And-SMS-Only-Service-Provision-Indication
	This bit, when set, indicates that the subscription is for PS Only and permits CS service access only for SMS.

	1 SMS-In-SGSN-Allowed-Indication
	This bit, when set, indicates that SMS in SGSN for the user is allowed.

	2 User Plane Integrity Protection
	This bit, when set, indicates that the SGSN may decide to activate integrity protection of the user plane when GERAN is used (see 3GPP TS 43.020 [58]). The MME shall ignore it.

	3 PDN-Connection-Restricted
	This bit, when set, indicates to the MME that it shall not establish any non-emergency PDN connection for this user if the MME and the UE supports Attach without PDN connection. The SGSN shall ignore it.

	4 Acknowledgement-Of-Downlink-NAS-Data PDUs disabled
	This bit, when set, indicates to the MME that acknowledgement of downlink NAS data PDUs for Control Plane CIoT Optimization is disabled for this UE (even for APN configurations with RDS Indicator set to ENABLED (1)). When not set it indicated to the MME that acknowledgement of downlink NAS data PDUs for Control Plane CIoT Optimization is enabled (for APN configurations with RDS Indicator set to ENABLED (1)) for this UE, which is the default (see 3GPP TS 23.401 [2]).
	The SGSN shall ignore it.

	NOTE:	Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command.
 */
@DiameterAvpDefinition(code = TgppAvpCodes.SUBSCRIPTION_DATA_FLAGS, vendorId = VendorIDs.TGPP_ID, must = false, name = "Subscription-Data-Flags")
public interface SubscriptionDataFlags extends DiameterBitmask32
{
	public static final int PS_AND_SMS_ONLY_SERVICE_PROVISION_INDICATION_BIT = 0;
	public static final int SMS_IN_SGSN_ALLOWED_INDICATION_BIT = 1;
	public static final int USER_PLANE_INTEGRITY_PROTECTION_BIT = 2;
	public static final int PDN_CONNECTION_RESTRICTED_BIT = 3;
	public static final int ACKNOWLEDGEMENT_OF_DOWNLINK_NAS_DATA_PDUS_DISABLED_BIT = 4;
	
	public void setPSAndSMSOnlyServiceProvisionIndicationBit(boolean isOn);
	
	public boolean isPSAndSMSOnlyServiceProvisionIndicationBitSet();
	
	public void setSMSInSGSNAllowedIndicationBit(boolean isOn);
	
	public boolean isSMSInSGSNAllowedIndicationBitSet();
	
	public void setUserPlaneIntegrityIndicationBit(boolean isOn);
	
	public boolean isUserPlaneIntegrityIndicationBitSet();
	
	public void setPDNConnectionRestrictedBit(boolean isOn);
	
	public boolean isPDNConnectionRestrictedBitSet();
	
	public void setAcknowledgmentOfDownlinkNASDataPDUSDisabledBit(boolean isOn);
	
	public boolean isAcknowledgmentOfDownlinkNASDataPDUSDisabledBitSet();
}