jain.protocol.ss7.tcap.dialogue
Class UnidirectionalIndEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.DialogueIndEvent
              |
              +--jain.protocol.ss7.tcap.dialogue.UnidirectionalIndEvent

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class UnidirectionalIndEvent

extends DialogueIndEvent

An event representing a TCAP Unidirectional indication dialogue primitive. This event will be passed from the Provider (TCAP) to the Listener(the TC User) to indicate the receipt of a TCAP message from an Unstructured dialogue (a dialogue between two TC Users with no explicit association between them).
The mandatory parameters of this primitive are supplied to the constructor. Optional parameters may then be set using the set methods.

The optional parameters 'Application Context Name' and 'User Information' are centrally located in the Dialogue Portion class, therefore to manipulate them it is necessary it instantiate the Dialogue Portion Object and use the accessors method for the two parameters in that Dialogue Portion Object. A Uni Indication event is the only Dialogue Indication Event that does not use a Dialogue Id within the supported variants. However for the JAIN TCAP API specification the Dialogue Id will be included to associate Component Events with this Dialogue Event, hence simplifying the implementation of a JAIN TCAP application.

Version:

1.1

Author:

Sun Microsystems Inc.

See Also:

DialogueIndEvent, Serialized Form

Field Summary

protected boolean

m_dialogueIdPresent Deprecated. As of JAIN TCAP v1.1, a UNI Indication does not contain a dialogueId.

Fields inherited from class jain.protocol.ss7.tcap.DialogueIndEvent

m_dialogueId, m_dialoguePortion, m_dialoguePortionPresent

Fields inherited from class java.util.EventObject

source

Constructor Summary

UnidirectionalIndEvent(java.lang.Object source, SccpUserAddress originAddress, SccpUserAddress destAddress, boolean componentsPresent)
Constructs a new UnidirectionalIndEvent, with only the Event Source and the JAIN TCAP Mandatory parameters being supplied to the constructor.

Method Summary

void	clearAllParameters() Clears all previously set parameters and resets the 'Components Present' flag to false.
SccpUserAddress	getDestinationAddress() Gets the Destination Address parameter of the Unidirectional indication primtive.
int	getDialogueId() Note to developers :- A Dialogue Id is forbidden in a UNI Indication message, therefore this method should not be used in a UnidirectionalInd Event.
SccpUserAddress	getOriginatingAddress() Gets the Originating Address parameter of the Unidirectional indication primitive.
int	getPrimitiveType() This method returns the type of this primitive.
byte	getQualityOfService() Gets the Quality of Service parameter of the unidirectional indication primitive.
boolean	isComponentsPresent() Returns the Components present flag of this Unidirectional indication primitive.
boolean	isDialogueIdPresent() Deprecated. As of JAIN TCAP v1.1, there is no concept of a dialogueId in a UNI Indication message.
boolean	isQualityOfServicePresent() Indicates if the Quality of Service parameter is present in this Event.
void	setComponentsPresent(boolean componentsPresent) Sets the Components present parameter of this Unidirectional indication primitive.
void	setDestinationAddress(SccpUserAddress destination) Sets the Destination Address parameter of the Unidirectional indication primitive.
void	setDialogueId(int dialogueId) Note to developers :- A Dialogue Id is forbidden in a UNI Indication message, therefore this method should not be used in a UnidirectionalInd Event.
void	setOriginatingAddress(SccpUserAddress origin) Sets the Originating Address parameter of the Unidirectional indication primitive.
void	setQualityOfService(byte qualityOfService) Sets the Quality of Service parameter of the unidirectional indication primitive.
java.lang.String	toString() String representation of class UnidirectionalIndEvent

Methods inherited from class jain.protocol.ss7.tcap.DialogueIndEvent

getDialoguePortion, isDialoguePortionPresent, setDialoguePortion, setSource

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_dialogueIdPresent

protected boolean m_dialogueIdPresent

Deprecated. As of JAIN TCAP v1.1, a UNI Indication does not contain a dialogueId.

Constructor Detail

UnidirectionalIndEvent

public UnidirectionalIndEvent(java.lang.Object source,
                              SccpUserAddress originAddress,
                              SccpUserAddress destAddress,
                              boolean componentsPresent)

Constructs a new UnidirectionalIndEvent, with only the Event Source and the JAIN TCAP Mandatory parameters being supplied to the constructor. Within this method TcapUserAddress has been changed to SccpUserAddress. The method has not been deprecated as a new method using type SccpUserAddress would have to be created with a different method name. This is less desirable than the effective removal of the old method.

Parameters:

source - the Event Source supplied to the constructor

originAddress - the Originating Address supplied to the constructor

destAddress - the Destination Address supplied to the constructor

componentsPresent - the Components Present Flag supplied to the constructor

Method Detail

setDialogueId

public void setDialogueId(int dialogueId)

Note to developers :- A Dialogue Id is forbidden in a UNI Indication message, therefore this method should not be used in a UnidirectionalInd Event. This method overrides the setDialogueId in the Dialogue Indication Event and contains no functionality.

Overrides:

setDialogueId in class DialogueIndEvent

Parameters:

dialogueId - The new DialogueId value

Since:

JAIN TCAP v1.1

setDestinationAddress

public void setDestinationAddress(SccpUserAddress destination)

Sets the Destination Address parameter of the Unidirectional indication primitive. Destination Address is an SCCP parameter that is required from the application. Within this method TcapUserAddress has been changed to SccpUserAddress. The method has not been deprecated as a new method using type SccpUserAddress would have to be created with a different method name. This is less desirable than the effective removal of the old method.

Parameters:

destination - The new Destination Address value

setOriginatingAddress

public void setOriginatingAddress(SccpUserAddress origin)

Sets the Originating Address parameter of the Unidirectional indication primitive. Origination Address is an SCCP parameter that is required from the application. Within this method TcapUserAddress has been changed to SccpUserAddress. The method has not been deprecated as a new method using type SccpUserAddress would have to be created with a different method name. This is less desirable than the effective removal of the old method.

Parameters:

origin - The new Originating Address value

setQualityOfService

public void setQualityOfService(byte qualityOfService)

Sets the Quality of Service parameter of the unidirectional indication primitive.

Parameters:

qualityOfService - The new Quality Of Service value

setComponentsPresent

public void setComponentsPresent(boolean componentsPresent)

Sets the Components present parameter of this Unidirectional indication primitive. This flag is used to determine if their are any components associated with this primitive. This flag will be reset to false when the clearAllParameters() method is invoked.

Parameters:

componentsPresent - The new Components Present Flag

isDialogueIdPresent

public boolean isDialogueIdPresent()

Deprecated. As of JAIN TCAP v1.1, there is no concept of a dialogueId in a UNI Indication message.

getDialogueId

public int getDialogueId()
                  throws MandatoryParameterNotSetException

Note to developers :- A Dialogue Id is forbidden in a UNI Indication message, therefore this method should not be used in a UnidirectionalInd Event. This method will always return the MandatoryParameterNotSetException, with the error message "A UNI Indication does not contain a Dialogue Identifier".

Overrides:

getDialogueId in class DialogueIndEvent

Returns:

Will always throw a MandatoryParameterNotSetException

Throws:

MandatoryParameterNotSetException - this exception is thrown if this JAIN Mandatory Parameter has not been set.

Since:

JAIN TCAP v1.1

getDestinationAddress

public SccpUserAddress getDestinationAddress()
                                      throws MandatoryParameterNotSetException

Gets the Destination Address parameter of the Unidirectional indication primtive. Destination Address is an SCCP parameter that is required from the application. The return type of this get method has been changed from TcapUserAddress. The TcapUserAddress class has been deprecated in this release (V1.1). This method has not been deprecated as it's replacement would then have to have a different name.

Returns:

the SCCP User Address representing the Destination Address of the Unidirectional indication primtive.

Throws:

MandatoryParameterNotSetException - this exception is thrown if this JAIN Mandatory parameter has not been set

getOriginatingAddress

public SccpUserAddress getOriginatingAddress()
                                      throws MandatoryParameterNotSetException

Gets the Originating Address parameter of the Unidirectional indication primitive. Origination Address is an SCCP parameter that is required from the application. The return type of this get method has been changed from TcapUserAddress. The TcapUserAddress class has been deprecated in this release (V1.1). This method has not been deprecated as it's replacement would then have to have a different name.

Returns:

the SCCP User Address represnting the Originating Address of the UnidirectionalEvent.

Throws:

MandatoryParameterNotSetException - this exception is thrown if this JAIN Mandatory parameter has not been set

isQualityOfServicePresent

public boolean isQualityOfServicePresent()

Indicates if the Quality of Service parameter is present in this Event.

Returns:

true if Quality of Service has been set, false otherwise.

getQualityOfService

public byte getQualityOfService()
                         throws ParameterNotSetException

Gets the Quality of Service parameter of the unidirectional indication primitive. Quality of Service is an SCCP parameter that is required from the application.

Returns:

the Quality of Service parameter of the UnidirectionalEvent

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not been set

isComponentsPresent

public boolean isComponentsPresent()

Returns the Components present flag of this Unidirectional indication primitive. This flag is used to determine if their are any components associated with this primitive. This flag will be reset to false when the clearAllParameters() method is invoked.

Returns:

true if Components are present in this UnidirectionalEvent, false is no Components are present in this UnidirectionalEvent.

getPrimitiveType

public int getPrimitiveType()

This method returns the type of this primitive.

Overrides:

getPrimitiveType in class DialogueIndEvent

Returns:

The Primitive Type of this event

clearAllParameters

public void clearAllParameters()

Clears all previously set parameters and resets the 'Components Present' flag to false.

toString

public java.lang.String toString()

String representation of class UnidirectionalIndEvent

Overrides:

toString in class DialogueIndEvent

Returns:

String provides description of class UnidirectionalIndEvent