org.mobicents.protocols.ss7.isup.message
Interface ISUPMessage

All Superinterfaces:

ISUPComponent, java.io.Serializable

All Known Subinterfaces:

AddressCompleteMessage, AnswerMessage, ApplicationTransportMessage, BlockingAckMessage, BlockingMessage, CallProgressMessage, ChargeInformationMessage, CircuitGroupBlockingAckMessage, CircuitGroupBlockingMessage, CircuitGroupQueryMessage, CircuitGroupQueryResponseMessage, CircuitGroupResetAckMessage, CircuitGroupResetMessage, CircuitGroupUnblockingAckMessage, CircuitGroupUnblockingMessage, ConfusionMessage, ConnectMessage, ContinuityCheckRequestMessage, ContinuityMessage, FacilityAcceptedMessage, FacilityMessage, FacilityRejectedMessage, FacilityRequestMessage, ForwardTransferMessage, IdentificationRequestMessage, IdentificationResponseMessage, InformationMessage, InformationRequestMessage, InitialAddressMessage, LoopbackAckMessage, LoopPreventionMessage, NetworkResourceManagementMessage, OverloadMessage, PassAlongMessage, PreReleaseInformationMessage, ReleaseCompleteMessage, ReleaseMessage, ResetCircuitMessage, ResumeMessage, SegmentationMessage, SubsequentAddressMessage, SubsequentDirectoryNumberMessage, SuspendMessage, UnblockingAckMessage, UnblockingMessage, UnequippedCICMessage, User2UserInformationMessage, UserPartAvailableMessage, UserPartTestMessage

public interface ISUPMessage
extends ISUPComponent

Start time:08:55:07 2009-08-30
Project: mobicents-isup-stack

Author:

Bartosz Baranowski

Field Summary

Fields inherited from interface org.mobicents.protocols.ss7.isup.ISUPComponent

_PROTOCOL_VERSION

Method Summary

void	addParameter(ISUPParameter param) Adds parameter to this message.
TransactionKey	generateTransactionKey() Generates TX key for fast matching.
CircuitIdentificationCode	getCircuitIdentificationCode() Set mandatory field, CIC.
MessageType	getMessageType() Returns message code.
ISUPParameter	getParameter(int parameterCode) Returns parameter with passed code.
ISUPTransaction	getTransaction() Return reference to transaction if it exists.
boolean	hasAllMandatoryParameters()
void	removeParameter(int parameterCode) Removes parameter from this message.
void	setCircuitIdentificationCode(CircuitIdentificationCode cic)

Methods inherited from interface org.mobicents.protocols.ss7.isup.ISUPComponent

decodeElement, encodeElement, encodeElement

Method Detail

getCircuitIdentificationCode

CircuitIdentificationCode getCircuitIdentificationCode()

Set mandatory field, CIC.

Returns:

setCircuitIdentificationCode

void setCircuitIdentificationCode(CircuitIdentificationCode cic)

getMessageType

MessageType getMessageType()

Returns message code. See Q.763 Table 4. It simply return value of static constant, where value of parameter is value of MESSAGE_CODE

Returns:

addParameter

void addParameter(ISUPParameter param)
                  throws ParameterRangeInvalidException

Adds parameter to this message.

Parameters:

param -

Throws:

ParameterRangeInvalidException - - thrown if parameter is not part of message.

getParameter

ISUPParameter getParameter(int parameterCode)
                           throws ParameterRangeInvalidException

Returns parameter with passed code.

Parameters:

parameterCode -

Returns:

Throws:

ParameterRangeInvalidException - - thrown if code does not match any parameter.

removeParameter

void removeParameter(int parameterCode)
                     throws ParameterRangeInvalidException

Removes parameter from this message.

Parameters:

parameterCode -

Throws:

ParameterRangeInvalidException

getTransaction

ISUPTransaction getTransaction()

Return reference to transaction if it exists.

Returns:

generateTransactionKey

TransactionKey generateTransactionKey()

Generates TX key for fast matching.

Returns:

hasAllMandatoryParameters

boolean hasAllMandatoryParameters()

Returns:

• true - if all requried parameters are set
• false - otherwise