jain.protocol.ss7.tcap
Class ComponentIndEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.ComponentIndEvent

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:

ErrorIndEvent, InvokeIndEvent, LocalCancelIndEvent, RejectIndEvent, ResultIndEvent

public abstract class ComponentIndEvent

extends java.util.EventObject

implements java.io.Serializable, java.lang.Cloneable

A ComponentIndEvent is the super class of all Component Indication primitives, which represent TCAP Component Indications sent from a JainTcapProvider to a JainTcapListener . It affords a method of generic event passing, while enforcing tight control over event flow between the Listener and the Provider. This type of Event will be processed by the processComponentIndEvent method of the JainTcapListener . This class implements the java.lang.Cloneable interface, therefore all Component Indication primitives that extend this Event can be cloned using the clone() method inherited from java.lang.Object .

Version:

1.1

Author:

Sun Microsystems Inc.

See Also:

Serialized Form

Field Summary

protected int	m_dialogueId The Dialogue Id parameter of the indication component
protected boolean	m_dialogueIdPresent
protected int	m_invokeId The Invoke Id parameter in ITU and ANSI for an INVOKE component.
protected boolean	m_invokeIdPresent
protected boolean	m_lastComponent Indicates if this Indication Component is the last component of a transaction message.
protected boolean	m_lastComponentPresent

Fields inherited from class java.util.EventObject

source

Constructor Summary

ComponentIndEvent(java.lang.Object source)
Constructs a new ComponentIndEvent.

Method Summary

abstract int	getDialogueId() Gets the Dialogue Id parameter of the indication component, which is a reference identifier which identifies a specific dialogue or transaction and all associated components within that dialogue or transaction.
abstract int	getInvokeId() Gets the Invoke Id parameter of the component indication.
abstract int	getPrimitiveType() This abstract method defines the 'getPrimitiveType' method that must be implemented by its subclasses in order to return the type of that subclassed Component Indication primitive.
boolean	isInvokeIdPresent() Indicates if the Invoke Id is present in this Indication event.
boolean	isLastComponent() Indicates if this indication Component is the last component in a Transaction message i.e.
void	setDialogueId(int dialogueId) Sets the Dialogue Id parameter of this Component Indication Event.
void	setInvokeId(int invokeId) Sets the Invoke Id parameter of the indication component.
void	setLastComponent(boolean lastComponent) Sets this indication Component as the last component in a Transaction message for example BEGIN or CONTINUE.
void	setSource(java.lang.Object source) Sets the source of this event.
java.lang.String	toString() String representation of class ComponentIndEvent

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_dialogueId

protected int m_dialogueId

The Dialogue Id parameter of the indication component

m_invokeId

protected int m_invokeId

The Invoke Id parameter in ITU and ANSI for an INVOKE component.
The Invoke Id for ITU and Correlation Id for ANSI in the RESULT, REJECT and ERROR components.

m_lastComponent

protected boolean m_lastComponent

Indicates if this Indication Component is the last component of a transaction message.

m_invokeIdPresent

protected boolean m_invokeIdPresent

m_dialogueIdPresent

protected boolean m_dialogueIdPresent

m_lastComponentPresent

protected boolean m_lastComponentPresent

Constructor Detail

ComponentIndEvent

public ComponentIndEvent(java.lang.Object source)

Constructs a new ComponentIndEvent.

Parameters:

source - the new object source supplied to the constructor

Method Detail

setSource

public void setSource(java.lang.Object source)

Sets the source of this event. This method may be used to override the setting of the event source through the constructor, this provides the ability to clone the Event and change the Event source at any time.

Parameters:

source - The new Object Source value

setDialogueId

public void setDialogueId(int dialogueId)

Sets the Dialogue Id parameter of this Component Indication Event. Dialogue Id is a reference identifier, which identifies a specific dialogue or transaction and all associated components within that dialogue or transaction.

Parameters:

dialogueId - The new Dialogue Identifier

setInvokeId

public void setInvokeId(int invokeId)

Sets the Invoke Id parameter of the indication component. The mapping rules for the Invoke Identifier in each of the components in the Jain Tcap Api are as follows:-

• INVOKE Component :- The Invoke Identifier is the Invoke Identifier as specified in both the ITU and ANSI recommendations for the Invoke component.
• RESULT Component :- The Invoke Identifier is the Invoke Identifier as specified in the ITU recommendation and the Correlation Identifier as specified in the ANSI recommendation for the Result component.
• REJECT Component :- The Invoke Identifier is the Invoke Identifier as specified in the ITU recommendation and the Correlation Identifier as specified in the ANSI recommendation for the Reject component.
• ERROR Component :- The Invoke Identifier is the Invoke Identifier as specified in the ITU recommendation and the Correlation Identifier as specified in the ANSI recommendation for the Error component.

Parameters:

invokeId - The new Invoke Identifier

setLastComponent

public void setLastComponent(boolean lastComponent)

Sets this indication Component as the last component in a Transaction message for example BEGIN or CONTINUE.

Note to Developers:- This should not be confused with the lastInvokeEvent parameter in an INVOKE Component which is a flag for an ANSI implementation of the JAIN TCAP API to determine the type of component, either INVOKE_NL or INVOKE_L. For example in an ANSI INVOKE Indicaton the last component in the transaction message could be an INVOKE_NL, were an INVOKE_L will follow in the next message segment, therefore the lastComponent parameter is true, while the lastInvokeEvent is false.

By default this component will not be the last Component, that is the lastComponent is set to false by default.

Parameters:

lastComponent - The new LastComponent value

getDialogueId

public abstract int getDialogueId()
                           throws ParameterNotSetException,
                                  MandatoryParameterNotSetException

Gets the Dialogue Id parameter of the indication component, which is a reference identifier which identifies a specific dialogue or transaction and all associated components within that dialogue or transaction.

Returns:

the Dialogue Id of the Component indication

Throws:

ParameterNotSetException - this exception is thrown if this parameter is a JAIN optional parameter and has not yet been set. The Dialogue Id is JAIN Optional for the Invoke Indication .

MandatoryParameterNotSetException - this exception is thrown if the Dialogue Id is a JAIN mandatory parameter for the specific Component Indication. The Dialogue Id is JAIN Mandatory for all component indications except for the Invoke Indication .

isInvokeIdPresent

public boolean isInvokeIdPresent()

Indicates if the Invoke Id is present in this Indication event.

Returns:

true if Invoke Id has been set, false otherwise.

getInvokeId

public abstract int getInvokeId()
                         throws ParameterNotSetException,
                                MandatoryParameterNotSetException

Gets the Invoke Id parameter of the component indication. Invoke Id identifies the operation invocation and its result. The mapping rules for the Invoke Identifier in each of the components in the Jain Tcap Api are as follows:-

• INVOKE Component :- The Invoke Identifier is the Invoke Identifier as specified in both the ITU and ANSI recommendations for the Invoke component.
• RESULT Component :- The Invoke Identifier is the Invoke Identifier as specified in the ITU recommendation and the Correlation Identifier as specified in the ANSI recommendation for the Result component.
• REJECT Component :- The Invoke Identifier is the Invoke Identifier as specified in the ITU recommendation and the Correlation Identifier as specified in the ANSI recommendation for the Reject component.
• ERROR Component :- The Invoke Identifier is the Invoke Identifier as specified in the ITU recommendation and the Correlation Identifier as specified in the ANSI recommendation for the Error component.

Returns:

the Invoke Id of the Indication event.

Throws:

ParameterNotSetException - this exception is thrown if this is a JAIN Optional parameter in the specific component indication and has not been set.

MandatoryParameterNotSetException - if this is a JAIN Mandatory parameter in the specific component indication and has not been set.

isLastComponent

public boolean isLastComponent()

Indicates if this indication Component is the last component in a Transaction message i.e. BEGIN or CONTINUE.

Note to Developers:- This should not be confused with the lastInvokeEvent parameter in an INVOKE Component which is a flag for an ANSI implementation of the JAIN TCAP API to determine the type of component, either INVOKE_NL or INVOKE_L. For example in an ANSI INVOKE Indicaton the last component in the transaction message could be an INVOKE_NL, were an INVOKE_L will follow in the next message segment, therefore the lastComponent parameter is true, while the lastInvokeEvent is false.

By default the lastComponent parameter is set to false .

Returns:

true if this is the last component, false otherwise.

getPrimitiveType

public abstract int getPrimitiveType()

This abstract method defines the 'getPrimitiveType' method that must be implemented by its subclasses in order to return the type of that subclassed Component Indication primitive.

Returns:

The PrimitiveType value

toString

public java.lang.String toString()

String representation of class ComponentIndEvent

Overrides:

toString in class java.util.EventObject

Returns:

String provides description of class ComponentIndEvent