com.mobius.software.telco.protocols.diameter.primitives.mb2c.TMGIAllocationResult 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.primitives.mb2c;
/*
 * 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
*
*/

/*
	6.4.13	TMGI‑Allocation‑Result AVP
	The TMGI‑Allocation‑Result AVP (AVP code 3511) is of type Unsigned32 and it shall contain a bit mask with values as defined table 6.4.13-1. Several bits indicating errors may be set in combination.
	Table 6.4.13-1: TMGI‑Allocation‑Result AVP

	Bit Name
	Description

	0 Success
	The requested TMGI allocation was successful.

	1 Authorization rejected
	The requested TMGI allocation failed because the BM‑SC did not authorize it.

	2 Resources exceeded
	The requested TMGI allocation failed because the BM‑SC could not provide sufficient resources.

	3 Unknown TMGI
	The requested TMGI timer refresh failed because the BM‑SC did not know the requested TMGI, e.g. because the TMGI already expired.

	4 Too many TMGIs requested
	The requested TMGI allocation or timer refresh failed because the maximum number of allowed TMGIs for the GCS AS was exceeded.

	5 System error
	The requested TMGI allocation failed due to internal system error in the BM-SC.
 */
@DiameterAvpDefinition(code = TgppAvpCodes.TMGI_ALLOCATION_RESULT, vendorId = VendorIDs.TGPP_ID, name = "TMGI‑Allocation‑Result")
public interface TMGIAllocationResult extends DiameterBitmask32
{
	public static final int SUCCESS_BIT = 0;
	public static final int AUTHORIZATION_REJECTED_BIT = 1;
	public static final int RESOURCED_EXCEEDED_BIT = 2;
	public static final int UNKNOWN_TMGI_BIT = 3;
	public static final int TOO_MANY_TMGIS_REQUESTED_BIT = 4;
	public static final int SYSTEM_ERROR_BIT = 5;
	
	public void setSuccessBit(boolean isOn);
	
	public boolean isSuccessBitSet();
	
	public void setAuthorizationRejectBit(boolean isOn);
	
	public boolean isAuthorizationRejectBitSet();
	
	public void setResourcesExceededBit(boolean isOn);
	
	public boolean isResourcesExceededBitSet();
	
	public void setUnknownTMGIBit(boolean isOn);
	
	public boolean isUnknownTMGIBitSet();
	
	public void setTooManyTMGIsRequestedBit(boolean isOn);
	
	public boolean isTooManyTMGIsRequestedBitSet();
	
	public void setSystemErrorBit(boolean isOn);
	
	public boolean isSystemErrorBitSet();
}