Package com.softwaremining.cics.queue

Class TSQueueManager

java.lang.Object

com.softwaremining.cics.queue.TSQueueManager

Direct Known Subclasses:

QueueManager

public class TSQueueManager
extends Object

TSQueueManager class - Provides functionality equivalent to to CICS TSQ.
by default the system uses com.softwaremining.cics.queue.TSQImpl
You can override this by setting the following in softwaremining.properties:
TSQ_IMPL=com.mycompany.MyTsQueueImplementation
This HAS TO implement the interface
com.softwaremining.cics.queue.TSQInterface

Field Summary

Fields

Modifier and Type	Field	Description
static final int	STORAGE_TYPE_AUXILARY
static int	STORAGE_TYPE_DEFAULT
static final int	STORAGE_TYPE_MAIN	MAIN storage is set only during WRITEQ ...
static final int	TYPE_TEMPORARY_STORAGE	TS Type storage CICS Stores the data in Virtual Memory or VSAM files.
static final int	TYPE_TRANSIENT_STORAGE	(TD) Transient-Data Intrapartition storage...
static final int	TYPE_TRANSIENT_STORAGE_EXTRAPARTITION	(TD) Transient-Data - ExtraPartition TD Storage Extrapartition destinations are stored in QSAM in CICS (on disk or tape or printer).

Constructor Summary

Constructors

Constructor	Description
TSQueueManager()

Method Summary

Modifier and Type	Method	Description
static void	assignDefaultStorageTypeIsMain(boolean defaultIsMain)	Allows changing default storage types associated with TS Queues from MAIN (written to memory), to AUXILARY (written to Database).
static IQueueStorage	getQueue(ICicsBaseService service, String queueName, boolean createIfNotFound)	Queue Factory ...
static IQueueStorage	getQueue(ICicsBaseService service, String queueName, boolean createIfNotFound, int queueType, int storageType)	Queue Factory ...
static IQueueStorage	getQueue(ICicsBaseService service, String queueName, boolean createIfNotFound, ISMObject responseField)	Queue Factory ...
static IQueueStorage	getQueue(ICicsBaseService service, String queueName, boolean createIfNotFound, ISMObject responseField, int queueType)	Queue Factory ...
static IQueueStorage	getQueue(ICicsBaseService service, String queueName, boolean createIfNotFound, ISMObject responseField, int queueType, int storageType)	Queue Factory ...

Methods inherited from class java.lang.Object

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

Field Details

TYPE_TEMPORARY_STORAGE

public static final int TYPE_TEMPORARY_STORAGE

TS Type storage CICS Stores the data in Virtual Memory or VSAM files. Very efficient.

See Also:

• Constant Field Values

TYPE_TRANSIENT_STORAGE

public static final int TYPE_TRANSIENT_STORAGE

(TD) Transient-Data Intrapartition storage... most widely used in CICS. All intrapartition destinations are stored in a VSAM file called DFHNTRA

See Also:

• Constant Field Values

TYPE_TRANSIENT_STORAGE_EXTRAPARTITION

public static final int TYPE_TRANSIENT_STORAGE_EXTRAPARTITION

(TD) Transient-Data - ExtraPartition TD Storage Extrapartition destinations are stored in QSAM in CICS (on disk or tape or printer). In cics this is relatively inefficient and not used too often.

See Also:

• Constant Field Values

STORAGE_TYPE_MAIN

public static final int STORAGE_TYPE_MAIN

MAIN storage is set only during WRITEQ ... WRITEQ ... [MAIN|AUXILARY]

See Also:

• Constant Field Values

STORAGE_TYPE_AUXILARY

public static final int STORAGE_TYPE_AUXILARY

See Also:

• Constant Field Values

STORAGE_TYPE_DEFAULT

public static int STORAGE_TYPE_DEFAULT

Constructor Details

TSQueueManager

public TSQueueManager()

Method Details

getQueue

public static IQueueStorage getQueue(ICicsBaseService service,
 String queueName,
 boolean createIfNotFound)

Queue Factory ... Get a persistent or memory queue in TSQ Functionality. QueueType defaults to TEMPORARY_STORAGE, StorageType defaults to MAIN (i.e. memory)

Parameters:

service - ... program who makes the call.

queueName - .. name of the queue

createIfNotFound - . When set to FALSE Throws Exceptions when no queue with this name is found. When set to True, it creates a new queue if none found

getQueue

public static IQueueStorage getQueue(ICicsBaseService service,
 String queueName,
 boolean createIfNotFound,
 ISMObject responseField)

Queue Factory ... Get a persistent or memory queue in TSQ Functionality. QueueType defaults to TEMPORARY_STORAGE, StorageType defaults to MAIN (i.e. memory)

Parameters:

service - ... program who makes the call.

queueName - .. name of the queue

createIfNotFound - . When set to FALSE Throws Exceptions when no queue with this name is found. When set to True, it creates a new queue if none found

responseField - ... errors are indicated using ResponseCode field rather than Exception thrown. When NULL, and there is problems, then the "service" condition handler is also invoked.

Returns:

getQueue

public static IQueueStorage getQueue(ICicsBaseService service,
 String queueName,
 boolean createIfNotFound,
 ISMObject responseField,
 int queueType)

Queue Factory ... Get a persistent or memory queue in TSQ Functionality. StorageType defaults to MAIN (i.e. memory)

Parameters:

service - ... program who makes the call.

queueName - .. name of the queue

createIfNotFound - . When set to FALSE Throws Exceptions when no queue with this name is found. When set to True, it creates a new queue if none found

responseField - ... errors are indicated using ResponseCode field rather than Exception thrown. When NULL, and there is problems, then the "service" condition handler is also invoked.

queueType - : TYPE_TEMPORARY_STORAGE (TS), or TYPE_TRANSIENT_STORAGE (TD)

Returns:

getQueue

public static IQueueStorage getQueue(ICicsBaseService service,
 String queueName,
 boolean createIfNotFound,
 ISMObject responseField,
 int queueType,
 int storageType)

Queue Factory ... Get a persistent or memory queue in TSQ Functionality. StorageType defaults to MAIN (i.e. memory)

Parameters:

service - ... program who makes the call.

queueName - .. name of the queue

createIfNotFound - . When set to FALSE Throws Exceptions when no queue with this name is found. When set to True, it creates a new queue if none found

responseField - ... errors are indicated using ResponseCode field rather than Exception thrown. When NULL, and there is problems, then the "service" condition handler is also invoked.

queueType - : TYPE_TEMPORARY_STORAGE (TS), or TYPE_TRANSIENT_STORAGE (TD)

StorageType - ... MAIN (for MemoeryQueue), AUXILARY/DEFAULT (Persistent)

Returns:

getQueue

public static IQueueStorage getQueue(ICicsBaseService service,
 String queueName,
 boolean createIfNotFound,
 int queueType,
 int storageType)

Queue Factory ... Get a persistent or memory queue in TSQ Functionality.

Parameters:

service - ... program who makes the call.

queueName - .. name of the queue

createIfNotFound - . When set to FALSE Throws Exceptions when no queue with this name is found. When set to True, it creates a new queue if none found

queueType - : TYPE_TEMPORARY_STORAGE (TS), or TYPE_TRANSIENT_STORAGE (TD)

responseField - ... errors are indicated using ResponseCode field rather than Exception thrown. When NULL, and there is problems, then the "service" condition handler is also invoked.

StorageType - ... MAIN (for MemoeryQueue), AUXILARY/DEFAULT (Persistent)

Returns:

IQueueStorage

assignDefaultStorageTypeIsMain

public static void assignDefaultStorageTypeIsMain(boolean defaultIsMain)

Allows changing default storage types associated with TS Queues from MAIN (written to memory), to AUXILARY (written to Database).

Parameters:

defaultIsMain -