Extension SDK 9.0.5

oracle.jdeveloper.webservices
Class JAXRPCJmsModel

java.lang.Object
  extended byoracle.jdeveloper.webservices.JAXRPCSvcModel
      extended byoracle.jdeveloper.webservices.JAXRPCJmsModel

public class JAXRPCJmsModel
extends JAXRPCSvcModel

This class represents the data model for a web service that accesses JMS destinations. Interaction with the JAXRPCJavaModel is governed by the rules described in JAXRPCSvcModel.


Field Summary
static int BOTH
          Constant denoting send and receive are both available.
static int DEFAULT
          Constant denoting a default value.
static java.lang.String IS_REPLY_TO
          Property identifier.
static java.lang.String JMS_DELIVERY_MODE
          Property identifier.
static java.lang.String JMS_EXPIRATION
          Property identifier.
static java.lang.String JMS_PRIORITY
          Property identifier.
static java.lang.String JMS_TYPE
          Property identifier.
static int NEITHER
          Constant denoting no operations are available.
static int NONPERSISTENT
          Constant denoting non-persistent delivery mode.
static java.lang.String OPERATIONS
          Property identifier.
static java.lang.String PACKAGE
          Property identifier.
static int PERSISTENT
          Constant denoting persistent delivery mode.
static java.lang.String PRIMARY_CONNECTION_FACTORY
          Property identifier.
static java.lang.String PRIMARY_DESTINATION
          Property identifier.
static int QUEUE
          Constant denoting an object is related to a JMS queue.
static int RECEIVE
          Constant denoting receive operation is available.
static java.lang.String REPLY_TO_CONNECTION_FACTORY
          Property identifier.
static java.lang.String REPLY_TO_DESTINATION
          Property identifier.
static int SEND
          Constant denoting send operation is available.
static int TOPIC
          Constant denoting an object is related to a JMS topic.
 
Fields inherited from class oracle.jdeveloper.webservices.JAXRPCSvcModel
ALL_WRITEABLE, ENDPOINT, m_backup, m_modelRenameRequired, m_targetProject, PLATFORM_ALL_SERVERS, PLATFORM_APACHE_2X, PLATFORM_JAX_RPC, PLATFORM_ORACLE_IAS_20, PLATFORM_ORACLE_J2EE, TARGET_NAMESPACE, TYPE_JAVA, TYPE_JMS, TYPE_PLSQL, TYPE_UNKNOWN, URI, WEB_XML_URL, WSDL_URL
 
Constructor Summary
JAXRPCJmsModel()
          Default constructor.
JAXRPCJmsModel(boolean migratedService)
          Create a new web service model, allowing the creator to specify that it is being created to hold data being migrated from an older version of JDeveloper.
JAXRPCJmsModel(java.net.URI uri)
          Create a new web service with the supplied URI.
 
Method Summary
 void beginEdit()
          Make a copy of this model and store it internally, ready for updates that can be applied or undone.
 java.net.URI deriveTargetNamespace()
          Derive a model-specific default target namespace URI for the service.
 java.net.URL deriveWSDLFileLocation()
          Derive a location for a WSDL file for this service.
 int getAvailableOperations()
           
 int getJMSDeliveryMode()
           
 long getJMSExpiration()
           
 int getJMSPriority()
           
 java.lang.String getJMSType()
           
 java.net.URL getModelLocation()
          Determine what the location of the persisted model will be after generation.
 java.lang.String getPackage()
           
 java.lang.String getPrimaryConnectionFactory()
           
 java.lang.String getPrimaryDestination()
           
 int getPrimaryDestinationType()
           
 java.lang.String getReplyToConnectionFactory()
           
 java.lang.String getReplyToDestination()
           
 int getReplyToDestinationType()
           
 URLPath getTargetDirectories()
          Work out all of the directories that will be touched by the JAX-RPC assembler in creating the service.
 int getType()
           
protected  boolean invokeWizardInternal(oracle.bali.ewt.wizard.BaseWizard baseWizard, boolean showProgressBar, boolean openFiles, java.awt.Component dialogParent)
          Invoke a wizard to edit this data model.
 boolean isReplyTo()
           
 void setAvailableOperations(int availableOperations)
           
 void setJMSDeliveryMode(int jmsDeliveryMode)
           
 void setJMSExpiration(long jmsExpiration)
           
 void setJMSPriority(int jmsPriority)
           
 void setJMSType(java.lang.String jmsType)
           
 void setPackage(java.lang.String pkg)
           
 void setPrimaryConnectionFactory(java.lang.String primaryConnectionFactory)
           
 void setPrimaryDestination(java.lang.String primaryDestination)
           
 void setPrimaryDestinationType(int primaryDestinationType)
           
 void setReplyTo(boolean isReplyTo)
           
 void setReplyToConnectionFactory(java.lang.String replyToConnectionFactory)
           
 void setReplyToDestination(java.lang.String replyToDestination)
           
 void setReplyToDestinationType(int replyToDestinationType)
           
 void undoEdit()
          Restore the state of the model to what it was when beginEdit was called.
 void validate(java.lang.String[] properties)
          Validate all of the properties whose identifiers have been supplied in the String array.
 
Methods inherited from class oracle.jdeveloper.webservices.JAXRPCSvcModel
addModelListener, deriveSoapDDFileLocation, generateWar, getContainer, getDefaultEndpointFromAppServer, getDependents, getEndpoint, getGUID, getHostName, getJNDILocation, getMethodsFromWSDL, getPreviousState, getServicePlatform, getSoapDDFileLocation, getTargetNamespace, getTargetNamespaceString, getTargetProject, getTargetProjectURL, getURI, getURIString, getWebXMLFileLocation, getWSDLFileLocation, invokeWizard, isBeingEdited, isNewModel, isReadOnly, isServicePlatformEditable, isWarGenerationSuppressed, remove, remove, removeModelListener, saveEdit, saveEditInternal, setEndpoint, setGUID, setJNDILocation, setServicePlatform, setServicePlatformEditable, setTargetNamespace, setTargetNamespaceString, setTargetProject, setTargetProjectURL, setURI, setURIString, startEmbeddedServer, suppressWarGeneration, terminateEmbeddedServer, trim
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PACKAGE

public static final java.lang.String PACKAGE
Property identifier. Use this in calls to the validate method.

See Also:
Constant Field Values

OPERATIONS

public static final java.lang.String OPERATIONS
Property identifier. Use this in calls to the validate method.

See Also:
Constant Field Values

PRIMARY_CONNECTION_FACTORY

public static final java.lang.String PRIMARY_CONNECTION_FACTORY
Property identifier. Use this in calls to the validate method.

See Also:
Constant Field Values

PRIMARY_DESTINATION

public static final java.lang.String PRIMARY_DESTINATION
Property identifier. Use this in calls to the validate method.

See Also:
Constant Field Values

JMS_PRIORITY

public static final java.lang.String JMS_PRIORITY
Property identifier. Use this in calls to the validate method.

See Also:
Constant Field Values

JMS_DELIVERY_MODE

public static final java.lang.String JMS_DELIVERY_MODE
Property identifier. Use this in calls to the validate method.

See Also:
Constant Field Values

JMS_EXPIRATION

public static final java.lang.String JMS_EXPIRATION
Property identifier. Use this in calls to the validate method.

See Also:
Constant Field Values

JMS_TYPE

public static final java.lang.String JMS_TYPE
Property identifier. Use this in calls to the validate method.

See Also:
Constant Field Values

IS_REPLY_TO

public static final java.lang.String IS_REPLY_TO
Property identifier. Use this in calls to the validate method.

See Also:
Constant Field Values

REPLY_TO_CONNECTION_FACTORY

public static final java.lang.String REPLY_TO_CONNECTION_FACTORY
Property identifier. Use this in calls to the validate method.

See Also:
Constant Field Values

REPLY_TO_DESTINATION

public static final java.lang.String REPLY_TO_DESTINATION
Property identifier. Use this in calls to the validate method.

See Also:
Constant Field Values

TOPIC

public static final int TOPIC
Constant denoting an object is related to a JMS topic.

See Also:
Constant Field Values

QUEUE

public static final int QUEUE
Constant denoting an object is related to a JMS queue.

See Also:
Constant Field Values

DEFAULT

public static final int DEFAULT
Constant denoting a default value.

See Also:
Constant Field Values

PERSISTENT

public static final int PERSISTENT
Constant denoting persistent delivery mode.

See Also:
Constant Field Values

NONPERSISTENT

public static final int NONPERSISTENT
Constant denoting non-persistent delivery mode.

See Also:
Constant Field Values

SEND

public static final int SEND
Constant denoting send operation is available.

See Also:
Constant Field Values

RECEIVE

public static final int RECEIVE
Constant denoting receive operation is available.

See Also:
Constant Field Values

BOTH

public static final int BOTH
Constant denoting send and receive are both available.

See Also:
Constant Field Values

NEITHER

public static final int NEITHER
Constant denoting no operations are available. This will always fail validation when the wizard finishes, but is a possible intermediate state in the wizard.

See Also:
Constant Field Values
Constructor Detail

JAXRPCJmsModel

public JAXRPCJmsModel()
Default constructor. It's safe to call this if you want to. The model will be in "read" mode by default, and you must call beginEdit before you modify it.


JAXRPCJmsModel

public JAXRPCJmsModel(java.net.URI uri)
Create a new web service with the supplied URI. By calling this constructor, the model will be put into "edit" mode by default.

Parameters:
uri - URI to give to the new service.

JAXRPCJmsModel

public JAXRPCJmsModel(boolean migratedService)
Create a new web service model, allowing the creator to specify that it is being created to hold data being migrated from an older version of JDeveloper.

Parameters:
migratedService - Set this to true to indicate that the model will contain data being migrated from an older version of JDeveloper.
Method Detail

setPackage

public void setPackage(java.lang.String pkg)

getPackage

public java.lang.String getPackage()
Returns:
Name of the package that the service belongs to.

setAvailableOperations

public void setAvailableOperations(int availableOperations)
Parameters:
availableOperations - Integer signifying the operations available on this JMS web service.

getAvailableOperations

public int getAvailableOperations()
Returns:
Integer signifying the operations available on this JMS web service.

setPrimaryConnectionFactory

public void setPrimaryConnectionFactory(java.lang.String primaryConnectionFactory)
Parameters:
primaryConnectionFactory - JNDI name of the connection factory of the web service's primary JMS destination.

getPrimaryConnectionFactory

public java.lang.String getPrimaryConnectionFactory()
Returns:
JNDI name of the connection factory of the web service's primary JMS destination.

setPrimaryDestination

public void setPrimaryDestination(java.lang.String primaryDestination)
Parameters:
primaryDestination - JNDI name of the web service's primary JMS destination.

getPrimaryDestination

public java.lang.String getPrimaryDestination()
Returns:
JNDI name of the web service's primary JMS destination.

setPrimaryDestinationType

public void setPrimaryDestinationType(int primaryDestinationType)
Parameters:
primaryDestinationType - Integer signifying whether the web service's primary JMS destination is a topic or a queue.

getPrimaryDestinationType

public int getPrimaryDestinationType()
Returns:
Integer signifying whether the web service's primary JMS destination is a topic or a queue.

setJMSPriority

public void setJMSPriority(int jmsPriority)
Parameters:
jmsPriority - JMS priority property for sent messages.

getJMSPriority

public int getJMSPriority()
Returns:
JMS priority property for sent messages.

setJMSDeliveryMode

public void setJMSDeliveryMode(int jmsDeliveryMode)
Parameters:
jmsDeliveryMode - JMS delivery mode property for sent messages.

getJMSDeliveryMode

public int getJMSDeliveryMode()
Returns:
JMS delivery mode property for sent messages.

setJMSExpiration

public void setJMSExpiration(long jmsExpiration)
Parameters:
jmsExpiration - JMS expiration property for sent messages.

getJMSExpiration

public long getJMSExpiration()
Returns:
JMS expiration property for sent messages.

setJMSType

public void setJMSType(java.lang.String jmsType)
Parameters:
jmsType - JMS type property for sent messages.

getJMSType

public java.lang.String getJMSType()
Returns:
JMS type property for sent messages.

setReplyTo

public void setReplyTo(boolean isReplyTo)

isReplyTo

public boolean isReplyTo()
Returns:
Boolean flag, true if the web service has a reply-to JMS destination.

setReplyToConnectionFactory

public void setReplyToConnectionFactory(java.lang.String replyToConnectionFactory)
Parameters:
replyToConnectionFactory - JNDI name of the connection factory of the web service's reply-to JMS destination.

getReplyToConnectionFactory

public java.lang.String getReplyToConnectionFactory()
Returns:
JNDI name of the connection factory of the web service's reply-to JMS destination.

setReplyToDestination

public void setReplyToDestination(java.lang.String replyToDestination)
Parameters:
replyToDestination - JNDI name of the web service's reply-to JMS destination.

getReplyToDestination

public java.lang.String getReplyToDestination()
Returns:
replyToDestination JNDI name of the web service's reply-to JMS destination.

setReplyToDestinationType

public void setReplyToDestinationType(int replyToDestinationType)
Parameters:
replyToDestinationType - Integer signifying whether the web service's reply-to JMS destination is a topic or a queue.

getReplyToDestinationType

public int getReplyToDestinationType()
Returns:
Integer signifying whether the web service's reply-to JMS destination is a topic or a queue.

getType

public int getType()
Specified by:
getType in class JAXRPCSvcModel
Returns:
Constant representing what type of web service this is.

getModelLocation

public java.net.URL getModelLocation()
Determine what the location of the persisted model will be after generation. For a JMS web service, the model goes in a package under the first entry on the source path.

Specified by:
getModelLocation in class JAXRPCSvcModel
Returns:
URL pointing to the place where the model will be saved.

deriveWSDLFileLocation

public java.net.URL deriveWSDLFileLocation()
Description copied from class: JAXRPCSvcModel
Derive a location for a WSDL file for this service.

Specified by:
deriveWSDLFileLocation in class JAXRPCSvcModel
Returns:
URL pointing to the location at which the WSDL file will be created.

deriveTargetNamespace

public java.net.URI deriveTargetNamespace()
Description copied from class: JAXRPCSvcModel
Derive a model-specific default target namespace URI for the service.

Specified by:
deriveTargetNamespace in class JAXRPCSvcModel
Returns:
A default target namespace URI for the service.

getTargetDirectories

public URLPath getTargetDirectories()
Description copied from class: JAXRPCSvcModel
Work out all of the directories that will be touched by the JAX-RPC assembler in creating the service.

Specified by:
getTargetDirectories in class JAXRPCSvcModel
Returns:
URLPath containing all of the directories that will be touched by the assembler.

beginEdit

public void beginEdit()
Description copied from class: JAXRPCSvcModel
Make a copy of this model and store it internally, ready for updates that can be applied or undone. If beginEdit is called more than once without a saveEdit or undoEdit appearing in between, all calls except the first will be disregarded.

Overrides:
beginEdit in class JAXRPCSvcModel

undoEdit

public void undoEdit()
Description copied from class: JAXRPCSvcModel
Restore the state of the model to what it was when beginEdit was called.

Overrides:
undoEdit in class JAXRPCSvcModel

invokeWizardInternal

protected boolean invokeWizardInternal(oracle.bali.ewt.wizard.BaseWizard baseWizard,
                                       boolean showProgressBar,
                                       boolean openFiles,
                                       java.awt.Component dialogParent)
Description copied from class: JAXRPCSvcModel
Invoke a wizard to edit this data model. Instantiable subclasses must supply their own wizard-specific code in this method.

Specified by:
invokeWizardInternal in class JAXRPCSvcModel
Parameters:
baseWizard - Wizard class that pages and panels should be added to.
showProgressBar - Boolean flag, set this to true if a progress bar should be shown during generation.
openFiles - Boolean flag, set this to true if generated files should be opened after generation.
dialogParent - Parent component for any progress or error dialogs displayed during generation.
Returns:
Boolean value; true if the wizard was applied, false if it was cancelled.

validate

public void validate(java.lang.String[] properties)
              throws java.lang.Exception
Description copied from class: JAXRPCSvcModel
Validate all of the properties whose identifiers have been supplied in the String array.

Overrides:
validate in class JAXRPCSvcModel
Parameters:
properties - Array of string identifiers of all the properties that should be validated. If the array is null or empty, all properties will be validated.
Throws:
java.lang.Exception - containing a translated message that explains why validation failed.

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.