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:

IfsEventHandler, LibraryObjectInterface, 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.

Field Summary

static java.lang.String	CLASS_NAME This class name for this class.
static java.lang.String	MESSAGEPROCESSORCLASSNAME_ATTRIBUTE The message processor of this Queue (e.g.
static java.lang.String	PAYLOADTYPE_ATTRIBUTE The payload of this Queue (e.g.
static java.lang.String	TYPEMAP_ATTRIBUTE The type map of the queue.
static java.lang.String	UNIQUENAME_ATTRIBUTE The name of this Queue (e.g.

Fields inherited from class oracle.ifs.beans.PublicObject

ACL_ATTRIBUTE, ADMINISTRATIONGROUP_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKEDFORSESSION_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, LOCKSTATE_ATTRIBUTE, LOCKSTATE_HARDLOCK, LOCKSTATE_SESSIONLOCK, LOCKSTATE_SOFTLOCK, LOCKSTATE_UNLOCK, LOCKSTATE_USERLOCK, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE

Method Summary

oracle.sql.ORAData	dequeue(java.lang.String subscriberName) Dequeues a message.
void	enqueue(oracle.sql.ORAData message) Enqueues a message.
java.lang.String	getMessageProcessorClassName() Returns the name of message processor class of the queue instance.
java.lang.String	getPayloadType() Returns the payload type of the queue instance.
void	setMessageProcessorClassName(java.lang.String messageProcessorClassName) Sets the meaasge processor class of the Queue instance.
void	setPayloadType(java.lang.String payloadType) Sets the payload type of the Queue instance.

Methods inherited from class oracle.ifs.beans.PublicObject

addCategory, addRelationship, checkEffectiveAccess, checkEffectiveAccess, copy, getAcl, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getCategories, getCategories, getCategories, getCategories, getCreateDate, getCreator, getDefaultAccessLevel, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFlags, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLockObject, getLockState, getLockStateLabel, getOwner, getPolicyBundle, getPropertyBundle, getResolvedPublicObject, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, grantAccess, handleEvent, hasNameAttribute, isLocked, isLockedForSession, isLockedForSessionByCurrentSession, isVersionable, isVersioned, lock, lock, lock, putPolicy, putProperty, putProperty, removeAllPolicies, removeAllProperties, removePolicy, removePolicy, removeProperty, removeRelationship, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setOwner, setPolicyBundle, setPropertyBundle, setSecuringPublicObject, toLockStateLabel, toLockStateLabel, toLockStateLabel, unlock, updateLock

Methods inherited from class oracle.ifs.beans.LibraryObject

equals, free, free, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getClassId, getClassObject, getDefinition, getId, getLabel, getName, getSession, invokeServerMethod, isInstanceOf, isTraced, lookupInstanceLabel, postEvent, postEvent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setName, toString, trace, update

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getId

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final java.lang.String CLASS_NAME

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

UNIQUENAME_ATTRIBUTE

public static final java.lang.String UNIQUENAME_ATTRIBUTE

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

PAYLOADTYPE_ATTRIBUTE

public static final java.lang.String PAYLOADTYPE_ATTRIBUTE

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

MESSAGEPROCESSORCLASSNAME_ATTRIBUTE

public static final java.lang.String MESSAGEPROCESSORCLASSNAME_ATTRIBUTE

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

TYPEMAP_ATTRIBUTE

public static final java.lang.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.

Method Detail

getPayloadType

public java.lang.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

setPayloadType

public void setPayloadType(java.lang.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:

payload - payload type of the queue instance

Throws:

IfsException - on failure

getMessageProcessorClassName

public java.lang.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

See Also:

oracle.ifs.adk.MessageProcessorInterface, oracle.ifs.adk.IfsMessageProcessor

setMessageProcessorClassName

public void setMessageProcessorClassName(java.lang.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

See Also:

oracle.ifs.adk.MessageProcessorInterface, oracle.ifs.adk.IfsMessageProcessor

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

dequeue

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

Dequeues a message. Returns an object, whose classe implements the ORAData interface. This class of this object macthces 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.

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