Java Doc for OperationDescription.java in  » Web-Services-AXIS2 » metadata » org » apache » axis2 » jaxws » description » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Services AXIS2 » metadata » org.apache.axis2.jaxws.description 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.axis2.jaxws.description.OperationDescription

All known Subclasses:   org.apache.axis2.jaxws.description.impl.OperationDescriptionImpl,
OperationDescription
public interface OperationDescription (Code)
An OperationDescripton corresponds to a method on an SEI. That SEI could be explicit (i.e. WebService.endpointInterface=sei.class) or implicit (i.e. public methods on the service implementation are the contract and thus the implicit SEI). Note that while OperationDescriptions are created on both the client and service side, implicit SEIs will only occur on the service side.

OperationDescriptons contain information that is only relevent for and SEI-based service, i.e. one that is invoked via specific methods. This class does not exist for Provider-based services (i.e. those that specify WebServiceProvider)

 OperationDescription details
 

CORRESPONDS TO: A single operation on an SEI (on both Client and Server)

AXIS2 DELEGATE: AxisOperation

CHILDREN: 0..n ParameterDescription 0..n FaultDescription (Note: Not fully implemented)

ANNOTATIONS: WebMethod [181] SOAPBinding [181] Oneway [181] WebResult [181] RequestWrapper [224] ResponseWrapper [224]

WSDL ELEMENTS: operation



Field Summary
final public static  StringHEADER_PARAMETER_QNAMES
     Paramater set on AxisOperation which contains an ArrayList of SOAP header QNames corresponding to SEI parameters.


Method Summary
public  StringgetAction()
    
abstract public  AxisOperationgetAxisOperation()
    
public  StringgetBindingInputNamespace()
    
public  StringgetBindingOutputNamespace()
    
public  EndpointInterfaceDescriptiongetEndpointInterfaceDescription()
    
public  FaultDescription[]getFaultDescriptions()
    
public  StringgetJavaDeclaringClassName()
    
public  StringgetJavaMethodName()
    
public  String[]getJavaParameters()
    
public  MethodgetMethodFromServiceImpl(Class serviceImpl)
     Service implementation side only! Given a service implementation class, find the method on that class that corresponds to this operation description.
public  QNamegetName()
    
public  StringgetOperationName()
    
public  OperationRuntimeDescriptiongetOperationRuntimeDesc(String name)
    
public  String[]getParamNames()
    
public  ParameterDescriptiongetParameterDescription(int parameterNumber)
    
public  ParameterDescriptiongetParameterDescription(String parameterName)
    
public  ParameterDescription[]getParameterDescriptions()
    
public  StringgetRequestWrapperClassName()
     the class name of the wrapper class.
public  StringgetRequestWrapperLocalName()
    
public  StringgetRequestWrapperTargetNamespace()
    
public  StringgetResponseWrapperClassName()
     the class name of the wrapper class.
public  StringgetResponseWrapperLocalName()
    
public  StringgetResponseWrapperTargetNamespace()
    
public  ClassgetResultActualType()
     Return the actual Class of the type.
public  AttachmentDescriptiongetResultAttachmentDescription()
    
public  StringgetResultName()
    
public  StringgetResultPartName()
    
public  StringgetResultTargetNamespace()
    
public  ClassgetResultType()
     Return the Class of the return type.
public  MethodgetSEIMethod()
     Client side and non-DBC service side only! Return the SEI method for which a service.getPort(Class SEIClass) created the EndpointDescriptionInterface and the associated OperationDescriptions.
public  javax.jws.soap.SOAPBinding.ParameterStylegetSoapBindingParameterStyle()
    
public  javax.jws.soap.SOAPBinding.StylegetSoapBindingStyle()
    
public  javax.jws.soap.SOAPBinding.UsegetSoapBindingUse()
    
public  OperationDescriptiongetSyncOperation()
     For JAX-WS client-side async operations, this will return the corresponding sync OperationDescription. Note that if this method is used within the metadata layer, it is possible that it will return null.
public  booleanisExcluded()
    
public  booleanisJAXWSAsyncClientMethod()
     Answer if this operation corresponds to the JAX-WS Client-only async methods.
public  booleanisListType()
    
public  booleanisOneWay()
    
public  booleanisOperationReturningResult()
    
public  booleanisResultHeader()
    
public  FaultDescriptionresolveFaultByExceptionName(String exceptionClassName)
    
public  voidsetOperationRuntimeDesc(OperationRuntimeDescription ord)
    

Field Detail
HEADER_PARAMETER_QNAMES
final public static String HEADER_PARAMETER_QNAMES(Code)
Paramater set on AxisOperation which contains an ArrayList of SOAP header QNames corresponding to SEI parameters.





Method Detail
getAction
public String getAction()(Code)



getAxisOperation
abstract public AxisOperation getAxisOperation()(Code)



getBindingInputNamespace
public String getBindingInputNamespace()(Code)
Returns the namespace of binding input message for the operation



getBindingOutputNamespace
public String getBindingOutputNamespace()(Code)
Returns the namespace of binding output message for the operation



getEndpointInterfaceDescription
public EndpointInterfaceDescription getEndpointInterfaceDescription()(Code)



getFaultDescriptions
public FaultDescription[] getFaultDescriptions()(Code)



getJavaDeclaringClassName
public String getJavaDeclaringClassName()(Code)



getJavaMethodName
public String getJavaMethodName()(Code)



getJavaParameters
public String[] getJavaParameters()(Code)



getMethodFromServiceImpl
public Method getMethodFromServiceImpl(Class serviceImpl)(Code)
Service implementation side only! Given a service implementation class, find the method on that class that corresponds to this operation description. This is necessary because on the service impl side, the OperationDescriptions can be built using byte-scanning and without the class actually having been loaded.
Parameters:
  serviceImpl -



getName
public QName getName()(Code)



getOperationName
public String getOperationName()(Code)



getOperationRuntimeDesc
public OperationRuntimeDescription getOperationRuntimeDesc(String name)(Code)



getParamNames
public String[] getParamNames()(Code)



getParameterDescription
public ParameterDescription getParameterDescription(int parameterNumber)(Code)



getParameterDescription
public ParameterDescription getParameterDescription(String parameterName)(Code)



getParameterDescriptions
public ParameterDescription[] getParameterDescriptions()(Code)



getRequestWrapperClassName
public String getRequestWrapperClassName()(Code)
the class name of the wrapper class. NOTE: This method will return null if therequest wrapper class is not known during the description layer processing. In suchcases the implementation may use proprietary code to find the class. For example,JAXWS may look for a matching class in the sei package, in a special jaxws package orproceed without the class name



getRequestWrapperLocalName
public String getRequestWrapperLocalName()(Code)



getRequestWrapperTargetNamespace
public String getRequestWrapperTargetNamespace()(Code)



getResponseWrapperClassName
public String getResponseWrapperClassName()(Code)
the class name of the wrapper class. NOTE: This method will return null if therequest wrapper class is not known during the description layer processing. In suchcases the implementation may use proprietary code to find the class. For example,JAXWS may look for a matching class in the sei package, in a special jaxws package orproceed without the class name



getResponseWrapperLocalName
public String getResponseWrapperLocalName()(Code)



getResponseWrapperTargetNamespace
public String getResponseWrapperTargetNamespace()(Code)



getResultActualType
public Class getResultActualType()(Code)
Return the actual Class of the type. For a JAX-WS async return type of Response or AsyncHandler, the class associated with is returned. For non-JAX-WS async returns, the class associated with the return type is returned. Note that for a Generic return type, such as List, the class associated with List will be returned. actual Class



getResultAttachmentDescription
public AttachmentDescription getResultAttachmentDescription()(Code)
Attachment Description for the return type or null



getResultName
public String getResultName()(Code)



getResultPartName
public String getResultPartName()(Code)



getResultTargetNamespace
public String getResultTargetNamespace()(Code)



getResultType
public Class getResultType()(Code)
Return the Class of the return type. For JAX-WS async returns of type Response or AsyncHandler, the class associated with Response or AsyncHanler respectively is returned. To get the class associated with Class
See Also:    getResultActualType()



getSEIMethod
public Method getSEIMethod()(Code)
Client side and non-DBC service side only! Return the SEI method for which a service.getPort(Class SEIClass) created the EndpointDescriptionInterface and the associated OperationDescriptions. Returns null on the service implementation side.



getSoapBindingParameterStyle
public javax.jws.soap.SOAPBinding.ParameterStyle getSoapBindingParameterStyle()(Code)



getSoapBindingStyle
public javax.jws.soap.SOAPBinding.Style getSoapBindingStyle()(Code)



getSoapBindingUse
public javax.jws.soap.SOAPBinding.Use getSoapBindingUse()(Code)



getSyncOperation
public OperationDescription getSyncOperation()(Code)
For JAX-WS client-side async operations, this will return the corresponding sync OperationDescription. Note that if this method is used within the metadata layer, it is possible that it will return null. That will happen if the metadata layer is constructed from annotations on the SEI (not WSDL). In that case, it is possible that the async methods on the SEI are processed before the sync method. In that case, there will be no sync method yet. If this method is called outside the metadata layer, then if the async methods exist, the sync method should also exist. OperationDescription corresponding to the sync operation, or null (see note above).



isExcluded
public boolean isExcluded()(Code)



isJAXWSAsyncClientMethod
public boolean isJAXWSAsyncClientMethod()(Code)
Answer if this operation corresponds to the JAX-WS Client-only async methods. These methods are of the form: javax.xml.ws.Response method(...) java.util.concurrent.Future method(..., javax.xml.ws.AsyncHandler)



isListType
public boolean isListType()(Code)



isOneWay
public boolean isOneWay()(Code)



isOperationReturningResult
public boolean isOperationReturningResult()(Code)



isResultHeader
public boolean isResultHeader()(Code)



resolveFaultByExceptionName
public FaultDescription resolveFaultByExceptionName(String exceptionClassName)(Code)



setOperationRuntimeDesc
public void setOperationRuntimeDesc(OperationRuntimeDescription ord)(Code)



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.