oracle.jms
Class AQjmsDestination

java.lang.Object
  |
  +--oracle.jms.AQjmsDestination

All Implemented Interfaces:

Destination, Queue, javax.naming.Referenceable, java.io.Serializable, TemporaryQueue, TemporaryTopic, Topic

public class AQjmsDestination

extends java.lang.Object

implements Queue, Topic, javax.naming.Referenceable, java.io.Serializable, TemporaryQueue, TemporaryTopic

Oracle class implementing javax.jms.Queue, javax.jms.Topic, javax.naming.Referenceable, java.io.Serializable,

See Also:

Serialized Form

getQueueName

public java.lang.String getQueueName()
                              throws JMSException

Get the name of the queue

Specified by:

getQueueName in interface Queue

Returns:

the name of the queue

Throws:

JMSException - if the queue is not a single consumer queue

getTopicName

public java.lang.String getTopicName()
                              throws JMSException

Get the name of the Topic

Specified by:

getTopicName in interface Topic

Returns:

the name of the topic

Throws:

JMSException - if the queue is not a multi consumer queue (topic)

getQueueOwner

public java.lang.String getQueueOwner()
                               throws JMSException

Get the owner of the queue

Returns:

the schema of the queue

Throws:

JMSException - if the schema could not be retrieved

getTopicOwner

public java.lang.String getTopicOwner()
                               throws JMSException

Get the schema of the topic

Returns:

the schema of the topic

Throws:

JMSException - if the schema could not be retrieved

getReference

public javax.naming.Reference getReference()

Specified by:

getReference in interface javax.naming.Referenceable

getCompleteName

public java.lang.String getCompleteName()

Get the complete name of the queue/topic, of the form, [schema].name

Returns:

the complete name of the queue/topic

getCompleteTableName

public java.lang.String getCompleteTableName()

Get the complete name of the queue table of the queue/topic of the form, [schema].name

Returns:

the complete name of the queue/topic's queue table

toString

public java.lang.String toString()

Get the queue/topic as a string, of the form [schema].name

Specified by:

toString in interface Queue

Overrides:

toString in class java.lang.Object

Returns:

the queue/topic as a string

start

public void start(javax.jms.Session session,
                  boolean enqueue,
                  boolean dequeue)
           throws JMSException

start the queue/topic for enqueue or dequeue or both

Parameters:

session - the jms session

enqueue - whether enqueue should be enabled

dequeue - whether dequeue should be enabled

Throws:

JMSException - if failed to start the queue/topic

start

public void start(javax.jms.Session session,
                  boolean enqueue,
                  boolean dequeue,
                  boolean autonomous)
           throws JMSException

JMSException

stop

public void stop(javax.jms.Session session,
                 boolean enqueue,
                 boolean dequeue,
                 boolean wait)
          throws JMSException

stop the queue/topic for enqueue or dequeue or both

Parameters:

session - the jms session

enqueue - whether enqueue should be disabled

dequeue - whether dequeue should be disabled

wait - whether to wait for pending transactions on the queue/topic to complete

Throws:

JMSException - if failed to stop the queue/topic

stop

public void stop(javax.jms.Session session,
                 boolean enqueue,
                 boolean dequeue,
                 boolean wait,
                 boolean autonomous)
          throws JMSException

JMSException

alter

public void alter(javax.jms.Session session,
                  oracle.jms.AQjmsDestinationProperty dest_property)
           throws JMSException

alter the properties of the queue/topic

Parameters:

session - the jms session

dest_property - the new properties of the queue/topic

Throws:

JMSException - if the properties could not be altered

drop

public void drop(javax.jms.Session session)
          throws JMSException

drop the queue/topic

Parameters:

session - the jms session

Throws:

JMSException - if the queue/topic could not be dropped

schedulePropagation

public void schedulePropagation(javax.jms.Session session,
                                java.lang.String destination,
                                java.util.Date start_time,
                                java.lang.Double duration,
                                java.lang.String next_time,
                                java.lang.Double latency)
                         throws JMSException

Schedule propapagation from the topic for the given destination database

Parameters:

session - the JMS session

destination - the dblink of the remote database for which propagation is being scheduled. A null string means that propagation will be scheduled for all subscribers in the database of the topic

start_time - the time propagation must be started

duration - the duration of propagation

next_time - the next time propagation must be done

latency - the latency in seconds that can be tolerated latency is the difference between the time a message was enqueued and the time it was propagated

Throws:

JMSException - if propagation could not be scheduled

unschedulePropagation

public void unschedulePropagation(javax.jms.Session session,
                                  java.lang.String destination)
                           throws JMSException

Unschedule propapagation between the topic and the specified destination

Parameters:

session - the jms session

destination - the dblink of the destination database for which propagation must be unscheduled

Throws:

JMSException - if propagation oculd not be unscheduled

alterPropagationSchedule

public void alterPropagationSchedule(javax.jms.Session session,
                                     java.lang.String destination,
                                     java.lang.Double duration,
                                     java.lang.String next_time,
                                     java.lang.Double latency)
                              throws JMSException

alter propapagation schedule between the topic and the destination database

Parameters:

session - the jms session

destination - the dblink of the destination database

duration - the new duration

next_time - the new next_time for propagation

latency - the new latency

Throws:

JMSException - if the schedule could not be altered

enablePropagationSchedule

public void enablePropagationSchedule(javax.jms.Session session,
                                      java.lang.String destination)
                               throws JMSException

enable propapagation schedule

Parameters:

session - the JMS session

destination - the dblink of the destination database

Throws:

JMSException - if the propagation could not be enabled

disablePropagationSchedule

public void disablePropagationSchedule(javax.jms.Session session,
                                       java.lang.String destination)
                                throws JMSException

disable propapagation schedule

Parameters:

session - the jms session

destination - the dblink to the destination database

Throws:

JMSException - if the propagation schedule could not be disabled

grantQueuePrivilege

public void grantQueuePrivilege(javax.jms.Session session,
                                java.lang.String privilege,
                                java.lang.String grantee,
                                boolean grant_option)
                         throws JMSException

Grant enqueue or dequeue privilege on the queue to a database user

Parameters:

session - the jms session

privilege - the privilege (ENQUEUE or DEQUEUE)

grantee - the user being granted the privilege

grant_option - whether the grantee can grant the privilege to others

Throws:

JMSException - if the privilege could not be granted

grantTopicPrivilege

public void grantTopicPrivilege(javax.jms.Session session,
                                java.lang.String privilege,
                                java.lang.String grantee,
                                boolean grant_option)
                         throws JMSException

Grant a topic privilege

Parameters:

session - the jms session

privilege - the privilege (ENQUEUE or DEQUEUE) being granted

grantee - the database user being granted the privilege

grant_option - whether the grantee can grant the privilege to other users

Throws:

JMSException - if the privilege could not be granted

revokeQueuePrivilege

public void revokeQueuePrivilege(javax.jms.Session session,
                                 java.lang.String privilege,
                                 java.lang.String grantee)
                          throws JMSException

Revoke a queue privilege

Parameters:

session - the jms session

privilege - the privilege (ENQUEUE or DEQUEUE) being revoked

grantee - the database user from whom the privilege is being revoked

Throws:

JMSException - if the privilege could not be revoked

revokeTopicPrivilege

public void revokeTopicPrivilege(javax.jms.Session session,
                                 java.lang.String privilege,
                                 java.lang.String grantee)
                          throws JMSException

Revoke a topic privilege

Parameters:

session - the jms session

privilege - the privilege (ENQUEUE or DEQUEUE) being revoked

grantee - the database user from whom the privilege is being revoked

Throws:

JMSException - if the privilege could not be revoked

delete

public void delete()
            throws JMSException

Delete this temporary destination and make it unusable for further operations.

Specified by:

delete in interface TemporaryQueue

Throws:

JMSException - if the JMS provider fails to delete the temporary queue due to some internal error.