All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.java.slee.resource.diameter.sh.events.SubscribeNotificationsRequest Maven / Gradle / Ivy

There is a newer version: 7.1.26
Show 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.sh.events;

import java.util.Date;

import net.java.slee.resource.diameter.sh.events.avp.DataReferenceType;
import net.java.slee.resource.diameter.sh.events.avp.SendDataIndicationType;
import net.java.slee.resource.diameter.sh.events.avp.SubsReqType;
import net.java.slee.resource.diameter.sh.events.avp.OneTimeNotificationType;
import net.java.slee.resource.diameter.sh.events.avp.IdentitySetType;
import net.java.slee.resource.diameter.sh.events.avp.UserIdentityAvp;

/**
 * Defines an interface representing the Subscribe-Notifications-Request
 * command.
 * 
 * From the Diameter Sh Reference Point Protocol Details (3GPP TS 29.329 V9.2.0)
 * specification:
 * 
 * 
 * 6.1.5        Subscribe-Notifications-Request (SNR) Command
 * 
 * The Subscribe-Notifications-Request (SNR) command, indicated by the
 * Command-Code field set to 308 and the 'R' bit set in the Command Flags field,
 * is sent by a Diameter client to a Diameter server in order to request
 * notifications of changes in user data.
 * 
 * 
 * Message Format
 * < Subscribe-Notifications-Request > ::= < Diameter Header: 308, REQ, PXY, 16777217 >
 *                                         < Session-Id >
 *                                         { Vendor-Specific-Application-Id }
 *                                         { Auth-Session-State }
 *                                         { Origin-Host }
 *                                         { Origin-Realm }
 *                                         [ Destination-Host ]
 *                                         { Destination-Realm }
 *                                         *[ Supported-Features ]
 *                                         { User-Identity }
 *                                         [ Wildcarded-PSI ]
 *                                         [ Wildcarded-IMPU ]
 *                                         *[ Service-Indication ]
 *                                         [ Send-Data-Indication ]
 *                                         [ Server-Name ]
 *                                         { Subs-Req-Type }
 *                                         *{ Data-Reference }
 *                                         *[ Identity-Set ]
 *                                         [ Expiry-Time ]                                         
 *                                         *[ DSAI-Tag ]
 *                                         [ One-Time-Notification ]
 *                                         *[ AVP ]
 *                                         *[ Proxy-Info ]
 *                                         *[ Route-Record ]
 * 
* * @author Alexandre Mendonca * @author Bartosz Baranowski */ public interface SubscribeNotificationsRequest extends DiameterShMessage { static final int commandCode = 308; /** * Returns true if the User-Identity AVP is present in the message. */ boolean hasUserIdentity(); /** * Returns the value of the User-Identity AVP, of type Grouped. * * @return the value of the User-Identity AVP or null if it has not been set * on this message */ UserIdentityAvp getUserIdentity(); /** * Sets the value of the User-Identity AVP, of type Grouped. * * @throws IllegalStateException * if setUserIdentity has already been called */ void setUserIdentity(UserIdentityAvp userIdentity); /** * Returns the set of Service-Indication AVPs. The returned array contains * the AVPs in the order they appear in the message. A return value of null * implies that no Service-Indication AVPs have been set. */ byte[][] getServiceIndications(); /** * Sets a single Service-Indication AVP in the message, of type OctetString. * * @throws IllegalStateException * if setServiceIndication or setServiceIndications has already * been called */ void setServiceIndication(byte[] serviceIndication); /** * Sets the set of Service-Indication 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 getServiceIndications() is not guaranteed to return the same array * instance, e.g. an "==" check would fail. * * @throws IllegalStateException * if setServiceIndication or setServiceIndications has already * been called */ void setServiceIndications(byte[][] serviceIndications); /** * Returns true if the Server-Name AVP is present in the message. */ boolean hasServerName(); /** * Returns the value of the Server-Name AVP, of type UTF8String. * * @return the value of the Server-Name AVP or null if it has not been set * on this message */ String getServerName(); /** * Sets the value of the Server-Name AVP, of type UTF8String. * * @throws IllegalStateException * if setServerName has already been called */ void setServerName(String serverName); /** * Returns true if the Subs-Req-Type AVP is present in the message. */ boolean hasSubsReqType(); /** * Returns the value of the Subs-Req-Type AVP, of type Enumerated. * * @return the value of the Subs-Req-Type AVP or null if it has not been set * on this message */ SubsReqType getSubsReqType(); /** * Sets the value of the Subs-Req-Type AVP, of type Enumerated. * * @throws IllegalStateException * if setSubsReqType has already been called */ void setSubsReqType(SubsReqType subsReqType); /** * Returns the set of Data-Reference AVPs. The returned array contains the * AVPs in the order they appear in the message. A return value of null * implies that no Data-Reference AVPs have been set. The elements in the * given array are DataReference objects. */ DataReferenceType[] getDataReferences(); /** * Sets a single Data-Reference AVP in the message, of type Enumerated. * * @throws IllegalStateException * if setDataReference or setDataReferences has already been * called */ void setDataReference(DataReferenceType dataReference); /** * Sets the set of Data-Reference 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 getDataReferences() is not guaranteed to return the same array * instance, e.g. an "==" check would fail. * * @throws IllegalStateException * if setDataReference or setDataReferences has already been * called */ void setDataReferences(DataReferenceType[] dataReferences); /** * Returns true if the Expiry-Time AVP is present in the message. */ boolean hasExpiryTime(); /** * Returns the value of the Expiry-Time AVP, of type Time. * * @return the value of the Expiry-Time AVP or null if it has not been set * on this message */ Date getExpiryTime(); /** * Sets the value of the Expiry-Time AVP, of type Time. * * @throws IllegalStateException * if setExpiryTime has already been called */ void setExpiryTime(Date expiryTime); /** * Returns true if the Send-Data-Indication AVP is present in the message. */ boolean hasSendDataIndication(); /** * Returns the value of the Send-Data-Indication AVP, of type Enumerated. * * @return the value of the Send-Data-Indication AVP or null if it has not * been set on this message */ SendDataIndicationType getSendDataIndication(); /** * Sets the value of the Send-Data-Indication AVP, of type Enumerated. * * @throws IllegalStateException * if setSendDataIndication has already been called */ void setSendDataIndication(SendDataIndicationType sendDataIndication); /** * Returns true if the Wildcarded-PSI AVP is present in the message. */ boolean hasWildcardedPSI(); /** * Returns the value of the Wildcarded-PSI AVP, of type UTF8String. Use * {@link #hasWildcardedPSI()} to check the existence of this AVP. * * @return the value of the Wildcarded-PSI AVP * @throws IllegalStateException * if the Wildcarded-PSI AVP has not been set on this message */ String getWildcardedPSI(); /** * Sets the value of the Wildcarded-PSI AVP, of type UTF8String. * * @throws IllegalStateException * if setWildcardedPSI has already been called */ void setWildcardedPSI(String wildcardedPSI); /** * Returns true if the Wildcarded-IMPU AVP is present in the message. */ boolean hasWildcardedIMPU(); /** * Returns the value of the Wildcarded-IMPU AVP, of type UTF8String. Use * {@link #hasWildcardedIMPU()} to check the existence of this AVP. * * @return the value of the Wildcarded-IMPU AVP * @throws IllegalStateException * if the Wildcarded-IMPU AVP has not been set on this message */ String getWildcardedIMPU(); /** * Sets the value of the Wildcarded-IMPU AVP, of type UTF8String. * * @throws IllegalStateException * if setWildcardedIMPU has already been called */ void setWildcardedIMPU(String WildcardedIMPU); /** * Returns the value of the DSAI-Tag AVP, of type OctetString. * * @return the value of the DSAI-Tag AVP or null if it has not been set * on this message */ byte[][] getDSAITags(); /** * Sets the value of the DSAI-Tag AVP, of type OctetString. * * @throws IllegalStateException * if setDSAITag has already been called */ void setDSAITag(byte[] dsaiTag); /** * Sets the value of the DSAI-Tag AVP, of type OctetString. * * @throws IllegalStateException * if setDSAITag has already been called */ void setDSAITags(byte[][] dsaiTag); /** * Returns the value of the Identity-Set AVP, of type Enumerated. * * @return the value of the Identity-Set AVP or null if it has not been set * on this message */ IdentitySetType[] getIdentitySets(); /** * Sets the value of the Identity-Set AVP, of type Enumerated. * * @throws IllegalStateException * if setSessionPriority has already been called */ void setIdentitySet(IdentitySetType identitySet); /** * Sets the value of the Identity-Set AVP, of type Enumerated. * * @throws IllegalStateException * if setSessionPriority has already been called */ void setIdentitySets(IdentitySetType[] identitySet); /** * Returns true if the One-Time-Notification AVP is present in the message. */ boolean hasOneTimeNotification(); /** * Returns the value of the One-Time-Notification AVP, of type Enumerated. * * @return the value of the One-Time-Notification AVP or null if it has not been set * on this message */ OneTimeNotificationType getOneTimeNotification(); /** * Sets the value of the One-Time-Notification AVP, of type Enumerated. * * @throws IllegalStateException * if setOneTimeNotification has already been called */ void setOneTimeNotification(OneTimeNotificationType oneTimeNotification); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy