JBoss Wise API

org.jboss.wise.core.client
Interface WSEndpoint

All Known Implementing Classes:
WSEndpointImpl

@ThreadSafe
public interface WSEndpoint

This represent a Endpoint(Port) and has utility methods to edit username, password, endpoint address, attach handlers

Author:
Stefano Maestri, stefano.maestri@javalinux.it, Jim Ma

Method Summary
 void addHandler(javax.xml.ws.handler.Handler handler)
          Add an Handler to this endpoint.
 void addWSExtension(WSExtensionEnabler enabler)
          Use this method to add WSExtension you would enable on this endpoint.
 java.lang.Object createInstance()
          create the underlying instance of the endpoint generated class.
 java.lang.ClassLoader getClassLoader()
           
 java.util.List<WSExtensionEnabler> getExtensions()
           
 java.util.List<javax.xml.ws.handler.Handler<?>> getHandlers()
           
 java.lang.String getName()
           
 java.lang.String getPassword()
           
 java.lang.String getTargetUrl()
           
 java.lang.Class getUnderlyingObjectClass()
           
 java.lang.String getUsername()
           
 java.util.Map<java.lang.String,WSMethod> getWSMethods()
          Create the webmethods' map and it back.
 void setPassword(java.lang.String password)
          Set password for endpoint authentication
 void setTargetUrl(java.lang.String targetUrl)
          it give the opportunity to change target url of the endpoint defined in the wsdl
 void setUsername(java.lang.String username)
          Set username for endpoint authentication
 

Method Detail

createInstance

java.lang.Object createInstance()
create the underlying instance of the endpoint generated class. Useful to create a thread pool invoking endpoint methods.

Returns:
the created underlying instance of the endpoint generated class

setUsername

void setUsername(java.lang.String username)
Set username for endpoint authentication

Parameters:
username -

setPassword

void setPassword(java.lang.String password)
Set password for endpoint authentication

Parameters:
password -

getUnderlyingObjectClass

java.lang.Class getUnderlyingObjectClass()

getName

java.lang.String getName()
Returns:
endpoint name as defined in wsdl

addHandler

void addHandler(javax.xml.ws.handler.Handler handler)
Add an Handler to this endpoint. Handler will apply on all endpoint method called

Parameters:
handler -
See Also:
getWSMethods()

getWSMethods

java.util.Map<java.lang.String,WSMethod> getWSMethods()
Create the webmethods' map and it back. This maps would be used by clients to get a method to call and invoke it All calls of this method apply all handlers added with addHandler(Handler) method

Returns:
The list of WebMethod names

getClassLoader

java.lang.ClassLoader getClassLoader()
Returns:
classLoader used to load JAXWS generated object see also getUnderlyingObjectClass()

addWSExtension

void addWSExtension(WSExtensionEnabler enabler)
Use this method to add WSExtension you would enable on this endpoint. Of course extension have to be enabled before you cal method associated to action you are going to invoke. Not necessary before you build WSMethods object associated to this endpoint getWSMethods() see also WSExtensionEnabler for more information on how to enable WSExtensions

Parameters:
enabler - it is an implementation of WSExtensionEnabler

getHandlers

java.util.List<javax.xml.ws.handler.Handler<?>> getHandlers()
Returns:
handlers added to handler chain of this endpoint.

getExtensions

java.util.List<WSExtensionEnabler> getExtensions()
Returns:
extensions enabled on this endpoint

getTargetUrl

java.lang.String getTargetUrl()
Returns:
the target url to invoke for this endpoint

getUsername

java.lang.String getUsername()

getPassword

java.lang.String getPassword()

setTargetUrl

void setTargetUrl(java.lang.String targetUrl)
it give the opportunity to change target url of the endpoint defined in the wsdl

Parameters:
targetUrl -

JBoss Wise API

Copyright © 2008-2009 Jboss.org. All Rights Reserved.