Package io.snice.codecs.codec.diameter.impl

Class ImmutableDiameterMessage

java.lang.Object

io.snice.codecs.codec.diameter.impl.ImmutableDiameterMessage

All Implemented Interfaces:

DiameterMessage, Cloneable

Direct Known Subclasses:

ImmutableDiameterAnswer, ImmutableDiameterRequest

public abstract class ImmutableDiameterMessage
extends Object
implements DiameterMessage

Nested Class Summary

Nested classes/interfaces inherited from interface io.snice.codecs.codec.diameter.DiameterMessage

DiameterMessage.Builder<T extends DiameterMessage>

Field Summary

Fields

Modifier and Type	Field	Description
protected DiameterHeader	header

Constructor Summary

Constructors

Constructor	Description
ImmutableDiameterMessage(io.snice.buffer.Buffer raw, DiameterHeader header, List<FramedAvp> avps, short indexOrigHost, short indexOrigRealm, short indexDestHost, short indexDestRealm, short indexResultCode, short indexExperimentalResultCode)

Method Summary

Modifier and Type	Method	Description
DiameterMessage	clone()	This class is immutable and as such, when cloning, you'll just get back the same reference again.
boolean	equals(Object other)
List<FramedAvp>	getAllAvps()
Optional<FramedAvp>	getAvp(long code)	Get an FramedAvp.
io.snice.buffer.Buffer	getBuffer()	Get the entire DiameterMessage as a Buffer, which you then can use to e.g.
Optional<DestinationHost>	getDestinationHost()
Optional<DestinationRealm>	getDestinationRealm()
DiameterHeader	getHeader()
protected io.snice.functional.Either<ExperimentalResult,ResultCode>	getInternalResultCode()
OriginHost	getOriginHost()	The OriginHost MUST be present in all diameter messages.
OriginRealm	getOriginRealm()	The OriginRealm MUST be present in all diameter messages.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.snice.codecs.codec.diameter.DiameterMessage

copy, createAnswer, createAnswer, getAvps, isAIA, isAIR, isAnswer, isCEA, isCER, isCLA, isCLR, isDPA, isDPR, isDSA, isDSR, isDWA, isDWR, isIDA, isIDR, isNOA, isNOR, isPUA, isPUR, isRequest, isRSA, isRSR, isULA, isULR, toAnswer, toRequest, validate, validate

Field Detail

header

protected final DiameterHeader header

Constructor Detail

ImmutableDiameterMessage

public ImmutableDiameterMessage(io.snice.buffer.Buffer raw,
                                DiameterHeader header,
                                List<FramedAvp> avps,
                                short indexOrigHost,
                                short indexOrigRealm,
                                short indexDestHost,
                                short indexDestRealm,
                                short indexResultCode,
                                short indexExperimentalResultCode)

Method Detail

getAvp

public Optional<FramedAvp> getAvp(long code)

Description copied from interface: DiameterMessage

Get an FramedAvp. If there are multiple AVPs present, only the first one will be returned. Use DiameterMessage.getAvps(long) to retrieve those AVPs that may be present multiple times.

Specified by:

getAvp in interface DiameterMessage

Returns:

an Optional FramedAvp

getHeader

public DiameterHeader getHeader()

Specified by:

getHeader in interface DiameterMessage

getAllAvps

public List<FramedAvp> getAllAvps()

Specified by:

getAllAvps in interface DiameterMessage

getBuffer

public io.snice.buffer.Buffer getBuffer()

Description copied from interface: DiameterMessage

Get the entire DiameterMessage as a Buffer, which you then can use to e.g. write to network socket.

Specified by:

getBuffer in interface DiameterMessage

clone

public DiameterMessage clone()

This class is immutable and as such, when cloning, you'll just get back the same reference again.

Specified by:

clone in interface DiameterMessage

Overrides:

clone in class Object

Returns:

getOriginHost

public OriginHost getOriginHost()

Description copied from interface: DiameterMessage

The OriginHost MUST be present in all diameter messages.

Specified by:

getOriginHost in interface DiameterMessage

Returns:

the OriginHost or, as discussed in DiameterMessage.getOriginRealm(), null if it isn't present which means that this is actually a malformed DiameterMessage.

getOriginRealm

public OriginRealm getOriginRealm()

Description copied from interface: DiameterMessage

The OriginRealm MUST be present in all diameter messages. But is actually allowed to be null, see note below. However, even though this is indeed a mandatory AVP the snice diameter library does not enforce it by default. The reason is that if you are a security researcher, or someone that is perhaps building testing tools, you may want to be able to create an incorrect DiameterMessage. It is up to the actual diameter application/stack to, if that author so wishes, to enforce this so that applications built on top of it is guaranteed this.

Specified by:

getOriginRealm in interface DiameterMessage

Returns:

the OriginRealm or, as discussed above, null if it isn't present which means that this is actually a malformed DiameterMessage.

getDestinationRealm

public Optional<DestinationRealm> getDestinationRealm()

Specified by:

getDestinationRealm in interface DiameterMessage

getDestinationHost

public Optional<DestinationHost> getDestinationHost()

Specified by:

getDestinationHost in interface DiameterMessage

getInternalResultCode

protected io.snice.functional.Either<ExperimentalResult,ResultCode> getInternalResultCode()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object