/*
* Mobicents, Communications Middleware
*
* Copyright (c) 2008, Red Hat Middleware LLC or third-party
* contributors as
* indicated by the @author tags or express copyright attribution
* statements applied by the authors. All third-party contributions are
* distributed under license by Red Hat Middleware LLC.
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* 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 Lesser General Public License
* for more details.
*
*
* You should have received a copy of the GNU Lesser General Public License
* along with this distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
*
* Boston, MA 02110-1301 USA
*/
package net.java.slee.resource.diameter.sh.server.events;
import java.util.Date;
import net.java.slee.resource.diameter.sh.client.events.DiameterShMessage;
import net.java.slee.resource.diameter.sh.client.events.avp.DataReferenceType;
import net.java.slee.resource.diameter.sh.client.events.avp.SendDataIndicationType;
import net.java.slee.resource.diameter.sh.client.events.avp.SubsReqType;
import net.java.slee.resource.diameter.sh.client.events.avp.UserIdentityAvp;
/**
* Defines an interface representing the Subscribe-Notifications-Request
* command.
*
* From the Diameter Sh Reference Point Protocol Details (3GPP TS 29.329 V7.1.0)
* specification:
*
* <pre>
* 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 }
* *[ Service-Indication]
* [ Server-Name ]
* { Subs-Req-Type }
* *{ Data-Reference }
* [ Expiry-Time ]
* [ Send-Data-Indication ]
* *[ AVP ]
* *[ Proxy-Info ]
* *[ Route-Record ]
* </pre>
*/
public interface SubscribeNotificationsRequest extends DiameterShMessage {
static final int commandCode = 308;
/**
* Returns true if the Destination-Host AVP is present in the message.
*/
boolean hasDestinationHost();
/**
* Returns true if the Destination-Realm AVP is present in the message.
*/
boolean hasDestinationRealm();
/**
* 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. The elements in
* the given array are byte[] objects.
*/
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 msg has Data-Reference-Type AVP
* @return
*/
boolean hasDataReferenceType();
}