net.java.slee.resource.diameter.gq.events
Interface GqAAAnswer

All Superinterfaces:

java.lang.Cloneable, net.java.slee.resource.diameter.base.events.DiameterMessage

All Known Implementing Classes:

GqAAAnswerImpl

public interface GqAAAnswer
extends net.java.slee.resource.diameter.base.events.DiameterMessage

 7.1.2 AA-Answer(AAA) command
 The AAA command, indicated by the Command-Code field set to 265 and the "R" bit cleared in the Command Flags
 field, is sent by the SPDF to the AF in response to the AAR command.
 Message Format:
 <AA-Answer> ::= < Diameter Header: 265, PXY >
                 < Session-Id >
                 { Auth-Application-Id }
                 { Origin-Host }
                 { Origin-Realm }
                 [ Result-Code ]
                 [ Experimental-Result ]
                 [ Binding-Information ]
                 [ Reservation-Priority ]
                 [ Error-Message ]
                 [ Error-Reporting-Host ]
                 [ Authorization-Lifetime ]
                 [ Auth-Grace-Period ]
                 [ Failed-AVP ]
                 [ Proxy-Info ]
                 [ AVP ]
 

Author:

Yulian Oifa

Field Summary

static int

COMMAND_CODE

Method Summary

long	getAuthApplicationId() Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
long	getAuthGracePeriod() Returns the value of the Auth-Grace-Period AVP, of type Unsigned32.
long	getAuthorizationLifetime() Returns the value of the Authorization-Lifetime AVP, of type Unsigned32.
BindingInformation	getBindingInformation() Returns the value of the Binding-Information AVP, of type BindingInformation.
java.lang.String	getErrorMessage() Returns the value of the Error-Message AVP, of type UTF8String.
net.java.slee.resource.diameter.base.events.avp.DiameterIdentity	getErrorReportingHost() Returns the value of the Error-Reporting-Host AVP, of type DiameterIdentity.
net.java.slee.resource.diameter.base.events.avp.ExperimentalResultAvp	getExperimentalResult() Returns the value of the Experimental-Result AVP, of type ExperimentalResultAvp.
net.java.slee.resource.diameter.base.events.avp.FailedAvp[]	getFailedAvps() Returns the set of Failed-AVP AVPs.
net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[]	getProxyInfos() Returns the set of Proxy-Info AVPs.
ReservationPriority	getReservationPriority() Returns the value of the Reservation-Priority AVP, of type ReservationPriority.
long	getResultCode() Returns the value of the Result-Code AVP, of type Unsigned32.
boolean	hasAuthApplicationId() Returns true if the Auth-Application-Id AVP is present in the message.
boolean	hasAuthGracePeriod() Returns true if the Auth-Grace-Period AVP is present in the message.
boolean	hasAuthorizationLifetime() Returns true if the Authorization-Lifetime AVP is present in the message.
boolean	hasBindingInformation() Returns true if the Binding-Information AVP is present in the message.
boolean	hasErrorMessage() Returns true if the Error-Message AVP is present in the message.
boolean	hasErrorReportingHost() Returns true if the Error-Reporting-Host AVP is present in the message.
boolean	hasExperimentalResult() Returns true if the Experimental-Result AVP is present in the message.
boolean	hasReservationPriority() Returns true if the Reservation-Priority AVP is present in the message.
boolean	hasResultCode() Returns true if the Result-Code AVP is present in the message.
void	setAuthApplicationId(long authApplicationId) Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
void	setAuthGracePeriod(long authGracePeriod) Sets the value of the Auth-Grace-Period AVP, of type Unsigned32.
void	setAuthorizationLifetime(long authorizationLifetime) Sets the value of the Authorization-Lifetime AVP, of type Unsigned32.
void	setBindingInformation(BindingInformation bindingInformation) Sets the value of the Binding-Information AVP, of type BindingInformation.
void	setErrorMessage(java.lang.String errorMessage) Sets the value of the Error-Message AVP, of type UTF8String.
void	setErrorReportingHost(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity errorReportingHost) Sets the value of the Error-Reporting-Host AVP, of type DiameterIdentity.
void	setExperimentalResult(net.java.slee.resource.diameter.base.events.avp.ExperimentalResultAvp experimentalResult) Sets the value of the Experimental-Result AVP, of type ExperimentalResultAvp.
void	setFailedAvp(net.java.slee.resource.diameter.base.events.avp.FailedAvp failedAvp) Sets a single Failed-AVP AVP in the message, of type Grouped.
void	setFailedAvps(net.java.slee.resource.diameter.base.events.avp.FailedAvp[] failedAvps) Sets the set of Failed-AVP AVPs, with all the values in the given array.
void	setProxyInfo(net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp proxyInfo) Sets a single Proxy-Info AVP in the message, of type Grouped.
void	setProxyInfos(net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[] proxyInfos) Sets the set of Proxy-Info AVPs, with all the values in the given array.
void	setReservationPriority(ReservationPriority reservationPriority) Sets the value of the Reservation-Priority AVP, of type ReservationPriority.
void	setResultCode(long resultCode) Sets the value of the Result-Code AVP, of type Unsigned32.

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

Field Detail

COMMAND_CODE

static final int COMMAND_CODE

See Also:

Constant Field Values

Method Detail

getAuthApplicationId

long getAuthApplicationId()

Returns the value of the Auth-Application-Id AVP, of type Unsigned32.

Returns:

setAuthApplicationId

void setAuthApplicationId(long authApplicationId)
                          throws java.lang.IllegalStateException

Sets the value of the Auth-Application-Id AVP, of type Unsigned32.

Parameters:

authApplicationId -

Throws:

java.lang.IllegalStateException

hasAuthApplicationId

boolean hasAuthApplicationId()

Returns true if the Auth-Application-Id AVP is present in the message.

Returns:

hasResultCode

boolean hasResultCode()

Returns true if the Result-Code AVP is present in the message.

getResultCode

long getResultCode()

Returns the value of the Result-Code AVP, of type Unsigned32. Use hasResultCode() to check the existence of this AVP.

Returns:

the value of the Result-Code AVP

Throws:

java.lang.IllegalStateException - if the Result-Code AVP has not been set on this message

setResultCode

void setResultCode(long resultCode)

Sets the value of the Result-Code AVP, of type Unsigned32.

Throws:

java.lang.IllegalStateException - if setResultCode has already been called

getFailedAvps

net.java.slee.resource.diameter.base.events.avp.FailedAvp[] getFailedAvps()

Returns the set of Failed-AVP AVPs.

Returns:

setFailedAvp

void setFailedAvp(net.java.slee.resource.diameter.base.events.avp.FailedAvp failedAvp)
                  throws java.lang.IllegalStateException

Sets a single Failed-AVP AVP in the message, of type Grouped.

Parameters:

failedAvp -

Throws:

java.lang.IllegalStateException

setFailedAvps

void setFailedAvps(net.java.slee.resource.diameter.base.events.avp.FailedAvp[] failedAvps)
                   throws java.lang.IllegalStateException

Sets the set of Failed-AVP AVPs, with all the values in the given array.

Parameters:

failedAvps -

Throws:

java.lang.IllegalStateException

getProxyInfos

net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[] getProxyInfos()

Returns the set of Proxy-Info AVPs.

Returns:

setProxyInfo

void setProxyInfo(net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp proxyInfo)
                  throws java.lang.IllegalStateException

Sets a single Proxy-Info AVP in the message, of type Grouped.

Parameters:

proxyInfo -

Throws:

java.lang.IllegalStateException

setProxyInfos

void setProxyInfos(net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[] proxyInfos)
                   throws java.lang.IllegalStateException

Sets the set of Proxy-Info AVPs, with all the values in the given array.

Parameters:

proxyInfos -

Throws:

java.lang.IllegalStateException

getAuthorizationLifetime

long getAuthorizationLifetime()

Returns the value of the Authorization-Lifetime AVP, of type Unsigned32.

Returns:

setAuthorizationLifetime

void setAuthorizationLifetime(long authorizationLifetime)
                              throws java.lang.IllegalStateException

Sets the value of the Authorization-Lifetime AVP, of type Unsigned32.

Parameters:

authApplicationId -

Throws:

java.lang.IllegalStateException

hasAuthorizationLifetime

boolean hasAuthorizationLifetime()

Returns true if the Authorization-Lifetime AVP is present in the message.

Returns:

hasAuthGracePeriod

boolean hasAuthGracePeriod()

Returns true if the Auth-Grace-Period AVP is present in the message.

getAuthGracePeriod

long getAuthGracePeriod()

Returns the value of the Auth-Grace-Period AVP, of type Unsigned32. Use hasAuthGracePeriod() to check the existence of this AVP.

Returns:

the value of the Auth-Grace-Period AVP

Throws:

java.lang.IllegalStateException - if the Auth-Grace-Period AVP has not been set on this message

setAuthGracePeriod

void setAuthGracePeriod(long authGracePeriod)

Sets the value of the Auth-Grace-Period AVP, of type Unsigned32.

Throws:

java.lang.IllegalStateException - if setAuthGracePeriod has already been called

hasErrorMessage

boolean hasErrorMessage()

Returns true if the Error-Message AVP is present in the message.

getErrorMessage

java.lang.String getErrorMessage()

Returns the value of the Error-Message AVP, of type UTF8String.

Returns:

the value of the Error-Message AVP or null if it has not been set on this message

setErrorMessage

void setErrorMessage(java.lang.String errorMessage)
                     throws java.lang.IllegalStateException

Sets the value of the Error-Message AVP, of type UTF8String.

Throws:

java.lang.IllegalStateException - if setErrorMessage has already been called

hasErrorReportingHost

boolean hasErrorReportingHost()

Returns true if the Error-Reporting-Host AVP is present in the message.

getErrorReportingHost

net.java.slee.resource.diameter.base.events.avp.DiameterIdentity getErrorReportingHost()

Returns the value of the Error-Reporting-Host AVP, of type DiameterIdentity.

Returns:

the value of the Error-Reporting-Host AVP or null if it has not been set on this message

setErrorReportingHost

void setErrorReportingHost(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity errorReportingHost)
                           throws java.lang.IllegalStateException

Sets the value of the Error-Reporting-Host AVP, of type DiameterIdentity.

Throws:

java.lang.IllegalStateException - if setErrorReportingHost has already been called

hasExperimentalResult

boolean hasExperimentalResult()

Returns true if the Experimental-Result AVP is present in the message.

getExperimentalResult

net.java.slee.resource.diameter.base.events.avp.ExperimentalResultAvp getExperimentalResult()

Returns the value of the Experimental-Result AVP, of type ExperimentalResultAvp.

Returns:

the value of the Experimental-Result AVP or null if it has not been set on this message

setExperimentalResult

void setExperimentalResult(net.java.slee.resource.diameter.base.events.avp.ExperimentalResultAvp experimentalResult)
                           throws java.lang.IllegalStateException

Sets the value of the Experimental-Result AVP, of type ExperimentalResultAvp.

Throws:

java.lang.IllegalStateException - if setErrorReportingHost has already been called

hasBindingInformation

boolean hasBindingInformation()

Returns true if the Binding-Information AVP is present in the message.

getBindingInformation

BindingInformation getBindingInformation()

Returns the value of the Binding-Information AVP, of type BindingInformation.

Returns:

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

setBindingInformation

void setBindingInformation(BindingInformation bindingInformation)
                           throws java.lang.IllegalStateException

Sets the value of the Binding-Information AVP, of type BindingInformation.

Throws:

java.lang.IllegalStateException - if setBindingInformation has already been called

hasReservationPriority

boolean hasReservationPriority()

Returns true if the Reservation-Priority AVP is present in the message.

getReservationPriority

ReservationPriority getReservationPriority()

Returns the value of the Reservation-Priority AVP, of type ReservationPriority.

Returns:

the value of the Reservation-Priority AVP or null if it has not been set on this message

setReservationPriority

void setReservationPriority(ReservationPriority reservationPriority)
                            throws java.lang.IllegalStateException

Sets the value of the Reservation-Priority AVP, of type ReservationPriority.

Throws:

java.lang.IllegalStateException - if setReservationPriority has already been called