oracle.ifs.beans

Class Queue

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.ApplicationObject

oracle.ifs.beans.TieApplicationObject

oracle.ifs.beans.Queue

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

Direct Known Subclasses:

TieQueue

public class Queue
extends TieApplicationObject

Queue class represent instances of Queues in iFS.

You need adimin privilege to create Queue instances. Queue class instances are used to represent instances of AQ in the system. Creation, deletion, and modifying the instances of this class do not affect the underlying AQ. AQ admin tools and api needs to be used to deal with AQ instances. Refer to AQ documentation for information about how to craete, delete, modify AQ instances.

Version:

1.0

Author:

Vijay Devadhar

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME This class name for this class.
static String	MESSAGEPROCESSORCLASSNAME_ATTRIBUTE The message processor of this Queue (e.g. oracle.ifs.adk.queue.IfsMessageProcessor)
static String	PAYLOADTYPE_ATTRIBUTE The payload of this Queue (e.g.
static String	TYPEMAP_ATTRIBUTE The type map of the queue.
static String	UNIQUENAME_ATTRIBUTE The name of this Queue (e.g.

Fields inherited from class oracle.ifs.beans.PublicObject

ACL_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MARKED, FLAG_NOINFERIOR, FLAG_NOSELECT, FLAG_NTFS_ARCHIVE, FLAG_NTFS_HIDDEN, FLAG_NTFS_READONLY, FLAG_NTFS_SYSTEM, FLAG_UNMARKED, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKENTRIES_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PRIMARYPARENTFOLDER_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Queue(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a Queue object - standard variant.

Method Summary

Modifier and Type	Method and Description
protected static Queue	constructQueue(LibrarySession sess, S_LibraryObjectData data) constructQueue FixmeJavadocMethod
protected static Vector	constructQueueVector(LibrarySession sess, Vector vector) constructQueueVector - FixmeJavadocMethod
oracle.sql.ORAData	dequeue(String subscriberName) Dequeues a message.
oracle.sql.ORAData	dequeueFromExceptionQueue() Dequeues a message from the default exception queue.
void	enqueue(oracle.sql.ORAData message) Enqueues a message.
void	enqueue(oracle.sql.ORAData message, String correlation) Enqueues a message.
static Queue[]	findAll(LibrarySession session) Returns the set of defined Queues.
static Queue	findByName(LibrarySession session, String name) Returns the a Queue matching the specified name.
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySession session) Returns the LibraryObjectLookupCache used by find Queue instances by uniquename.
String	getMessageProcessorClassName() Returns the name of message processor class of the queue instance.
String	getPayloadType() Returns the payload type of the queue instance.
PropertyBundle	getTypeMap() Returns the PropertyBundle used by this Queue to map message types.
void	setMessageProcessorClassName(String messageProcessorClassName) Sets the meaasge processor class of the Queue instance.
void	setPayloadType(String payloadType) Sets the payload type of the Queue instance.
protected static Queue	vectorQueueElement(Vector vector, int index) Returns a Queue from a vector of Queues
protected static Queue[]	vectorToQueueArray(Vector vector) Constructs an array of Queue's from a vector of Queues

Methods inherited from class oracle.ifs.beans.ApplicationObject

auditPublicObjectLocked, auditPublicObjectUnlocked, auditUpdated, constructApplicationObject, constructApplicationObjectVector, isValidEventType, postCreate, preFree, reportApplicationObjectCreated, reportApplicationObjectFreed

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, capabilities, checkAuditViewCapability, checkCapabilities, checkCapability, checkEffectiveAccess, checkEffectiveAccess, checkLockAccess, checkParentFolderCapability, checkVersioned, clearFlags, constructPublicObject, constructPublicObjectArray, constructPublicObjectVector, containsLockEntry, copy, coreAutoFolderingEnabled, createCategories, createDedicatedPolicyPropertyBundle, delete, deriveEffectiveAccessLevel, findAttachmentRelation, findOrAddActivityRecord, findOrAddActivityRecord, findOrAddActor, findOrAddActor, findOrAddMessageList, findOrAddMessageList, free, getAcl, getActivityRecord, getActor, getAllFolderPaths, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getAnyFolderPath, getAttachmentRelation, getAttachmentRelations, getAttachments, getCapabilities, getCategories, getCategories, getCategories, getCategories, getCategories, getCategory, getConsumedStorage, getCreateDate, getCreator, getDefaultAccessLevel, getDefinitionForSimplePropertyUpdates, getDeletor, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFirstCategory, getFirstVersion, getFlags, getFolderReferences, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLastVersion, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLeftwardRelationshipsCount, getLeftwardRelationshipsCount, getLinks, getLockEntries, getLockEntries, getLockObject, getLockRestrictions, getLockTypeAuditProperties, getMessageList, getNextVersion, getOwner, getPolicyBundle, getPolicyLists, getPreviousVersion, getPrimaryFolderPath, getPrimaryParentFolder, getPrimaryParentFolder, getRelations, getReservationComment, getReservationDate, getReservor, getResolvedPublicObject, getRestrictingLockEntries, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, getSingletonVersionDescription, getVersionNumber, getVersions, getVersionSeries, getWorkingCopy, grantAccess, handleCopy, handleCreate, handleUnlockAll, hasActivityRecord, hasActor, hasAttachmentRelation, hasCategories, hasCategory, hasConfigurationCategories, hasMessageList, hasNameAttribute, hasPropertyBundleAttribute, isAttachment, isDeleted, isLatestVersion, isLocked, isLockingSupported, isOwner, isReserved, isReservedByCurrentUser, isVersionable, isVersioned, isWorkingCopy, listLeftwardRelationships, listRightwardRelationships, lock, lock, lock, lock, newVersion, postCopy, postSecurityChangedEvent, postUpdate, preCopy, preCreate, preUpdate, putPolicy, reassociateLinks, removeAllPolicies, removeAttachment, removePolicy, removePolicy, removeRelationship, reserveNext, resetFolderReferences, resolveFolderReferenceSortSpecification, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setLockEntries, setLockEntrySecurity, setOwner, setOwnerByName, setPolicyBundle, setPolicyLists, setSecuringPublicObject, toPublicObjectArray, undelete, unlock, unlock, unlockAll, unReserve, updateFlags, updateLock, vectorPublicObjectElement, vectorToPublicObjectArray, verifyAddRelationshipCapability, verifyCapabilities, verifyCapability, verifyDeleteCapability, verifyLockCapability, verifyRemoveRelationshipCapability, verifyUnlockCapability, verifyVersionSeries

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

This class name for this class. Useful for methods that take a class name argument.

See Also:

Constant Field Values

(Published)

UNIQUENAME_ATTRIBUTE

public static final String UNIQUENAME_ATTRIBUTE

The name of this Queue (e.g. IFS_IN).

See Also:

Constant Field Values

(Published)

PAYLOADTYPE_ATTRIBUTE

public static final String PAYLOADTYPE_ATTRIBUTE

The payload of this Queue (e.g. IfsQueueMessage).

See Also:

Constant Field Values

(Published)

MESSAGEPROCESSORCLASSNAME_ATTRIBUTE

public static final String MESSAGEPROCESSORCLASSNAME_ATTRIBUTE

The message processor of this Queue (e.g. oracle.ifs.adk.queue.IfsMessageProcessor)

See Also:

Constant Field Values

(Published)

TYPEMAP_ATTRIBUTE

public static final String TYPEMAP_ATTRIBUTE

The type map of the queue. This attribute holds on to mapping between orcale object type names used to represent the queue payload and their equivalent java classes.

See Also:

Constant Field Values

(Published)

Constructor Detail

Queue

protected Queue(LibrarySession session,
                Long id,
                Long classId,
                S_LibraryObjectData data)
         throws IfsException

Construct a Queue object - standard variant.

Parameters:

session - current LibSession

id - the object ID

classId - int array version of the object ID

data - the object's data

Throws:

IfsException - if operation fails.

(Unpublished)

Method Detail

getPayloadType

public String getPayloadType()
                      throws IfsException

Returns the payload type of the queue instance. This is the name of the Oracle object type, that is used to represent message payloads on this queue.

Returns:

the payload type of the Queue.

Throws:

IfsException - on failure

(Published)

setPayloadType

public void setPayloadType(String payloadType)
                    throws IfsException

Sets the payload type of the Queue instance. This is the name of the Oracle object type, that is used to represent message payloads on this queue.

Parameters:

payloadType - payload type of the queue instance

Throws:

IfsException - on failure

(Published)

getMessageProcessorClassName

public String getMessageProcessorClassName()
                                    throws IfsException

Returns the name of message processor class of the queue instance. This is the fully qualified name of the java class that is used to process the messages arriving on the queue. This class should implement oracle.ifs.adk.queue.MessageProcessorInterface.

Returns:

the name of the message processor of the Queue.

Throws:

IfsException - on failure

(Published)

setMessageProcessorClassName

public void setMessageProcessorClassName(String messageProcessorClassName)
                                  throws IfsException

Sets the meaasge processor class of the Queue instance. This is the fully qualified name of the java class that is used to process the messages arriving on the queue. This class should implement oracle.ifs.adk.queue.MessageProcessorInterface.

Parameters:

messageProcessorClassName - name of the message processor class

Throws:

IfsException - on failure

(Published)

getTypeMap

public PropertyBundle getTypeMap()
                          throws IfsException

Returns the PropertyBundle used by this Queue to map message types.

Returns:

the Type map PropertyBundle for the object

Throws:

IfsException - if the operation fails

(Published)

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySession session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find Queue instances by uniquename.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

public static Queue[] findAll(LibrarySession session)
                       throws IfsException

Returns the set of defined Queues.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of Queues; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

public static Queue findByName(LibrarySession session,
                               String name)
                        throws IfsException

Returns the a Queue matching the specified name.

Queue names are case insensitive.

Parameters:

session - the session context

name - the Queue name

Returns:

the Queue matching the specified name; or null if there exists no matching Queue

Throws:

IfsException - if the operation fails.

enqueue

public void enqueue(oracle.sql.ORAData message)
             throws IfsException

Enqueues a message. Message is an instance of a class the implements the ORAData interface. The class of object being enqueued should match the payload type of the queue. Otherwise, this method will throw an exception.

Parameters:

message - message to be enqueued

Throws:

IfsException - if the operation fails

(Published)

enqueue

public void enqueue(oracle.sql.ORAData message,
                    String correlation)
             throws IfsException

Enqueues a message. Message is an instance of a class the implements the ORAData interface. The class of object being enqueued should match the payload type of the queue. Otherwise, this method will throw an exception. The correlation string is attached to the message being enqueued.

Parameters:

message - message to be enqueued

correlation - correlation for the message

Throws:

IfsException - if the operation fails

(Published)

dequeue

public oracle.sql.ORAData dequeue(String subscriberName)
                           throws IfsException

Dequeues a message. Returns an object, whose class implements the ORAData interface. The class of this object matches the payload type of the queue. The subscriber name being passed here should be setup as a subscriber on the queue. The subscriber names do not correpond to 9iFS user names or datbase user names. They are arbitrary names used to identify a subscriber in AQ. Refer to AQ documentation for details.

If a transaction that contained the call to this method is rolled back for any reason, RETRY_COUNT parameter of the message is incremented. Such a message will become available for dequeue after a period specified by the RETRY_DELAY parameter of the underlying AQ instance. Repeated rollbacks can cause the value of message's RETRY_COUNT property to go higher than the MAX_RETRY_COUNT property of the AQ instance. At that point, the message cannot be dequeued anymore and is moved to the exception queue. Use dequeueMessageFromExceptionQueue() method to get messages from an exception queue.

Parameters:

subscriberName - subscriber dequeueing the message

Returns:

message instance of a message if there is message on the queue; null otherwise

Throws:

IfsException - if the operation fails

(Published)

dequeueFromExceptionQueue

public oracle.sql.ORAData dequeueFromExceptionQueue()
                                             throws IfsException

Dequeues a message from the default exception queue. Since AQ does not let regular subscribers dequeue messages from an exception queue, there is no subscriber parameter for this method. Administration mode is required for dequeue of messages from an exception queue.

This method queries the database to find the queue table name of the regular queue and then constructs the name of the exception queue. The name of the default exception queue is has the pattern AQ$_<Queue_Table_Name>_E, where <Queue_Table_Name> is the queue table for the regular queue.

If you rollback a transaction that contained a call to this method, then the message will simply be put back on the exception queue. The number of attempts to dequeue a message from an exception is not bound by the MAX_RETRY_COUNT.

Returns:

message instance of a message if there is message on the queue; null otherwise

Throws:

IfsException - if the operation fails

(Published)

constructQueueVector

protected static Vector constructQueueVector(LibrarySession sess,
                                             Vector vector)
                                      throws IfsException

constructQueueVector - FixmeJavadocMethod

Parameters:

sess - FixmeJavadocParam

vector - FixmeJavadocParam

Returns:

new_vector FixmeJavadocReturn

Throws:

IfsException - if operation fails.

(Unpublished)

constructQueue

protected static Queue constructQueue(LibrarySession sess,
                                      S_LibraryObjectData data)
                               throws IfsException

constructQueue FixmeJavadocMethod

Parameters:

sess - FixmeJavadocParam

data - FixmeJavadocParam

Returns:

Queue FixmeJavadocReturn

Throws:

IfsException - if operation fails.

(Unpublished)

vectorToQueueArray

protected static Queue[] vectorToQueueArray(Vector vector)

Constructs an array of Queue's from a vector of Queues

Parameters:

vector - FixmeJavadocParam

Returns:

objs FixmeJavadocReturn

(Unpublished)

vectorQueueElement

protected static Queue vectorQueueElement(Vector vector,
                                          int index)

Returns a Queue from a vector of Queues

Parameters:

vector - FixmeJavadocParam

index - FixmeJavadocParam

Returns:

obj FixmeJavadocReturn

(Unpublished)