jain.protocol.ss7.tcap
Class ComponentReqEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:

ErrorReqEvent, InvokeReqEvent, RejectReqEvent, ResultReqEvent, TimerResetReqEvent, UserCancelReqEvent

public abstract class ComponentReqEvent

extends java.util.EventObject

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

A ComponentReqEvent is the superclass of all Component request primitives, which represent TCAP Component requests sent from a JainTcapListener to a JainTcapProvider . 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 sendComponentReqEvent() method of the JainTcapProvider . This class implements the java.lang.Cloneable interface, therefore all Component Request 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 Component Request Event.
protected boolean	m_dialogueIdPresent
protected int	m_invokeId The Invoke Id parameter for ITU and ANSI for an INVOKE component.
protected boolean	m_invokeIdPresent

Fields inherited from class java.util.EventObject

source

Constructor Summary

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

Method Summary

int	getDialogueId() Gets the Dialogue Id parameter of the Component Request Event, which is a reference identifier which identifies a specific dialogue or transaction and all associated components within that dialogue or transaction.
int	getInvokeId() Gets the Invoke Id parameter of the request component.
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 Request primitive.
void	setDialogueId(int dialogueId) Sets the Dialogue Id parameter of this Component Request Event.
void	setInvokeId(int invokeId) Sets the Invoke Id parameter of the request component.
void	setSource(java.lang.Object source) Sets the source of this event.
java.lang.String	toString() String representation of class jain.protocol.ss7.tcap.ComponentReqEvent

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 Component Request Event.

m_dialogueIdPresent

protected boolean m_dialogueIdPresent

m_invokeId

protected int m_invokeId

The Invoke Id parameter for 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_invokeIdPresent

protected boolean m_invokeIdPresent

Constructor Detail

ComponentReqEvent

public ComponentReqEvent(java.lang.Object source)

Constructs a new ComponentReqEvent.

Parameters:

source - the new source object 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

setDialogueId

public void setDialogueId(int dialogueId)

Sets the Dialogue Id parameter of this Component Request Event. Dialogue Id is a reference identifier, which identifies a specific dialogue or transaction and all associated components within that dialogue or transaction. Update v1.1 :- There is no isDialogueIdPresent method in this super class because the dialogueId parameter is mandatory in all children.

Parameters:

dialogueId - The new Dialogue Identifier

setInvokeId

public void setInvokeId(int invokeId)

Sets the Invoke Id parameter of the request component. 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.

Update v1.1 :- There is no isInvokeIdPresent method in this super class because not all children have an optional InvokeId, namely TimerReset and UserCancel.

Parameters:

invokeId - The new Invoke Identifier

getDialogueId

public int getDialogueId()
                  throws MandatoryParameterNotSetException

Gets the Dialogue Id parameter of the Component Request Event, 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 request event

Throws:

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

getInvokeId

public int getInvokeId()
                throws ParameterNotSetException

Gets the Invoke Id parameter of the request component. 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 Component Request event.

Throws:

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

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 Request primitive.

Returns:

The Primitive Type of the Event

toString

public java.lang.String toString()

String representation of class jain.protocol.ss7.tcap.ComponentReqEvent

Overrides:

toString in class java.util.EventObject

Returns:

String provides description of class ComponentReqEvent