net.java.slee.resource.diameter.base.events
Interface DiameterHeader

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

DiameterHeaderImpl

public interface DiameterHeader
extends java.lang.Cloneable

Interface to allow applications to retrieve Diameter header fields should they need to.

Author:

Open Cloud

Method Summary

java.lang.Object	clone() Creates and returns a deep copy of this diameter header instance.
long	getApplicationId() Return application ID from this Diameter header.
int	getCommandCode() Return the command code stored in this Diameter header.
long	getEndToEndId() Return End-to-End ID from this Diameter header.
long	getHopByHopId() Return Hop-by-Hop ID from this Diameter header.
int	getMessageLength() Return the message length stored in this Diameter header.
short	getVersion() Return the Diameter version ID from this Diameter header.
boolean	isError() Return true if the error flag is set in this header.
boolean	isPotentiallyRetransmitted() Return true if the potentially retransmitted flag is set in this header.
boolean	isProxiable() Return true if the proxiable flag is set in this header.
boolean	isRequest() Return true if the request flag is set in this header.

Method Detail

isRequest

boolean isRequest()

Return true if the request flag is set in this header.

Returns:

request flag

isProxiable

boolean isProxiable()

Return true if the proxiable flag is set in this header.

Returns:

proxiable flag

isError

boolean isError()

Return true if the error flag is set in this header.

Returns:

error flag

isPotentiallyRetransmitted

boolean isPotentiallyRetransmitted()

Return true if the potentially retransmitted flag is set in this header.

Returns:

potentially retransmitted flag

getApplicationId

long getApplicationId()

Return application ID from this Diameter header.

Returns:

the application ID

getHopByHopId

long getHopByHopId()

Return Hop-by-Hop ID from this Diameter header.

Returns:

the hop-by-hop id

getEndToEndId

long getEndToEndId()

Return End-to-End ID from this Diameter header.

Returns:

the end-to-end id

getVersion

short getVersion()

Return the Diameter version ID from this Diameter header.

Returns:

the value 1

getMessageLength

int getMessageLength()

Return the message length stored in this Diameter header. Note that for outgoing messages, the correct length may not be known until the message is encoded for transmission.

Returns:

the message length

getCommandCode

int getCommandCode()

Return the command code stored in this Diameter header.

Returns:

the command code

clone

java.lang.Object clone()

Creates and returns a deep copy of this diameter header instance.

Returns:

a deep copy of this header.