Java Doc for Endpoint.java in  » 6.0-JDK-Modules » jax-ws-api » javax » xml » ws » 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 » 6.0 JDK Modules » jax ws api » javax.xml.ws 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.xml.ws.Endpoint

Endpoint
abstract public class Endpoint (Code)
A Web service endpoint.

Endpoints are created using the static methods defined in this class. An endpoint is always tied to one Binding and one implementor, both set at endpoint creation time.

An endpoint is either in a published or an unpublished state. The publish methods can be used to start publishing an endpoint, at which point it starts accepting incoming requests. Conversely, the stop method can be used to stop accepting incoming requests and take the endpoint down. Once stopped, an endpoint cannot be published again.

An Executor may be set on the endpoint in order to gain better control over the threads used to dispatch incoming requests. For instance, thread pooling with certain parameters can be enabled by creating a ThreadPoolExecutor and registering it with the endpoint.

Handler chains can be set using the contained Binding.

An endpoint may have a list of metadata documents, such as WSDL and XMLSchema documents, bound to it. At publishing time, the JAX-WS implementation will try to reuse as much of that metadata as possible instead of generating new ones based on the annotations present on the implementor.
since:
   JAX-WS 2.0
See Also:   javax.xml.ws.Binding
See Also:   javax.xml.ws.BindingType
See Also:   javax.xml.ws.soap.SOAPBinding
See Also:   java.util.concurrent.Executor



Field Summary
final public static  StringWSDL_PORT
     Standard property: name of WSDL port.
final public static  StringWSDL_SERVICE
     Standard property: name of WSDL service.


Method Summary
public static  Endpointcreate(Object implementor)
     Creates an endpoint with the specified implementor object.
public static  Endpointcreate(String bindingId, Object implementor)
     Creates an endpoint with the specified binding type and implementor object.

The newly created endpoint may be published by calling one of the javax.xml.ws.Endpoint.publish(String) and javax.xml.ws.Endpoint.publish(Object) methods.
Parameters:
  bindingId - A URI specifying the binding to use.

abstract public  BindinggetBinding()
     Returns the binding for this endpoint.
abstract public  EndpointReferencegetEndpointReference(Element... referenceParameters)
     Returns the EndpointReference associated with this Endpoint instance.

If the Binding for this bindingProvider is either SOAP1.1/HTTP or SOAP1.2/HTTP, then a W3CEndpointReference MUST be returned.
Parameters:
  referenceParameters - Reference parameters to be associated with thereturned EndpointReference instance.

abstract public  TgetEndpointReference(Class<T> clazz, Element... referenceParameters)
     Returns the EndpointReference associated with this Endpoint instance.
Parameters:
  clazz - Specifies the type of EndpointReference that MUST be returned.
Parameters:
  referenceParameters - Reference parameters to be associated with thereturned EndpointReference instance.
abstract public  java.util.concurrent.ExecutorgetExecutor()
     Returns the executor for this Endpointinstance.
abstract public  ObjectgetImplementor()
     Returns the implementation object for this endpoint.
abstract public  List<javax.xml.transform.Source>getMetadata()
     Returns a list of metadata documents for the service.
abstract public  Map<String, Object>getProperties()
     Returns the property bag for this Endpoint instance.
abstract public  booleanisPublished()
     Returns true if the endpoint is in the published state.
abstract public  voidpublish(String address)
     Publishes this endpoint at the given address. The necessary server infrastructure will be created and configured by the JAX-WS implementation using some default configuration. In order to get more control over the server configuration, please use the javax.xml.ws.Endpoint.publish(Object) method instead.
Parameters:
  address - A URI specifying the address to use.
public static  Endpointpublish(String address, Object implementor)
     Creates and publishes an endpoint for the specified implementor object at the given address.

The necessary server infrastructure will be created and configured by the JAX-WS implementation using some default configuration. In order to get more control over the server configuration, please use the javax.xml.ws.Endpoint.create(StringObject) and javax.xml.ws.Endpoint.publish(Object) methods instead.
Parameters:
  address - A URI specifying the address and transport/protocolto use.

abstract public  voidpublish(Object serverContext)
     Publishes this endpoint at the provided server context.
abstract public  voidsetExecutor(java.util.concurrent.Executor executor)
     Sets the executor for this Endpoint instance. The executor is used to dispatch an incoming request to the implementor object. If this Endpoint is published using the publish(Object) method and the specified server context defines its own threading behavior, the executor may be ignored.
Parameters:
  executor - The java.util.concurrent.Executorto be used to dispatch a request.
throws:
  SecurityException - If the instance does not supportsetting an executor for security reasons (e.g.
abstract public  voidsetMetadata(List<javax.xml.transform.Source> metadata)
     Sets the metadata for this endpoint.
abstract public  voidsetProperties(Map<String, Object> properties)
     Sets the property bag for this Endpoint instance.
abstract public  voidstop()
     Stops publishing this endpoint.

Field Detail
WSDL_PORT
final public static String WSDL_PORT(Code)
Standard property: name of WSDL port.

Type: javax.xml.namespace.QName




WSDL_SERVICE
final public static String WSDL_SERVICE(Code)
Standard property: name of WSDL service.

Type: javax.xml.namespace.QName






Method Detail
create
public static Endpoint create(Object implementor)(Code)
Creates an endpoint with the specified implementor object. If there is a binding specified via a BindingType annotation then it MUST be used else a default of SOAP 1.1 / HTTP binding MUST be used.

The newly created endpoint may be published by calling one of the javax.xml.ws.Endpoint.publish(String) and javax.xml.ws.Endpoint.publish(Object) methods.
Parameters:
  implementor - The endpoint implementor. The newly created endpoint.




create
public static Endpoint create(String bindingId, Object implementor)(Code)
Creates an endpoint with the specified binding type and implementor object.

The newly created endpoint may be published by calling one of the javax.xml.ws.Endpoint.publish(String) and javax.xml.ws.Endpoint.publish(Object) methods.
Parameters:
  bindingId - A URI specifying the binding to use. If the bindingID isnull and no binding is specified via a BindingTypeannotation then a default SOAP 1.1 / HTTP binding MUST be used.
Parameters:
  implementor - The endpoint implementor. The newly created endpoint.




getBinding
abstract public Binding getBinding()(Code)
Returns the binding for this endpoint. The binding for this endpoint



getEndpointReference
abstract public EndpointReference getEndpointReference(Element... referenceParameters)(Code)
Returns the EndpointReference associated with this Endpoint instance.

If the Binding for this bindingProvider is either SOAP1.1/HTTP or SOAP1.2/HTTP, then a W3CEndpointReference MUST be returned.
Parameters:
  referenceParameters - Reference parameters to be associated with thereturned EndpointReference instance. EndpointReference of this Endpoint instance.If the returned EndpointReference is of typeW3CEndpointReference then it MUST contain thethe specified referenceParameters.
throws:
  WebServiceException - If any error in the creation ofthe EndpointReference or if the Endpoint is not in the published state.
throws:
  UnsupportedOperationException - If this BindingProvideruses the XML/HTTP binding.
See Also:   W3CEndpointReference
since:
   JAX-WS 2.1




getEndpointReference
abstract public T getEndpointReference(Class<T> clazz, Element... referenceParameters)(Code)
Returns the EndpointReference associated with this Endpoint instance.
Parameters:
  clazz - Specifies the type of EndpointReference that MUST be returned.
Parameters:
  referenceParameters - Reference parameters to be associated with thereturned EndpointReference instance. EndpointReference of type clazz of this Endpoint instance.If the returned EndpointReference is of typeW3CEndpointReference then it MUST contain thethe specified referenceParameters.
throws:
  WebServiceException - If any error in the creation ofthe EndpointReference or if the Endpoint is not in the published state or if the clazz is not a supportedEndpointReference type.
throws:
  UnsupportedOperationException - If this BindingProvideruses the XML/HTTP binding.
since:
   JAX-WS 2.1



getExecutor
abstract public java.util.concurrent.Executor getExecutor()(Code)
Returns the executor for this Endpointinstance. The executor is used to dispatch an incoming request to the implementor object. The java.util.concurrent.Executor to beused to dispatch a request.
See Also:   java.util.concurrent.Executor



getImplementor
abstract public Object getImplementor()(Code)
Returns the implementation object for this endpoint. The implementor for this endpoint



getMetadata
abstract public List<javax.xml.transform.Source> getMetadata()(Code)
Returns a list of metadata documents for the service. List<javax.xml.transform.Source> A list of metadata documents for the service



getProperties
abstract public Map<String, Object> getProperties()(Code)
Returns the property bag for this Endpoint instance. Map<String,Object> The property bagassociated with this instance.



isPublished
abstract public boolean isPublished()(Code)
Returns true if the endpoint is in the published state. true if the endpoint is in the published state.



publish
abstract public void publish(String address)(Code)
Publishes this endpoint at the given address. The necessary server infrastructure will be created and configured by the JAX-WS implementation using some default configuration. In order to get more control over the server configuration, please use the javax.xml.ws.Endpoint.publish(Object) method instead.
Parameters:
  address - A URI specifying the address to use. The addressMUST be compatible with the binding specified at thetime the endpoint was created.
throws:
  java.lang.IllegalArgumentException - If the provided address URI is not usablein conjunction with the endpoint's binding.
throws:
  java.lang.IllegalStateException - If the endpoint has been published already or it has been stopped.
throws:
  java.lang.SecurityException - If a java.lang.SecurityMangeris being used and the application doesn't have theWebServicePermission("publishEndpoint") permission.



publish
public static Endpoint publish(String address, Object implementor)(Code)
Creates and publishes an endpoint for the specified implementor object at the given address.

The necessary server infrastructure will be created and configured by the JAX-WS implementation using some default configuration. In order to get more control over the server configuration, please use the javax.xml.ws.Endpoint.create(StringObject) and javax.xml.ws.Endpoint.publish(Object) methods instead.
Parameters:
  address - A URI specifying the address and transport/protocolto use. A http: URI MUST result in the SOAP 1.1/HTTPbinding being used. Implementations may support otherURI schemes.
Parameters:
  implementor - The endpoint implementor. The newly created endpoint.
throws:
  java.lang.SecurityException - If a java.lang.SecurityMangeris being used and the application doesn't have theWebServicePermission("publishEndpoint") permission.




publish
abstract public void publish(Object serverContext)(Code)
Publishes this endpoint at the provided server context. A server context encapsulates the server infrastructure and addressing information for a particular transport. For a call to this method to succeed, the server context passed as an argument to it MUST be compatible with the endpoint's binding.
Parameters:
  serverContext - An object representing a servercontext to be used for publishing the endpoint.
throws:
  java.lang.IllegalArgumentException - If the provided server context is notsupported by the implementation or turnsout to be unusable in conjunction with theendpoint's binding.
throws:
  java.lang.IllegalStateException - If the endpoint has been published already or it has been stopped.
throws:
  java.lang.SecurityException - If a java.lang.SecurityMangeris being used and the application doesn't have theWebServicePermission("publishEndpoint") permission.



setExecutor
abstract public void setExecutor(java.util.concurrent.Executor executor)(Code)
Sets the executor for this Endpoint instance. The executor is used to dispatch an incoming request to the implementor object. If this Endpoint is published using the publish(Object) method and the specified server context defines its own threading behavior, the executor may be ignored.
Parameters:
  executor - The java.util.concurrent.Executorto be used to dispatch a request.
throws:
  SecurityException - If the instance does not supportsetting an executor for security reasons (e.g. thenecessary permissions are missing).
See Also:   java.util.concurrent.Executor



setMetadata
abstract public void setMetadata(List<javax.xml.transform.Source> metadata)(Code)
Sets the metadata for this endpoint.
Parameters:
  metadata - A list of XML document sources containingmetadata information for the endpoint (e.g.WSDL or XML Schema documents)
throws:
  java.lang.IllegalStateException - If the endpointhas already been published.



setProperties
abstract public void setProperties(Map<String, Object> properties)(Code)
Sets the property bag for this Endpoint instance.
Parameters:
  properties - The property bag associated withthis instance.



stop
abstract public void stop()(Code)
Stops publishing this endpoint. If the endpoint is not in a published state, this method has no effect.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

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