net.java.slee.resource.diameter.rf.events
Interface RfAccountingRequest

All Superinterfaces:
java.lang.Cloneable, net.java.slee.resource.diameter.base.events.DiameterMessage, RfAccountingMessage
All Known Implementing Classes:
RfAccountingRequestImpl

public interface RfAccountingRequest
extends net.java.slee.resource.diameter.base.events.DiameterMessage, RfAccountingMessage

Defines an interface representing the Accounting-Request command. From the Diameter Ro/Rf Protocol (TS 32299-6c0) specification:

 Accounting-Request
 The ACR messages, indicated by the Command-Code field set to 271 is sent by the CTF to the CDF
 in order to sent charging information for the request bearer / subsystem /service. 
 The ACR message format is defined according to the Diameter Base Protocol [401] as follows:
       <ACR> ::= < Diameter Header: 271, REQ, PXY >
                 < Session-Id >
                 { Origin-Host }
                 { Origin-Realm }
                 { Destination-Realm }
                 { Accounting-Record-Type }
                 { Accounting-Record-Number }
                 [ Acct-Application-Id ]
                 [ User-Name ]
                 [ Acct-Interim-Interval ]
                 [ Origin-State-Id ]
                 [ Event-Timestamp ]              
                *[ Proxy-Info ]
                *[ Route-Record ]
                 [ Service-Information ]
                *[ AVP ]
 
 
 

Author:
Alexandre Mendonca , Bartosz Baranowski

Field Summary
 
Fields inherited from interface net.java.slee.resource.diameter.rf.events.RfAccountingMessage
commandCode
 
Method Summary
 java.lang.String getCalledStationId()
          Returns the value of the Called-Station-Id AVP, of type UTF8String.
 LocationType getLocationType()
          Returns the value of the Location-Type AVP, of type Grouped.
 net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[] getRouteRecords()
          Returns the set of Route-Record AVPs.
 ServiceInformation getServiceInformation()
          Returns the value of the Service-Information AVP, of type Grouped.
 boolean hasCalledStationId()
          Returns true if the Called-Station-Id AVP is present in the message.
 boolean hasLocationType()
          Returns true if the Location-Type AVP is present in the message.
 boolean hasServiceInformation()
          Returns true if the Service-Information AVP is present in the message.
 void setCalledStationId(java.lang.String si)
          Sets the value of the Called-Station-Id AVP, of type UTF8String.
 void setLocationType(LocationType si)
          Sets the value of the Location-Type AVP, of type Grouped.
 void setRouteRecord(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity routeRecord)
          Sets a single Route-Record AVP in the message, of type DiameterIdentity.
 void setRouteRecords(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[] routeRecords)
          Sets the set of Route-Record AVPs, with all the values in the given array.
 void setServiceInformation(ServiceInformation si)
          Sets the value of the Service-Information AVP, of type Grouped.
 
Methods inherited from interface net.java.slee.resource.diameter.rf.events.RfAccountingMessage
getAccountingRecordNumber, getAccountingRecordType, getAcctApplicationId, getAcctInterimInterval, getEventTimestamp, getOriginStateId, getProxyInfos, getUserName, hasAccountingRecordNumber, hasAccountingRecordType, hasAcctApplicationId, hasAcctInterimInterval, hasEventTimestamp, hasOriginStateId, hasUserName, setAccountingRecordNumber, setAccountingRecordType, setAcctApplicationId, setAcctInterimInterval, setEventTimestamp, setOriginStateId, setProxyInfo, setProxyInfos, setUserName
 
Methods inherited from interface net.java.slee.resource.diameter.base.events.DiameterMessage
clone, getAvps, getCommand, getDestinationHost, getDestinationRealm, getExtensionAvps, getHeader, getOriginHost, getOriginRealm, getSessionId, hasDestinationHost, hasDestinationRealm, hasOriginHost, hasOriginRealm, hasSessionId, setDestinationHost, setDestinationRealm, setExtensionAvps, setOriginHost, setOriginRealm, setSessionId
 

Method Detail

getRouteRecords

net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[] getRouteRecords()
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.


setRouteRecord

void setRouteRecord(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity routeRecord)
Sets a single Route-Record AVP in the message, of type DiameterIdentity.

Throws:
java.lang.IllegalStateException - if setRouteRecord or setRouteRecords has already been called

setRouteRecords

void setRouteRecords(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[] routeRecords)
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:
java.lang.IllegalStateException - if setRouteRecord or setRouteRecords has already been called

getServiceInformation

ServiceInformation getServiceInformation()
Returns the value of the Service-Information AVP, of type Grouped.

Returns:
the value of the Service-Information AVP or null if it has not been set on this message

setServiceInformation

void setServiceInformation(ServiceInformation si)
Sets the value of the Service-Information AVP, of type Grouped.

Throws:
java.lang.IllegalStateException - if setServiceInformation has already been called

hasServiceInformation

boolean hasServiceInformation()
Returns true if the Service-Information AVP is present in the message.


getCalledStationId

java.lang.String getCalledStationId()
Returns the value of the Called-Station-Id AVP, of type UTF8String.

Returns:
the value of the Called-Station-Id AVP or null if it has not been set on this message

setCalledStationId

void setCalledStationId(java.lang.String si)
Sets the value of the Called-Station-Id AVP, of type UTF8String.

Throws:
java.lang.IllegalStateException - if setCalledStationId has already been called

hasCalledStationId

boolean hasCalledStationId()
Returns true if the Called-Station-Id AVP is present in the message.


getLocationType

LocationType getLocationType()
Returns the value of the Location-Type AVP, of type Grouped.

Returns:
the value of the Location-Type AVP or null if it has not been set on this message

setLocationType

void setLocationType(LocationType si)
Sets the value of the Location-Type AVP, of type Grouped.

Throws:
java.lang.IllegalStateException - if setLocationType has already been called

hasLocationType

boolean hasLocationType()
Returns true if the Location-Type AVP is present in the message.



Copyright © 2011. All Rights Reserved.