net.java.slee.resource.diameter.cxdx.events.PushProfileRequest 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.ProxyInfoAvp;
import net.java.slee.resource.diameter.base.events.avp.VendorSpecificApplicationIdAvp;
import net.java.slee.resource.diameter.cxdx.events.avp.ChargingInformation;
import net.java.slee.resource.diameter.cxdx.events.avp.SIPAuthDataItem;
import net.java.slee.resource.diameter.cxdx.events.avp.SupportedFeaturesAvp;
/**
*
* 3GPP TS 29.229 version 12.7.0 Release 12
*
* 6.1.11 Push-Profile-Request (PPR) Command
*
* The Push-Profile-Request (PPR) command, indicated by the Command-Code field set to 305 and the
* 'R' bit set in the Command Flags field, is sent by a Diameter Multimedia server to a Diameter
* Multimedia client in order to update the subscription data and for SIP Digest authentication
* the authentication data of a multimedia user in the Diameter Multimedia client whenever a
* modification has occurred in the subscription data or digest password that constitutes the data
* used by the client.
*
* Message Format
* < Push-Profile-Request > ::= < Diameter Header: 305, REQ, PXY, 16777216 >
* < Session-Id >
* { Vendor-Specific-Application-Id }
* { Auth-Session-State }
* { Origin-Host }
* { Origin-Realm }
* { Destination-Host }
* { Destination-Realm }
* { User-Name }
* *[ Supported-Features ]
* [ User-Data ]
* [ Charging-Information ]
* [ SIP-Auth-Data-Item ]
* *[ AVP ]
* *[ Proxy-Info ]
* *[ Route-Record ]
*
*
*
* @author Alexandre Mendonca
* @author Bartosz Baranowski
*/
public interface PushProfileRequest extends DiameterMessage {
public static final int COMMAND_CODE = 305;
/**
* 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 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 User-Name AVP is present in the message.
*/
boolean hasUserName();
/**
* Returns the value of the User-Name AVP, of type UTF8String.
*
* @return the value of the User-Name AVP or null if it has not been set on this message
*/
String getUserName();
/**
* Sets the value of the User-Name AVP, of type UTF8String.
*
* @throws IllegalStateException if setUserName has already been called
*/
void setUserName(String userName);
/**
* 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 true if the User-Data AVP is present in the message.
*/
boolean hasUserData();
/**
* Returns the value of the User-Data AVP, of type OctetString.
*
* @return the value of the User-Data AVP or null if it has not been set on this message
*/
byte[] getUserData();
/**
* Sets the value of the User-Data AVP, of type OctetString.
*
* @throws IllegalStateException if setUserData has already been called
*/
void setUserData(byte[] userData);
/**
* Returns true if the Charging-Information AVP is present in the message.
*/
boolean hasChargingInformation();
/**
* Returns the value of the Charging-Information AVP, of type Grouped.
*
* @return the value of the Charging-Information AVP or null if it has not been set on this message
*/
ChargingInformation getChargingInformation();
/**
* Sets the value of the Charging-Information AVP, of type Grouped.
*
* @throws IllegalStateException if setChargingInformation has already been called
*/
void setChargingInformation(ChargingInformation chargingInformation);
/**
* Returns true if the SIP-Auth-Data-Item AVP is present in the message.
*/
boolean hasSIPAuthDataItem();
/**
* Returns the value of the SIP-Auth-Data-Item AVP, of type Grouped.
* A return value of null implies that the AVP has not been set.
*/
SIPAuthDataItem getSIPAuthDataItem();
/**
* Sets the value of the SIP-Auth-Data-Item AVP, of type Grouped.
*
* @throws IllegalStateException if setSIPAuthDataItem has already been called
*/
void setSIPAuthDataItem(SIPAuthDataItem sipAuthDataItem);
/**
* 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);
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy