|
Extension SDK 9.0.5 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectoracle.jdeveloper.webservices.JAXRPCSvcModel
oracle.jdeveloper.webservices.JAXRPCJavaModel
This class represents the data model for a Java class or EJB exposed as a Java web service. Interaction with the JAXRPCJavaModel is governed by the rules described in JAXRPCSvcModel.
Field Summary | |
static java.lang.String |
CLASS
Property identifier. |
static int |
DONT_KNOW_WHAT_IT_IS_YET
Constant identifying the type of EJB that is exposed by the service. |
static int |
EJB_ENTITY
Constant identifying the type of EJB that is exposed by the service. |
static int |
EJB_STATEFUL_SESSION
Constant identifying the type of EJB that is exposed by the service. |
static int |
EJB_STATELESS_SESSION
Constant identifying the type of EJB that is exposed by the service. |
static java.lang.String |
HOME_INTERFACE
Property identifier. |
static int |
MESSAGE_DOCUMENT_LITERAL
Constant specifying that the service should communicate by document-literal messages. |
static int |
MESSAGE_RPC_ENCODED
Constant specifying that the service should communicate by rpc-encoded messages. |
static int |
MESSAGE_RPC_LITERAL
Constant specifying that the service should communicate by rpc-literal messages. |
static java.lang.String |
METHODS_PUBLISHED
Property identifier. |
static int |
NOT_AN_EJB
Constant identifying the type of EJB that is exposed by the service. |
static int |
SCOPE_APPLICATION
Application scope constant. |
static int |
SCOPE_REQUEST
Application scope constant. |
static int |
SCOPE_SESSION
Application scope constant. |
static java.lang.String |
SERVICE_INTERFACE
Property identifier. |
static java.lang.String |
STATEFUL_SCOPE
Property identifier. |
static java.lang.String |
TIMEOUT
Property identifier. |
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 | |
JAXRPCJavaModel()
Default constructor. |
|
JAXRPCJavaModel(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. |
|
JAXRPCJavaModel(java.net.URI uri,
java.lang.String className)
Create a new web service with the supplied URI, that exposes the supplied class. |
Method Summary | |
int |
addAllPublishableMethods(boolean declaredOnly)
Determine all publishable methods in the service class (or endpoint interface for a JAX-RPC service), and mark them for publication. |
void |
addMethod(MethodSignature add)
Add the method signature supplied to the list of methods to be published. |
void |
beginEdit()
Make a copy of this model and store it internally, ready for updates that can be applied or undone. |
boolean |
canEditImplementationFile(MethodSignature method)
Determine whether the implementation files of the service can be modified during generation. |
void |
clearMethodUpdateLists()
Clear all of the method update lists. |
void |
clearUntaggedMethods()
Clear the untagged selected methods list. |
static JAXRPCJavaModel |
createWebServiceFromClass(java.net.URI uri,
java.lang.String className,
int servicePlatform)
Create and generate a web service for the given class. |
java.net.URL |
deriveSoapDDFileLocation()
Derive a default value for the Oracle/Apache SOAP deployment descriptor file location. |
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. |
java.util.List |
getAddMethods()
|
java.net.URL[] |
getBeansFound()
|
java.util.Set |
getBeansUsedByMethod(JotMethod method)
Determine which JavaBeans are used by a particular method in a web service. |
JotClass |
getClassJOT()
|
java.lang.String |
getClassName()
|
java.net.URL |
getClassURL()
Find the URL at which the class being published resides. |
java.lang.String |
getEJBClass()
|
int |
getEJBType()
|
java.lang.String |
getHomeInterface()
|
JotManager |
getJotManager()
Find and return the appropriate JotManager for this data model. |
int |
getMessageFormat()
|
java.lang.String |
getMethodPublishableStatus(JotMethod method)
Determine whether a particular JotMethod is publishable, and return a reason why if it isn't. |
java.util.List |
getMethodsPublished()
Find all of the methods published on the class, by looking for @webmethod tags in source and by looking at the untaggedMethodsPublished list held in this data model. |
int |
getMinimumMethods()
|
java.net.URL |
getModelLocation()
Determine what the location of the persisted model will be after generation. |
java.util.List |
getRemoveMethods()
|
java.util.List |
getRenameMethods()
|
int |
getScope()
|
java.lang.String |
getServiceInterface()
|
JotClass |
getServiceInterfaceJOT()
|
java.lang.String[] |
getServiceInterfacesOnClass()
Find all of the interfaces implemented by the class which extend the java.rmi.Remote interface, and return their names. |
java.util.List |
getTaggedMethods()
Find and return all of the tagged methods directly declared on the service's implementing class. |
URLPath |
getTargetDirectories()
Work out all of the directories that will be touched by the JAX-RPC assembler in creating the service. |
long |
getTimeout()
|
int |
getType()
|
oracle.jdevimpl.webservices.util.JavaXSDTypeMap |
getTypeMap()
|
java.util.List |
getUntaggedMethodsPublished()
|
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 |
isMethodRemoveable(MethodSignature remove)
Determine whether the method supplied can be unpublished from the service. |
boolean |
isPublishable(java.lang.String name,
boolean isClass,
int modifiers)
Determines whether the named class/interface having the supplied modifiers is publishable as a web service. |
boolean |
isPublishSuperclass()
|
boolean |
isServicePlatformEditable()
|
boolean |
isStateless()
|
boolean |
isStaticInvocation()
|
void |
removeMethod(MethodSignature remove)
Remove the method signature supplied from the list of methods to be published. |
void |
renameMethod(MethodSignature oldSig,
MethodSignature newSig)
Rename a method in the service. |
static java.lang.String |
resolvePrimitives(java.lang.String typeName)
Given the name of a type, check if it's one of the primitive wrappers, and if so replace it with the name of the the primitive. |
protected void |
saveEditInternal()
Discard the backup copy of the model. |
void |
setBeansFound(java.net.URL[] beansFound)
|
void |
setCanEditImplementationFile(boolean editImplementationFile)
Deprecated. canEditImplementationFile property is now governed by whether the implementation file is read-only or not. |
void |
setClassName(java.lang.String className)
|
void |
setEJBClass(java.lang.String ejbClass)
This method exists for use only by Object2Dom and refactoring. |
void |
setEJBType(int ejbType)
This method exists for use only by Object2Dom and refactoring. |
void |
setHomeInterface(java.lang.String homeInterface)
This method exists for use only by Object2Dom and refactoring. |
void |
setMessageFormat(int messageFormat)
|
void |
setMinimumMethods(int minimumMethods)
|
void |
setPublishSuperclass(boolean publishSuperclass)
|
void |
setScope(int scope)
|
void |
setServiceInterface(java.lang.String serviceInterface)
|
void |
setStateless(boolean stateless)
|
void |
setStaticInvocation(boolean staticInvocation)
|
void |
setTargetProject(JProject targetProject)
Specialisation of setTargetProject that resets the JOTManager for the model. |
void |
setTimeout(long timeout)
|
void |
setTypeMap(oracle.jdevimpl.webservices.util.JavaXSDTypeMap typeMap)
|
void |
setUntaggedMethodsPublished(java.util.List untaggedMethodsPublished)
|
void |
undoEdit()
Restore the state of the model to what it was when beginEdit was called. |
void |
update(java.lang.Object observed,
UpdateMessage change)
Notification message. |
void |
validate(java.lang.String[] properties)
Validate all of the properties whose identifiers have been supplied in the String array. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String CLASS
public static final java.lang.String SERVICE_INTERFACE
public static final java.lang.String TIMEOUT
public static final java.lang.String STATEFUL_SCOPE
public static final java.lang.String HOME_INTERFACE
public static final java.lang.String METHODS_PUBLISHED
public static final int SCOPE_APPLICATION
public static final int SCOPE_SESSION
public static final int SCOPE_REQUEST
public static final int DONT_KNOW_WHAT_IT_IS_YET
public static final int NOT_AN_EJB
public static final int EJB_ENTITY
public static final int EJB_STATELESS_SESSION
public static final int EJB_STATEFUL_SESSION
public static final int MESSAGE_RPC_ENCODED
public static final int MESSAGE_RPC_LITERAL
public static final int MESSAGE_DOCUMENT_LITERAL
Constructor Detail |
public JAXRPCJavaModel()
public JAXRPCJavaModel(java.net.URI uri, java.lang.String className)
uri
- URI to give to the new service.className
- Name of the class exposed by the service.public JAXRPCJavaModel(boolean migratedService)
migratedService
- Set this to true to indicate that the model will
contain data being migrated from an older version of JDeveloper.Method Detail |
public void setTargetProject(JProject targetProject)
setTargetProject
in class JAXRPCSvcModel
targetProject
- Target project for the service under consideration.public void setClassName(java.lang.String className)
className
- The fully-qualified name of the class being published.public java.lang.String getClassName()
public void setEJBClass(java.lang.String ejbClass)
public java.lang.String getEJBClass()
public void setHomeInterface(java.lang.String homeInterface)
public java.lang.String getHomeInterface()
public void setEJBType(int ejbType)
public int getEJBType()
public void setMessageFormat(int messageFormat)
messageFormat
- The message format that the service should use to
communciate. See the MESSAGE_ constants at the top of the class.public int getMessageFormat()
public void setScope(int scope)
scope
- Scope of stateful services. See the SCOPE_ constants at the
top of the class for allowable values. This only applies to Oracle
SOAP services.public int getScope()
public void setStaticInvocation(boolean staticInvocation)
staticInvocation
- Boolean flag, indicating whether the service
invokes static methods. This only applies to Oracle SOAP services.public boolean isStaticInvocation()
public void setPublishSuperclass(boolean publishSuperclass)
publishSuperclass
- Boolean flag, indicating whether the service
includes methods from a superclass.public boolean isPublishSuperclass()
public void setServiceInterface(java.lang.String serviceInterface)
serviceInterface
- The fully-qualified name of the service interface
of the class being published. Applicable only to JAX-RPC services.public java.lang.String getServiceInterface()
public void setUntaggedMethodsPublished(java.util.List untaggedMethodsPublished)
untaggedMethodsPublished
- The signatures of all methods being
published which don't have corresponding @webmethod tags in source,
represented as instances of MethodSignature.public java.util.List getUntaggedMethodsPublished()
public void setMinimumMethods(int minimumMethods)
minimumMethods
- The minimum number of methods that must be selected
for publication in this model. This can be set to 0 so that the web
service modeller can create a default implementation class with no
methods in it.public int getMinimumMethods()
public void setStateless(boolean stateless)
stateless
- Boolean flag, indicating whether the service is stateful
or stateless.public boolean isStateless()
public void setTimeout(long timeout)
timeout
- Long value of the timeout for stateful services.public long getTimeout()
public JotClass getServiceInterfaceJOT()
public JotClass getClassJOT()
public java.net.URL[] getBeansFound()
public void setBeansFound(java.net.URL[] beansFound)
beansFound
- Array of URLs to JavaBeans used as parameters or return
types to published methods.public void setCanEditImplementationFile(boolean editImplementationFile)
editImplementationFile
- Flag indicating whether the implementation
file for this service should be edited if the edit is saved.public boolean canEditImplementationFile(MethodSignature method)
method
- MethodSignature of a method whose editable status is
required. If null, the editable status of the service class chosen
by the user will be returned.
public java.util.List getAddMethods()
public java.util.List getRemoveMethods()
public java.util.List getRenameMethods()
public void setTypeMap(oracle.jdevimpl.webservices.util.JavaXSDTypeMap typeMap)
typeMap
- The type map being used during generation of this service.
For an Oracle/Apache SOAP service, this will be needed in order to
generate user type mappings.public oracle.jdevimpl.webservices.util.JavaXSDTypeMap getTypeMap() throws TransientMarker
TransientMarker
public boolean isServicePlatformEditable()
isServicePlatformEditable
in class JAXRPCSvcModel
public void update(java.lang.Object observed, UpdateMessage change)
Observer
update
in interface Observer
observed
- the subject whose state has changed.change
- what has changed.public int getType()
getType
in class JAXRPCSvcModel
public java.net.URL getModelLocation()
getModelLocation
in class JAXRPCSvcModel
public java.net.URL deriveWSDLFileLocation()
JAXRPCSvcModel
deriveWSDLFileLocation
in class JAXRPCSvcModel
public java.net.URL deriveSoapDDFileLocation()
JAXRPCSvcModel
deriveSoapDDFileLocation
in class JAXRPCSvcModel
public java.net.URI deriveTargetNamespace()
JAXRPCSvcModel
deriveTargetNamespace
in class JAXRPCSvcModel
public URLPath getTargetDirectories()
JAXRPCSvcModel
getTargetDirectories
in class JAXRPCSvcModel
public void beginEdit()
JAXRPCSvcModel
beginEdit
in class JAXRPCSvcModel
protected void saveEditInternal()
JAXRPCSvcModel
saveEditInternal
in class JAXRPCSvcModel
public void undoEdit()
JAXRPCSvcModel
undoEdit
in class JAXRPCSvcModel
protected boolean invokeWizardInternal(oracle.bali.ewt.wizard.BaseWizard baseWizard, boolean showProgressBar, boolean openFiles, java.awt.Component dialogParent)
JAXRPCSvcModel
invokeWizardInternal
in class JAXRPCSvcModel
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.
public void validate(java.lang.String[] properties) throws java.lang.Exception
JAXRPCSvcModel
validate
in class JAXRPCSvcModel
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.
java.lang.Exception
- containing a translated message that explains why
validation failed.public java.util.List getTaggedMethods()
java.lang.IllegalStateException
- if the implementing class hasn't yet been
set.public boolean isMethodRemoveable(MethodSignature remove)
public void removeMethod(MethodSignature remove)
remove
- Signature of the method to be unpublished.public void renameMethod(MethodSignature oldSig, MethodSignature newSig)
oldSig
- Old signature of the method.newSig
- New signature of the method.public void addMethod(MethodSignature add)
add
- Signature of the new method to be published.public int addAllPublishableMethods(boolean declaredOnly)
declaredOnly
- Set this to true if you want to add only the methods
declared in this class/interface, and not any in
superclasses/superinterfaces. This value is ignored if any
webmethod tags are found in the class or any of its superclasses.
java.lang.IllegalStateException
- if no class or service endpoint
interface has yet been specified.public void clearMethodUpdateLists()
public void clearUntaggedMethods()
public java.util.List getMethodsPublished()
public java.lang.String[] getServiceInterfacesOnClass()
public java.lang.String getMethodPublishableStatus(JotMethod method)
method
- JotMethod that should be checked.
public java.util.Set getBeansUsedByMethod(JotMethod method)
method
- Method to check.
public java.net.URL getClassURL()
public JotManager getJotManager()
public boolean isPublishable(java.lang.String name, boolean isClass, int modifiers)
name
- Name of the class or interface to test.isClass
- True if it's a class, false if it's an interface.modifiers
- Modifiers of the class.
public static JAXRPCJavaModel createWebServiceFromClass(java.net.URI uri, java.lang.String className, int servicePlatform) throws java.lang.Exception
uri
- URI of the web service.className
- Package-qualified name of the class to be published.
java.lang.Exception
- if creation of the service failed for any reason.public static java.lang.String resolvePrimitives(java.lang.String typeName)
typeName
- Name of the type to check.
|
Extension SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2004, Oracle. All rights reserved.