test.tck.msgflow

Class MessageFlowHarness

java.lang.Object

TestCase

test.tck.TestHarness

test.tck.msgflow.MessageFlowHarness

Direct Known Subclasses:

ClientTransactionTest, DialogStateMachineTest, DialogTest, InviteClientTransactionsStateMachineTest, InviteServerTransactionsStateMachineTest, NonInviteClientTransactionsStateMachineTest, NonInviteServerTransactionsStateMachineTest, ServerTransactionTest, SipProviderTest, TransactionTimeoutEventTest

public class MessageFlowHarness
extends TestHarness

Title: TCK

Description: JAIN SIP 1.1 Technology Compatibility Kit

Version:

1.0

Author:

Emil Ivov Network Research Team, Louis Pasteur University, Strasbourg, France, Ivelin Ivanov

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	counter
protected test.tck.msgflow.SipEventCollector	eventCollector
protected static String	EXTENSION_HDR
protected static long	MESSAGES_ARRIVE_FOR
protected static int	RETRY_OBJECT_DELETES
protected static long	RETRY_OBJECT_DELETES_AFTER
protected ListeningPoint	riListeningPoint
protected SipProvider	riSipProvider
protected SipStack	riSipStack
protected static long	STACKS_SHUT_DOWN_FOR
protected static long	STACKS_START_FOR
protected ListeningPoint	tiListeningPoint
protected SipProvider	tiSipProvider
protected SipStack	tiSipStack
protected static long	TRANSACTION_TIMES_OUT_FOR

Fields inherited from class test.tck.TestHarness

ABORT_ON_FAIL, abortOnFail, console, IMPLEMENTATION_PATH, LOCAL_ADDRESS, LOG_FILE_NAME, logFileName, path, printWriter, riAddressFactory, riFactory, riHeaderFactory, riMessageFactory, testCounter, testResult, tiAddressFactory, tiFactory, tiHeaderFactory, tiMessageFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
	MessageFlowHarness(String name)
protected	MessageFlowHarness(String name, boolean autoDialog)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addStatus(HeaderFactory headerFactory, Request request)
protected void	addStatus(Request request, Response response)
protected Request	createRequest(String method, AddressFactory addressFactory, HeaderFactory headerFactory, MessageFactory messageFactory, SipProvider srcProvider, SipProvider dstProvider, String contentType, String contentSubType, Object content) Creates a SipRequest using the specified factories.
ContactHeader	createRiContact() Add a contact for the TI.
protected Request	createRiInviteRequest(String contentType, String contentSubType, Object content) Creates an invite request object using the RI.
protected Request	createRiRegisterRequest() Creates a register request object using the RI.
ContactHeader	createTiContact() Add a contact for the TI.
protected Request	createTiInviteRequest(String contentType, String contentSubType, Object content) Creates an invite request object using the TI.
protected Request	createTiRegisterRequest() Creates a register request object using the TI.
void	setUp() Initialises both RI and TI sip stacks and stack factories.
protected static void	sleep(long sleepFor) Waits during _no_less_ than sleepFor milliseconds.
void	tearDown() Sets all JAIN SIP objects to null and resets the SipFactory.
static void	waitForMessage() Waits during LISTEN_TIMEOUT milliseconds.
protected static void	waitForTimeout() Wait till a transaction times out.
static void	waitLongForMessage()
protected static void	waitShortForMessage() waits a good long time for messages.

Methods inherited from class test.tck.TestHarness

assertEquals, assertEquals, assertEquals, assertEquals, assertNotNull, assertNull, assertSame, assertTrue, assertTrue, checkImplementsInterface, fail, fail, fail, getImplementationPath, getRiProperties, getTiProperties, implementsInterface, logTestCompleted, logTestCompleted

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_HDR

protected static final String EXTENSION_HDR

See Also:

Constant Field Values

counter

protected static int counter

MESSAGES_ARRIVE_FOR

protected static long MESSAGES_ARRIVE_FOR

RETRY_OBJECT_DELETES

protected static int RETRY_OBJECT_DELETES

RETRY_OBJECT_DELETES_AFTER

protected static long RETRY_OBJECT_DELETES_AFTER

STACKS_START_FOR

protected static long STACKS_START_FOR

STACKS_SHUT_DOWN_FOR

protected static long STACKS_SHUT_DOWN_FOR

TRANSACTION_TIMES_OUT_FOR

protected static long TRANSACTION_TIMES_OUT_FOR

riListeningPoint

protected ListeningPoint riListeningPoint

tiListeningPoint

protected ListeningPoint tiListeningPoint

riSipProvider

protected SipProvider riSipProvider

tiSipProvider

protected SipProvider tiSipProvider

eventCollector

protected test.tck.msgflow.SipEventCollector eventCollector

riSipStack

protected SipStack riSipStack

tiSipStack

protected SipStack tiSipStack

Constructor Detail

MessageFlowHarness

public MessageFlowHarness(String name)

MessageFlowHarness

protected MessageFlowHarness(String name,
                  boolean autoDialog)

Method Detail

addStatus

protected void addStatus(HeaderFactory headerFactory,
             Request request)

addStatus

protected void addStatus(Request request,
             Response response)

setUp

public void setUp()
           throws Exception

Initialises both RI and TI sip stacks and stack factories.

Overrides:

setUp in class TestHarness

Throws:

Exception - All Let all exceptions that come from the underlying stack to pass through and surface at JUnit Level.

tearDown

public void tearDown()
              throws Exception

Sets all JAIN SIP objects to null and resets the SipFactory.

Overrides:

tearDown in class TestHarness

Throws:

Exception

createRequest

protected Request createRequest(String method,
                    AddressFactory addressFactory,
                    HeaderFactory headerFactory,
                    MessageFactory messageFactory,
                    SipProvider srcProvider,
                    SipProvider dstProvider,
                    String contentType,
                    String contentSubType,
                    Object content)
                         throws Exception

Creates a SipRequest using the specified factories. The request has the specified method and is meant to be sent from srcProvider to dstProvider. This method is prefered to manual creation of requests as it helps avoid using RI objects instead of corresponding TI objects (or vice versa).

Parameters:

method - the request's method

addressFactory - the address factory to use when creating addresses

headerFactory - the header factory to use when creating headers

messageFactory - the message factory to use when creating headers

srcProvider - the provider that will eventually be used to send the request

dstProvider - the provider that will eventually dispatch the request to a SipListener

contentType - if the content parameter is not null then this is its content type.

contentSubType - if the content parameter is not null then this is its sub content type.

content - the content of the request. if null this parameter is ignored

Returns:

a request generated by the specified factories and destined to go from srcProvider to dstProvider

Throws:

Exception - if anything should go wrong. further exception handling is left to calling methods (or JUnit).

createRiInviteRequest

protected Request createRiInviteRequest(String contentType,
                            String contentSubType,
                            Object content)
                                 throws TckInternalError

Creates an invite request object using the RI. This invite request is meant to be sent to the TI

Parameters:

contentType - if the content parameter is not null then this is its content type.

contentSubType - if the content parameter is not null then this is its content sub type.

content - if the request is to have any content then this parameter is used to set it. Th content parameter is to be left to null if the request won't have any content.

Returns:

an RI->TI invite request

Throws:

TckInternalError - if anything should gou wrong.

createTiInviteRequest

protected Request createTiInviteRequest(String contentType,
                            String contentSubType,
                            Object content)
                                 throws TiUnexpectedError

Creates an invite request object using the TI. This invite request is meant to be sent to the RI

Parameters:

contentType - if the content parameter is not null then this is its content type.

contentSubType - if the content parameter is not null then this is its content sub type.

content - if the request is to have any content then this parameter is used to set it. Th content parameter is to be left to null if the request won't have any content.

Returns:

an TI->RI invite request

Throws:

TiUnexpectedError - if anything should gou wrong.

createRiRegisterRequest

protected Request createRiRegisterRequest()
                                   throws TckInternalError

Creates a register request object using the RI. This register request is meant to be sent to the TI

Returns:

an RI->TI register request

Throws:

TckInternalError - if anything should gou wrong.

createTiRegisterRequest

protected Request createTiRegisterRequest()
                                   throws TiUnexpectedError

Creates a register request object using the TI. This register request is meant to be sent to the RI

Returns:

a TI->RI register request

Throws:

TiUnexpectedError - if anything should gou wrong.

waitLongForMessage

public static void waitLongForMessage()

waitForMessage

public static void waitForMessage()

Waits during LISTEN_TIMEOUT milliseconds. This method is called after a message has been sent so that it has the time to propagate though the sending and receiving stack

waitForTimeout

protected static void waitForTimeout()

Wait till a transaction times out.

waitShortForMessage

protected static void waitShortForMessage()

waits a good long time for messages.

sleep

protected static void sleep(long sleepFor)

Waits during _no_less_ than sleepFor milliseconds. Had to implement it on top of Thread.sleep() to guarantee minimum sleep time.

Parameters:

sleepFor - the number of miliseconds to wait

createTiContact

public ContactHeader createTiContact()
                              throws Exception

Add a contact for the TI.

Throws:

Exception

createRiContact

public ContactHeader createRiContact()
                              throws TckInternalError

Add a contact for the TI.

Throws:

TckInternalError