net.java.slee.resource.diameter.cxdx.events.RegistrationTerminationAnswer Maven / Gradle / Ivy
The newest version!
/*
* JBoss, Home of Professional Open Source
* Copyright 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 net.java.slee.resource.diameter.cxdx.events;
import net.java.slee.resource.diameter.base.events.DiameterMessage;
import net.java.slee.resource.diameter.base.events.avp.AuthSessionStateType;
import net.java.slee.resource.diameter.base.events.avp.DiameterIdentity;
import net.java.slee.resource.diameter.base.events.avp.ExperimentalResultAvp;
import net.java.slee.resource.diameter.base.events.avp.FailedAvp;
import net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp;
import net.java.slee.resource.diameter.base.events.avp.VendorSpecificApplicationIdAvp;
import net.java.slee.resource.diameter.cxdx.events.avp.AssociatedIdentities;
import net.java.slee.resource.diameter.cxdx.events.avp.IdentitywithEmergencyRegistration;
import net.java.slee.resource.diameter.cxdx.events.avp.SupportedFeaturesAvp;
/**
*
* 3GPP TS 29.229 version 12.7.0 Release 12
*
* 6.1.10 Registration-Termination-Answer (RTA) Command
*
* The Registration-Termination-Answer (RTA) command, indicated by the Command-Code field set to
* 304 and the 'R' bit cleared in the Command Flags field, is sent by a client in response to the
* Registration-Termination-Request command. The Experimental-Result AVP may contain one of the
* values defined in section 6.2.
*
* Message Format
* ::= < Diameter Header: 304, PXY, 16777216 >
* < Session-Id >
* { Vendor-Specific-Application-Id }
* [ Result-Code ]
* [ Experimental-Result ]
* { Auth-Session-State }
* { Origin-Host }
* { Origin-Realm }
* [ Associated-Identities ]
* *[ Supported-Features ]
* [ Identity-with-Emergency-Registration ] //R12
* *[ AVP ]
* *[ Failed-AVP ]
* *[ Proxy-Info ]
* *[ Route-Record ]
*
*
*
* @author Alexandre Mendonca
* @author Bartosz Baranowski
*/
public interface RegistrationTerminationAnswer extends DiameterMessage {
public static final int COMMAND_CODE = 304;
/**
* Returns true if the Vendor-Specific-Application-Id AVP is present in the
* message.
*/
boolean hasVendorSpecificApplicationId();
/**
* Returns the value of the Vendor-Specific-Application-Id AVP, of type
* Grouped.
*
* @return the value of the Vendor-Specific-Application-Id AVP or null if it
* has not been set on this message
*/
VendorSpecificApplicationIdAvp getVendorSpecificApplicationId();
/**
* Sets the value of the Vendor-Specific-Application-Id AVP, of type
* Grouped.
*
* @throws IllegalStateException if setVendorSpecificApplicationId has already been called
*/
void setVendorSpecificApplicationId(VendorSpecificApplicationIdAvp vendorSpecificApplicationId);
/**
* Returns true if the Result-Code AVP is present in the message.
*
* @return
*/
boolean hasResultCode();
/**
* Returns the value of the Result-Code AVP, of type Unsigned32.
*
* @return
*/
long getResultCode();
/**
* Sets the value of the Result-Code AVP, of type Unsigned32.
*
* @param resultCode
* @throws IllegalStateException
*/
void setResultCode(long resultCode) throws IllegalStateException;
/**
* Returns true if the Experimental-Result AVP is present in the message.
*/
boolean hasExperimentalResult();
/**
* Returns the value of the Experimental-Result AVP, of type Grouped.
*
* @return the value of the Experimental-Result AVP or null if it has not
* been set on this message
*/
ExperimentalResultAvp getExperimentalResult();
/**
* Sets the value of the Experimental-Result AVP, of type Grouped.
*
* @throws IllegalStateException if setExperimentalResult has already been called
*/
void setExperimentalResult(ExperimentalResultAvp experimentalResult);
/**
* Returns true if the Auth-Session-State AVP is present in the message.
*/
boolean hasAuthSessionState();
/**
* Returns the value of the Auth-Session-State AVP, of type Enumerated. A
* return value of null implies that the AVP has not been set.
*/
AuthSessionStateType getAuthSessionState();
/**
* Sets the value of the Auth-Session-State AVP, of type Enumerated.
*
* @throws IllegalStateException if setAuthSessionState has already been called
*/
void setAuthSessionState(AuthSessionStateType authSessionState);
/**
* Returns true if the Associated-Identities AVP is present in the message.
*/
boolean hasAssociatedIdentities();
/**
* Returns the value of the Associated-Identities AVP, of type Grouped.
*
* @return the value of the Associated-Identities AVP or null if it has not been set on this message
*/
AssociatedIdentities getAssociatedIdentities();
/**
* Sets the value of the Associated-Identities AVP, of type Grouped.
*
* @throws IllegalStateException if setAssociatedIdentities has already been called
*/
void setAssociatedIdentities(AssociatedIdentities associatedIdentities);
/**
* Returns the set of Supported-Features AVPs. The returned array contains
* the AVPs in the order they appear in the message. A return value of null
* implies that no Supported-Features AVPs have been set. The elements in
* the given array are SupportedFeatures objects.
*/
SupportedFeaturesAvp[] getSupportedFeatureses();
/**
* Sets a single Supported-Features AVP in the message, of type Grouped.
*
* @throws IllegalStateException if setSupportedFeatures or setSupportedFeatureses has already
* been called
*/
void setSupportedFeatures(SupportedFeaturesAvp supportedFeatures);
/**
* Sets the set of Supported-Features AVPs, with all the values in the given
* array. The AVPs will be added to message in the order in which they
* appear in the array.
*
* Note: the array must not be altered by the caller following this call,
* and getSupportedFeatureses() is not guaranteed to return the same array
* instance, e.g. an "==" check would fail.
*
* @throws IllegalStateException if setSupportedFeatures or setSupportedFeatureses has already
* been called
*/
void setSupportedFeatureses(SupportedFeaturesAvp[] supportedFeatureses);
/**
* Returns the set of Failed-AVP AVPs. The returned array contains the AVPs
* in the order they appear in the message. A return value of null implies
* that no Failed-AVP AVPs have been set. The elements in the given array
* are FailedAvp objects.
*/
FailedAvp[] getFailedAvps();
/**
* Sets a single Failed-AVP AVP in the message, of type Grouped.
*
* @throws IllegalStateException if setFailedAvp or setFailedAvps has already been called
*/
void setFailedAvp(FailedAvp failedAvp);
/**
* Sets the set of Failed-AVP AVPs, with all the values in the given array.
* The AVPs will be added to message in the order in which they appear in
* the array.
*
* Note: the array must not be altered by the caller following this call,
* and getFailedAvps() is not guaranteed to return the same array instance,
* e.g. an "==" check would fail.
*
* @throws IllegalStateException if setFailedAvp or setFailedAvps has already been called
*/
void setFailedAvps(FailedAvp[] failedAvps);
/**
* Returns the set of Proxy-Info AVPs. The returned array contains
* the AVPs in the order they appear in the message.
* A return value of null implies that no Proxy-Info AVPs have been set.
* The elements in the given array are ProxyInfo objects.
*/
ProxyInfoAvp[] getProxyInfos();
/**
* Sets a single Proxy-Info AVP in the message, of type Grouped.
*
* @throws IllegalStateException if setProxyInfo or setProxyInfos
* has already been called
*/
void setProxyInfo(ProxyInfoAvp proxyInfo);
/**
* Sets the set of Proxy-Info AVPs, with all the values in the given array.
* The AVPs will be added to message in the order in which they appear in the array.
*
* Note: the array must not be altered by the caller following this call, and
* getProxyInfos() is not guaranteed to return the same array instance,
* e.g. an "==" check would fail.
*
* @throws IllegalStateException if setProxyInfo or setProxyInfos
* has already been called
*/
void setProxyInfos(ProxyInfoAvp[] proxyInfos);
/**
* Returns the set of Route-Record AVPs. The returned array contains
* the AVPs in the order they appear in the message.
* A return value of null implies that no Route-Record AVPs have been set.
* The elements in the given array are DiameterIdentity objects.
*/
DiameterIdentity[] getRouteRecords();
/**
* Sets a single Route-Record AVP in the message, of type DiameterIdentity.
*
* @throws IllegalStateException if setRouteRecord or setRouteRecords
* has already been called
*/
void setRouteRecord(DiameterIdentity routeRecord);
/**
* Sets the set of Route-Record AVPs, with all the values in the given array.
* The AVPs will be added to message in the order in which they appear in the array.
*
* Note: the array must not be altered by the caller following this call, and
* getRouteRecords() is not guaranteed to return the same array instance,
* e.g. an "==" check would fail.
*
* @throws IllegalStateException if setRouteRecord or setRouteRecords
* has already been called
*/
void setRouteRecords(DiameterIdentity[] routeRecords);
/**
* Returns true if the Identity-with-Emergency-Registration AVP is present in the message.
*/
public boolean hasIdentitywithEmergencyRegistration();
/**
* Returns the value of the Identity-with-Emergency-Registration AVP, of type Enumerated. A
* return value of null implies that the AVP has not been set.
*/
public IdentitywithEmergencyRegistration getIdentitywithEmergencyRegistration();
/**
* Sets the Identity-with-Emergency-Registration AVP
*
* @param identityWithEmergencyRegistration
*/
public void setIdentitywithEmergencyRegistration(IdentitywithEmergencyRegistration identityWithEmergencyRegistration);
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy