Apache CXF API

org.apache.cxf.jaxws
Class EndpointImpl

java.lang.Object
  extended by javax.xml.ws.Endpoint
      extended by org.apache.cxf.jaxws.EndpointImpl
All Implemented Interfaces:
Configurable, InterceptorProvider
Direct Known Subclasses:
EndpointDefinitionParser.SpringEndpointImpl

public class EndpointImpl
extends Endpoint
implements InterceptorProvider, Configurable


Field Summary
static String CHECK_PUBLISH_ENDPOINT_PERMISSON_PROPERTY
          This property controls whether the 'publishEndpoint' permission is checked using only the AccessController (i.e.
static String CHECK_PUBLISH_ENDPOINT_PERMISSON_PROPERTY_WITH_SECURITY_MANAGER
           
 
Fields inherited from class javax.xml.ws.Endpoint
WSDL_PORT, WSDL_SERVICE
 
Constructor Summary
EndpointImpl(Bus bus, Object implementor)
           
EndpointImpl(Bus b, Object implementor, JaxWsServerFactoryBean sf)
           
EndpointImpl(Bus b, Object i, String bindingUri)
           
EndpointImpl(Bus b, Object i, String bindingUri, String wsdl)
           
EndpointImpl(Bus b, Object i, String bindingUri, String wsdl, WebServiceFeature[] f)
           
EndpointImpl(Bus b, Object i, String bindingUri, WebServiceFeature[] features)
           
EndpointImpl(Object implementor)
           
 
Method Summary
protected  void checkProperties()
           
protected  void checkPublishable()
          Checks the value of publishable and throws an IllegalStateException if the value is false.
protected  void checkPublishPermission()
           
protected  void doPublish(String addr)
          Performs the publication action by setting up a Server instance based on this endpoint's configuration.
 String getAddress()
           
 String getBeanName()
          Get the configurable object's Bean name
 Binding getBinding()
           
 BindingConfiguration getBindingConfig()
           
 String getBindingUri()
           
 Bus getBus()
           
 DataBinding getDataBinding()
           
 QName getEndpointName()
           
<T extends EndpointReference>
T
getEndpointReference(Class<T> clazz, Element... referenceParameters)
           
 EndpointReference getEndpointReference(Element... referenceParameters)
           
 Executor getExecutor()
           
 List<Feature> getFeatures()
           
 List<Handler> getHandlers()
           
 Object getImplementor()
           
 Class<?> getImplementorClass()
          Gets the class of the implementor.
 List<Interceptor<? extends Message>> getInFaultInterceptors()
          Returns the list of interceptors attached to the incoming fault interceptor chain of the object.
 List<Interceptor<? extends Message>> getInInterceptors()
          Returns the list of interceptors attached to the incoming interceptor chain of the object.
 Invoker getInvoker()
           
 List<Source> getMetadata()
           
 List<Interceptor<? extends Message>> getOutFaultInterceptors()
          Returns the list of interceptors attached to the outgoing fault interceptor chain of the object.
 List<Interceptor<? extends Message>> getOutInterceptors()
          Returns the list of interceptors attached to the outgoing interceptor chain of the object.
 Map<String,Object> getProperties()
           
 String getPublishedEndpointUrl()
          The published endpoint url is used for excplicitely specifying the url of the endpoint that would show up the generated wsdl definition, when the service is brought on line.
 List<String> getSchemaLocations()
           
 ServerImpl getServer()
           
 ServerImpl getServer(String addr)
           
 JaxWsServerFactoryBean getServerFactory()
           
 Service getService()
           
 JaxWsServiceFactoryBean getServiceFactory()
           
 QName getServiceName()
           
 String getTransportId()
           
 String getWsdlLocation()
           
 boolean isPublished()
           
 void publish()
           
 void publish(Object arg0)
          

This implementation performs no action except to check the publish permission.

 void publish(String addr)
           
 void setAddress(String address)
           
 void setBindingConfig(BindingConfiguration config)
           
 void setBindingUri(String binding)
           
 void setBus(Bus b)
           
 void setDataBinding(DataBinding dataBinding)
           
 void setEndpointName(QName endpointName)
           
 void setExecutor(Executor executor)
           
 void setFeatures(List<? extends Feature> features)
           
 void setHandlers(List<Handler> h)
           
 void setImplementorClass(Class<?> implementorClass)
           
 void setInFaultInterceptors(List<Interceptor<? extends Message>> interceptors)
           
 void setInInterceptors(List<Interceptor<? extends Message>> interceptors)
           
 void setInvoker(Invoker invoker)
           
 void setMetadata(List<Source> metadata)
           
 void setOutFaultInterceptors(List<Interceptor<? extends Message>> interceptors)
           
 void setOutInterceptors(List<Interceptor<? extends Message>> interceptors)
           
 void setProperties(Map<String,Object> properties)
           
 void setPublishedEndpointUrl(String publishedEndpointUrl)
           
 void setSchemaLocations(List<String> schemaLocations)
           
protected  void setServerFactory(JaxWsServerFactoryBean bean)
           
 void setServiceFactory(JaxWsServiceFactoryBean sf)
           
 void setServiceName(QName serviceName)
           
 void setTransportId(String transportId)
           
 void setWsdlLocation(String wsdlLocation)
           
 void stop()
           
 
Methods inherited from class javax.xml.ws.Endpoint
create, create, publish
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CHECK_PUBLISH_ENDPOINT_PERMISSON_PROPERTY

public static final String CHECK_PUBLISH_ENDPOINT_PERMISSON_PROPERTY
This property controls whether the 'publishEndpoint' permission is checked using only the AccessController (i.e. when SecurityManager is not installed). By default this check is not done as the system property is not set.

See Also:
Constant Field Values

CHECK_PUBLISH_ENDPOINT_PERMISSON_PROPERTY_WITH_SECURITY_MANAGER

public static final String CHECK_PUBLISH_ENDPOINT_PERMISSON_PROPERTY_WITH_SECURITY_MANAGER
See Also:
Constant Field Values
Constructor Detail

EndpointImpl

public EndpointImpl(Object implementor)

EndpointImpl

public EndpointImpl(Bus b,
                    Object implementor,
                    JaxWsServerFactoryBean sf)

EndpointImpl

public EndpointImpl(Bus b,
                    Object i,
                    String bindingUri,
                    String wsdl)
Parameters:
b -
i - The implementor object.
bindingUri - The URI of the Binding being used. Optional.
wsdl - The URL of the WSDL for the service, if different than the URL specified on the WebService annotation. Optional.

EndpointImpl

public EndpointImpl(Bus b,
                    Object i,
                    String bindingUri,
                    String wsdl,
                    WebServiceFeature[] f)

EndpointImpl

public EndpointImpl(Bus b,
                    Object i,
                    String bindingUri)

EndpointImpl

public EndpointImpl(Bus b,
                    Object i,
                    String bindingUri,
                    WebServiceFeature[] features)

EndpointImpl

public EndpointImpl(Bus bus,
                    Object implementor)
Method Detail

setBus

public void setBus(Bus b)

getBus

public Bus getBus()

getBinding

public Binding getBinding()
Specified by:
getBinding in class Endpoint

setExecutor

public void setExecutor(Executor executor)
Specified by:
setExecutor in class Endpoint

getExecutor

public Executor getExecutor()
Specified by:
getExecutor in class Endpoint

getService

public Service getService()

getServiceFactory

public JaxWsServiceFactoryBean getServiceFactory()

getImplementor

public Object getImplementor()
Specified by:
getImplementor in class Endpoint

getImplementorClass

public Class<?> getImplementorClass()
Gets the class of the implementor.

Returns:
the class of the implementor object

getMetadata

public List<Source> getMetadata()
Specified by:
getMetadata in class Endpoint

getProperties

public Map<String,Object> getProperties()
Specified by:
getProperties in class Endpoint

isPublished

public boolean isPublished()
Specified by:
isPublished in class Endpoint

publish

public void publish(Object arg0)

This implementation performs no action except to check the publish permission.

Specified by:
publish in class Endpoint

publish

public void publish(String addr)
Specified by:
publish in class Endpoint

setServiceFactory

public void setServiceFactory(JaxWsServiceFactoryBean sf)

setMetadata

public void setMetadata(List<Source> metadata)
Specified by:
setMetadata in class Endpoint

setProperties

public void setProperties(Map<String,Object> properties)
Specified by:
setProperties in class Endpoint

stop

public void stop()
Specified by:
stop in class Endpoint

getBeanName

public String getBeanName()
Description copied from interface: Configurable
Get the configurable object's Bean name

Specified by:
getBeanName in interface Configurable
Returns:
the bean name

getServerFactory

public JaxWsServerFactoryBean getServerFactory()

setServerFactory

protected void setServerFactory(JaxWsServerFactoryBean bean)

checkProperties

protected void checkProperties()

doPublish

protected void doPublish(String addr)
Performs the publication action by setting up a Server instance based on this endpoint's configuration.

Parameters:
addr - the optional endpoint address.
Throws:
IllegalStateException - if the endpoint cannot be published/republished
SecurityException - if permission checking is enabled and policy forbids publishing
WebServiceException - if there is an error publishing the endpoint
See Also:
checkPublishPermission(), checkPublishable(), getServer(String)

getServer

public ServerImpl getServer()

getServer

public ServerImpl getServer(String addr)

checkPublishPermission

protected void checkPublishPermission()

checkPublishable

protected void checkPublishable()
Checks the value of publishable and throws an IllegalStateException if the value is false.

Throws:
IllegalStateException - if publishable is false

publish

public void publish()

getAddress

public String getAddress()

setAddress

public void setAddress(String address)

getPublishedEndpointUrl

public String getPublishedEndpointUrl()
The published endpoint url is used for excplicitely specifying the url of the endpoint that would show up the generated wsdl definition, when the service is brought on line.

Returns:

setPublishedEndpointUrl

public void setPublishedEndpointUrl(String publishedEndpointUrl)

getEndpointName

public QName getEndpointName()

setEndpointName

public void setEndpointName(QName endpointName)

getServiceName

public QName getServiceName()

setServiceName

public void setServiceName(QName serviceName)

getWsdlLocation

public String getWsdlLocation()

setWsdlLocation

public void setWsdlLocation(String wsdlLocation)

setBindingUri

public void setBindingUri(String binding)

getBindingUri

public String getBindingUri()

setDataBinding

public void setDataBinding(DataBinding dataBinding)

getDataBinding

public DataBinding getDataBinding()

getOutFaultInterceptors

public List<Interceptor<? extends Message>> getOutFaultInterceptors()
Description copied from interface: InterceptorProvider
Returns the list of interceptors attached to the outgoing fault interceptor chain of the object.

Specified by:
getOutFaultInterceptors in interface InterceptorProvider
Returns:
List outgoing fault interceptor chain

getInFaultInterceptors

public List<Interceptor<? extends Message>> getInFaultInterceptors()
Description copied from interface: InterceptorProvider
Returns the list of interceptors attached to the incoming fault interceptor chain of the object.

Specified by:
getInFaultInterceptors in interface InterceptorProvider
Returns:
List incoming fault interceptor chain

getInInterceptors

public List<Interceptor<? extends Message>> getInInterceptors()
Description copied from interface: InterceptorProvider
Returns the list of interceptors attached to the incoming interceptor chain of the object.

Specified by:
getInInterceptors in interface InterceptorProvider
Returns:
List incoming interceptor chain

getOutInterceptors

public List<Interceptor<? extends Message>> getOutInterceptors()
Description copied from interface: InterceptorProvider
Returns the list of interceptors attached to the outgoing interceptor chain of the object.

Specified by:
getOutInterceptors in interface InterceptorProvider
Returns:
List outgoing interceptor chain

setInInterceptors

public void setInInterceptors(List<Interceptor<? extends Message>> interceptors)

setInFaultInterceptors

public void setInFaultInterceptors(List<Interceptor<? extends Message>> interceptors)

setOutInterceptors

public void setOutInterceptors(List<Interceptor<? extends Message>> interceptors)

setOutFaultInterceptors

public void setOutFaultInterceptors(List<Interceptor<? extends Message>> interceptors)

setHandlers

public void setHandlers(List<Handler> h)

getHandlers

public List<Handler> getHandlers()

getFeatures

public List<Feature> getFeatures()

setFeatures

public void setFeatures(List<? extends Feature> features)

getInvoker

public Invoker getInvoker()

setInvoker

public void setInvoker(Invoker invoker)

setImplementorClass

public void setImplementorClass(Class<?> implementorClass)

setTransportId

public void setTransportId(String transportId)

getTransportId

public String getTransportId()

setBindingConfig

public void setBindingConfig(BindingConfiguration config)

getBindingConfig

public BindingConfiguration getBindingConfig()

getSchemaLocations

public List<String> getSchemaLocations()

setSchemaLocations

public void setSchemaLocations(List<String> schemaLocations)

getEndpointReference

public EndpointReference getEndpointReference(Element... referenceParameters)
Specified by:
getEndpointReference in class Endpoint

getEndpointReference

public <T extends EndpointReference> T getEndpointReference(Class<T> clazz,
                                                            Element... referenceParameters)
Specified by:
getEndpointReference in class Endpoint

Apache CXF API

Apache CXF