Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

net.java.slee.resource.diameter.ro.events.avp
Interface ImsInformation

All Superinterfaces:
java.lang.Cloneable, net.java.slee.resource.diameter.base.events.avp.DiameterAvp, net.java.slee.resource.diameter.base.events.avp.GroupedAvp
All Known Implementing Classes:
ImsInformationImpl
public interface ImsInformation
extends net.java.slee.resource.diameter.base.events.avp.GroupedAvp

Defines an interface representing the IMS-Information grouped AVP type.

From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V7.1.0) specification: 

 
  7.2.37 IMS-Information AVP 
  The IMS-Information AVP (AVP code 876) is of type Grouped. 
  Its purpose is to allow the transmission of additional IMS service specific information elements. 
  
  It has the following ABNF grammar: 
    IMS-Information ::= AVP Header: 876 
      [ Event-Type ] 
      [ Role-Of-Node ] 
      { Node-Functionality } 
      [ User-Session-ID ] 
      [ Calling-Party-Address ] 
      [ Called-Party-Address ] 
      [ Time-Stamps ]
    * [ Application-Server-Information ]
    * [ Inter-Operator-Identifier ]
      [ IMS-Charging-Identifier ]
    * [ SDP-Session-Description ]
    * [ SDP-Media-Component ]
      [ Served-Party-IP-Address ]
      [ Server-Capabilities ]
      [ Trunk-Group-ID ]
      [ Bearer-Service ]
      [ Service-Id ]
      [ Service-Specific-Data ]
    * [ Message-Body ] 
      [ Cause-Code ]

Author:
Alexandre Mendonca , Bartosz Baranowski

Field Summary
 
Fields inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
 
Method Summary
 ApplicationServerInformation[] getApplicationServerInformations()
          Returns the set of Application-Server-Information AVPs.
 java.lang.String getBearerService()
          Returns the value of the Bearer-Service AVP, of type OctetString.
 java.lang.String getCalledPartyAddress()
          Returns the value of the Called-Party-Address AVP, of type UTF8String.
 java.lang.String getCallingPartyAddress()
          Returns the value of the Calling-Party-Address AVP, of type UTF8String.
 int getCauseCode()
          Returns the value of the Cause-Code AVP, of type Integer32.
 EventType getEventType()
          Returns the value of the Event-Type AVP, of type Grouped.
 java.lang.String getImsChargingIdentifier()
          Returns the value of the IMS-Charging-Identifier AVP, of type UTF8String.
 InterOperatorIdentifier[] getInterOperatorIdentifiers()
          Returns the set of Inter-Operator-Identifier AVPs.
 MessageBody[] getMessageBodys()
          Returns the set of Message-Body AVPs.
 NodeFunctionality getNodeFunctionality()
          Returns the value of the Node-Functionality AVP, of type Enumerated.
 RoleOfNode getRoleOfNode()
          Returns the value of the Role-Of-Node AVP, of type Enumerated.
 SdpMediaComponent[] getSdpMediaComponents()
          Returns the set of SDP-Media-Component AVPs.
 java.lang.String[] getSdpSessionDescriptions()
          Returns the set of SDP-Session-Description AVPs.
 net.java.slee.resource.diameter.base.events.avp.Address getServedPartyIpAddress()
          Returns the value of the Served-Party-IP-Address AVP, of type Address.
 ServerCapabilities getServerCapabilities()
          Returns the value of the Server-Capabilities AVP, of type OctetString.
 java.lang.String getServiceId()
          Returns the value of the Service-Id AVP, of type UTF8String.
 java.lang.String getServiceSpecificData()
          Returns the value of the Service-Specific-Data AVP, of type UTF8String.
 TimeStamps getTimeStamps()
          Returns the value of the Time-Stamps AVP, of type Grouped.
 TrunkGroupId getTrunkGroupId()
          Returns the value of the Trunk-Group-ID AVP, of type Grouped.
 java.lang.String getUserSessionId()
          Returns the value of the User-Session-ID AVP, of type UTF8String.
 boolean hasBearerService()
          Returns true if the Bearer-Service AVP is present in the message.
 boolean hasCalledPartyAddress()
          Returns true if the Called-Party-Address AVP is present in the message.
 boolean hasCallingPartyAddress()
          Returns true if the Calling-Party-Address AVP is present in the message.
 boolean hasCauseCode()
          Returns true if the Cause-Code AVP is present in the message.
 boolean hasEventType()
          Returns true if the Event-Type AVP is present in the message.
 boolean hasImsChargingIdentifier()
          Returns true if the IMS-Charging-Identifier AVP is present in the message.
 boolean hasNodeFunctionality()
          Returns true if the Node-Functionality AVP is present in the message.
 boolean hasRoleOfNode()
          Returns true if the Role-Of-Node AVP is present in the message.
 boolean hasServedPartyIpAddress()
          Returns true if the Served-Party-IP-Address AVP is present in the message.
 boolean hasServerCapabilities()
          Returns true if the Server-Capabilities AVP is present in the message.
 boolean hasServiceId()
          Returns true if the Service-Id AVP is present in the message.
 boolean hasServiceSpecificData()
          Returns true if the Service-Specific-Data AVP is present in the message.
 boolean hasTimeStamps()
          Returns true if the Time-Stamps AVP is present in the message.
 boolean hasTrunkGroupId()
          Returns true if the Trunk-Group-ID AVP is present in the message.
 boolean hasUserSessionId()
          Returns true if the User-Session-ID AVP is present in the message.
 void setApplicationServerInformation(ApplicationServerInformation applicationServerInformation)
          Sets a single Application-Server-Information AVP in the message, of type Grouped.
 void setApplicationServerInformations(ApplicationServerInformation[] applicationServerInformations)
          Sets the set of Application-Server-Information AVPs, with all the values in the given array.
 void setBearerService(java.lang.String bearerService)
          Sets the value of the Bearer-Service AVP, of type OctetString.
 void setCalledPartyAddress(java.lang.String calledPartyAddress)
          Sets the value of the Called-Party-Address AVP, of type UTF8String.
 void setCallingPartyAddress(java.lang.String callingPartyAddress)
          Sets the value of the Calling-Party-Address AVP, of type UTF8String.
 void setCauseCode(int causeCode)
          Sets the value of the Cause-Code AVP, of type Integer32.
 void setEventType(EventType eventType)
          Sets the value of the Event-Type AVP, of type Grouped.
 void setImsChargingIdentifier(java.lang.String imsChargingIdentifier)
          Sets the value of the IMS-Charging-Identifier AVP, of type UTF8String.
 void setInterOperatorIdentifier(InterOperatorIdentifier interOperatorIdentifier)
          Sets a single Inter-Operator-Identifier AVP in the message, of type Grouped.
 void setInterOperatorIdentifiers(InterOperatorIdentifier[] interOperatorIdentifiers)
          Sets the set of Inter-Operator-Identifier AVPs, with all the values in the given array.
 void setMessageBody(MessageBody messageBody)
          Sets a single Message-Body AVP in the message, of type Grouped.
 void setMessageBodys(MessageBody[] messageBodys)
          Sets the set of Message-Body AVPs, with all the values in the given array.
 void setNodeFunctionality(NodeFunctionality nodeFunctionality)
          Sets the value of the Node-Functionality AVP, of type Enumerated.
 void setRoleOfNode(RoleOfNode roleOfNode)
          Sets the value of the Role-Of-Node AVP, of type Enumerated.
 void setSdpMediaComponent(SdpMediaComponent sdpMediaComponent)
          Sets a single SDP-Media-Component AVP in the message, of type Grouped.
 void setSdpMediaComponents(SdpMediaComponent[] sdpMediaComponents)
          Sets the set of SDP-Media-Component AVPs, with all the values in the given array.
 void setSdpSessionDescription(java.lang.String sdpSessionDescription)
          Sets a single SDP-Session-Description AVP in the message, of type UTF8String.
 void setSdpSessionDescriptions(java.lang.String[] sdpSessionDescriptions)
          Sets the set of SDP-Session-Description AVPs, with all the values in the given array.
 void setServedPartyIpAddress(net.java.slee.resource.diameter.base.events.avp.Address servedPartyIpAddress)
          Sets the value of the Served-Party-IP-Address AVP, of type Address.
 void setServerCapabilities(ServerCapabilities serverCapabilities)
          Sets the value of the Server-Capabilities AVP, of type OctetString.
 void setServiceId(java.lang.String serviceId)
          Sets the value of the Service-Id AVP, of type UTF8String.
 void setServiceSpecificData(java.lang.String serviceSpecificData)
          Sets the value of the Service-Specific-Data AVP, of type UTF8String.
 void setTimeStamps(TimeStamps timeStamps)
          Sets the value of the Time-Stamps AVP, of type Grouped.
 void setTrunkGroupId(TrunkGroupId trunkGroupId)
          Sets the value of the Trunk-Group-ID AVP, of type Grouped.
 void setUserSessionId(java.lang.String userSessionId)
          Sets the value of the User-Session-ID AVP, of type UTF8String.
 
Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.GroupedAvp
getExtensionAvps, setExtensionAvps
 
Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorId, intValue, longValue, octetStringValue, stringValue
 

Method Detail

getApplicationServerInformations

ApplicationServerInformation[] getApplicationServerInformations()
Returns the set of Application-Server-Information AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Application-Server-Information AVPs have been set. The elements in the given array are ApplicationServerInformation objects.

getBearerService

java.lang.String getBearerService()
Returns the value of the Bearer-Service AVP, of type OctetString. A return value of null implies that the AVP has not been set.

getCalledPartyAddress

java.lang.String getCalledPartyAddress()
Returns the value of the Called-Party-Address AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getCallingPartyAddress

java.lang.String getCallingPartyAddress()
Returns the value of the Calling-Party-Address AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getCauseCode

int getCauseCode()
Returns the value of the Cause-Code AVP, of type Integer32. A return value 0< implies that the AVP has not been set.

getEventType

EventType getEventType()
Returns the value of the Event-Type AVP, of type Grouped. A return value of null implies that the AVP has not been set.

getImsChargingIdentifier

java.lang.String getImsChargingIdentifier()
Returns the value of the IMS-Charging-Identifier AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getInterOperatorIdentifiers

InterOperatorIdentifier[] getInterOperatorIdentifiers()
Returns the set of Inter-Operator-Identifier AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Inter-Operator-Identifier AVPs have been set. The elements in the given array are InterOperatorIdentifier objects.

getMessageBodys

MessageBody[] getMessageBodys()
Returns the set of Message-Body AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Message-Body AVPs have been set. The elements in the given array are MessageBody objects.

getNodeFunctionality

NodeFunctionality getNodeFunctionality()
Returns the value of the Node-Functionality AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

getRoleOfNode

RoleOfNode getRoleOfNode()
Returns the value of the Role-Of-Node AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

getSdpMediaComponents

SdpMediaComponent[] getSdpMediaComponents()
Returns the set of SDP-Media-Component AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no SDP-Media-Component AVPs have been set. The elements in the given array are SdpMediaComponent objects.

getSdpSessionDescriptions

java.lang.String[] getSdpSessionDescriptions()
Returns the set of SDP-Session-Description AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no SDP-Session-Description AVPs have been set. The elements in the given array are String objects.

getServedPartyIpAddress

net.java.slee.resource.diameter.base.events.avp.Address getServedPartyIpAddress()
Returns the value of the Served-Party-IP-Address AVP, of type Address. A return value of null implies that the AVP has not been set.

getServerCapabilities

ServerCapabilities getServerCapabilities()
Returns the value of the Server-Capabilities AVP, of type OctetString. A return value of null implies that the AVP has not been set.

getServiceId

java.lang.String getServiceId()
Returns the value of the Service-Id AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getServiceSpecificData

java.lang.String getServiceSpecificData()
Returns the value of the Service-Specific-Data AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getTimeStamps

TimeStamps getTimeStamps()
Returns the value of the Time-Stamps AVP, of type Grouped. A return value of null implies that the AVP has not been set.

getTrunkGroupId

TrunkGroupId getTrunkGroupId()
Returns the value of the Trunk-Group-ID AVP, of type Grouped. A return value of null implies that the AVP has not been set.

getUserSessionId

java.lang.String getUserSessionId()
Returns the value of the User-Session-ID AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

hasBearerService

boolean hasBearerService()
Returns true if the Bearer-Service AVP is present in the message.

hasCalledPartyAddress

boolean hasCalledPartyAddress()
Returns true if the Called-Party-Address AVP is present in the message.

hasCallingPartyAddress

boolean hasCallingPartyAddress()
Returns true if the Calling-Party-Address AVP is present in the message.

hasCauseCode

boolean hasCauseCode()
Returns true if the Cause-Code AVP is present in the message.

hasEventType

boolean hasEventType()
Returns true if the Event-Type AVP is present in the message.

hasImsChargingIdentifier

boolean hasImsChargingIdentifier()
Returns true if the IMS-Charging-Identifier AVP is present in the message.

hasNodeFunctionality

boolean hasNodeFunctionality()
Returns true if the Node-Functionality AVP is present in the message.

hasRoleOfNode

boolean hasRoleOfNode()
Returns true if the Role-Of-Node AVP is present in the message.

hasServedPartyIpAddress

boolean hasServedPartyIpAddress()
Returns true if the Served-Party-IP-Address AVP is present in the message.

hasServerCapabilities

boolean hasServerCapabilities()
Returns true if the Server-Capabilities AVP is present in the message.

hasServiceId

boolean hasServiceId()
Returns true if the Service-Id AVP is present in the message.

hasServiceSpecificData

boolean hasServiceSpecificData()
Returns true if the Service-Specific-Data AVP is present in the message.

hasTimeStamps

boolean hasTimeStamps()
Returns true if the Time-Stamps AVP is present in the message.

hasTrunkGroupId

boolean hasTrunkGroupId()
Returns true if the Trunk-Group-ID AVP is present in the message.

hasUserSessionId

boolean hasUserSessionId()
Returns true if the User-Session-ID AVP is present in the message.

setApplicationServerInformation

void setApplicationServerInformation(ApplicationServerInformation applicationServerInformation)
Sets a single Application-Server-Information AVP in the message, of type Grouped.

setApplicationServerInformations

void setApplicationServerInformations(ApplicationServerInformation[] applicationServerInformations)
Sets the set of Application-Server-Information 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 getApplicationServerInformations() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

setBearerService

void setBearerService(java.lang.String bearerService)
Sets the value of the Bearer-Service AVP, of type OctetString.

setCalledPartyAddress

void setCalledPartyAddress(java.lang.String calledPartyAddress)
Sets the value of the Called-Party-Address AVP, of type UTF8String.

setCallingPartyAddress

void setCallingPartyAddress(java.lang.String callingPartyAddress)
Sets the value of the Calling-Party-Address AVP, of type UTF8String.

setCauseCode

void setCauseCode(int causeCode)
Sets the value of the Cause-Code AVP, of type Integer32.

setEventType

void setEventType(EventType eventType)
Sets the value of the Event-Type AVP, of type Grouped.

setImsChargingIdentifier

void setImsChargingIdentifier(java.lang.String imsChargingIdentifier)
Sets the value of the IMS-Charging-Identifier AVP, of type UTF8String.

setInterOperatorIdentifier

void setInterOperatorIdentifier(InterOperatorIdentifier interOperatorIdentifier)
Sets a single Inter-Operator-Identifier AVP in the message, of type Grouped.

setInterOperatorIdentifiers

void setInterOperatorIdentifiers(InterOperatorIdentifier[] interOperatorIdentifiers)
Sets the set of Inter-Operator-Identifier 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 getInterOperatorIdentifiers() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

setMessageBody

void setMessageBody(MessageBody messageBody)
Sets a single Message-Body AVP in the message, of type Grouped.

setMessageBodys

void setMessageBodys(MessageBody[] messageBodys)
Sets the set of Message-Body 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 getMessageBodys() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

setNodeFunctionality

void setNodeFunctionality(NodeFunctionality nodeFunctionality)
Sets the value of the Node-Functionality AVP, of type Enumerated.

setRoleOfNode

void setRoleOfNode(RoleOfNode roleOfNode)
Sets the value of the Role-Of-Node AVP, of type Enumerated.

setSdpMediaComponent

void setSdpMediaComponent(SdpMediaComponent sdpMediaComponent)
Sets a single SDP-Media-Component AVP in the message, of type Grouped.

setSdpMediaComponents

void setSdpMediaComponents(SdpMediaComponent[] sdpMediaComponents)
Sets the set of SDP-Media-Component 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 getSdpMediaComponents() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

setSdpSessionDescription

void setSdpSessionDescription(java.lang.String sdpSessionDescription)
Sets a single SDP-Session-Description AVP in the message, of type UTF8String.

setSdpSessionDescriptions

void setSdpSessionDescriptions(java.lang.String[] sdpSessionDescriptions)
Sets the set of SDP-Session-Description 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 getSdpSessionDescriptions() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

setServedPartyIpAddress

void setServedPartyIpAddress(net.java.slee.resource.diameter.base.events.avp.Address servedPartyIpAddress)
Sets the value of the Served-Party-IP-Address AVP, of type Address.

setServerCapabilities

void setServerCapabilities(ServerCapabilities serverCapabilities)
Sets the value of the Server-Capabilities AVP, of type OctetString.

setServiceId

void setServiceId(java.lang.String serviceId)
Sets the value of the Service-Id AVP, of type UTF8String.

setServiceSpecificData

void setServiceSpecificData(java.lang.String serviceSpecificData)
Sets the value of the Service-Specific-Data AVP, of type UTF8String.

setTimeStamps

void setTimeStamps(TimeStamps timeStamps)
Sets the value of the Time-Stamps AVP, of type Grouped.

setTrunkGroupId

void setTrunkGroupId(TrunkGroupId trunkGroupId)
Sets the value of the Trunk-Group-ID AVP, of type Grouped.

setUserSessionId

void setUserSessionId(java.lang.String userSessionId)
Sets the value of the User-Session-ID AVP, of type UTF8String.

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2011. All Rights Reserved.