UDDIClerk (jUDDI Client side Code 3.3.10 API)

java.lang.Object
- org.apache.juddi.v3.client.config.UDDIClerk

All Implemented Interfaces:

Serializable
```
public class UDDIClerk
extends Object
implements Serializable
```
The UDDIClerk provides an easy way to access a UDDI service. The clerk can be configured programmatically, but it is recommended to specify the server endpoint and access credentials in a uddi.xml file. Recommended use:
```
 
 UDDIClient uddiClient = new UDDIClient();
 UDDIClerk clerk = uddiClient.getClerk(clerkName);
 
 
```
where the clerkName "MyClerk" is defined as attribute on the clerk element
```
 
  <clerks registerOnStartup="true">
    <clerk name="MyClerk" node="default" publisher="root" password="root" isPasswordEncrypted="false" cryptoProvider="">
      <class>org.apache.juddi.example.HelloWorldImpl</class>
    </clerk>
  </clerks>
 
 
```
Credentials: In the clerk section you need to specify the publisher to be used, as well the password. The password can be encrypted and a cryptoProvider class can be set. UDDI Annotations: If you want to register classes containing UDDIAnnotations, then you need to set registerOnStartup="true" and you can list the classes with the annotations as subelements. See the HelloWorldImpl class above, as well as the uddi-annotations example.
Author:

kstam

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UDDIClerk.WSDL
Internal classed used for wsdl registration

Nested Classes
Modifier and Type	Class and Description
`static class`	`UDDIClerk.WSDL` Internal classed used for wsdl registration

Field Summary

Fields
Modifier and Type Field and Description

protected String name

protected String password

protected String publisher

protected UDDINode uddiNode

Fields
Modifier and Type	Field and Description
`protected String`	`name`
`protected String`	`password`
`protected String`	`publisher`
`protected UDDINode`	`uddiNode`

Constructor Summary

Constructors
Constructor and Description
`UDDIClerk()` use caution calling the default constructor, many of the functions of the UDDI Clerk will not function unless manually set.
`UDDIClerk(org.apache.juddi.api_v3.Clerk clerk)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static org.uddi.api_v3.TModel`	`createKeyGenator(String partitionName, String DescriptiveName, String DescriptiveNameLanguage)` A helper function to create a tModel key generator. Why would I want a key generator? In UDDIv3, you're suppose to specify what you want the keys (unique identifiers) to be, however there's a number of naming rules associated with the keys.
`static org.uddi.api_v3.TModelInstanceInfo`	`createServiceInterfaceVersion(String version, String lang)` This is a convenience function that will build and return a TModelInstanceInfo as described in the following link that will enable you to tag web services registered in UDDI with some kind of version information. Article source: http://www.ibm.com/developerworks/webservices/library/ws-version/ When using this tModel as a tModelInstance, it can be used to describe a version associated with either a service interface, a bindingTemplate service instance.
`void`	`discardAuthToken()` kills the current auth token, aka Logout current Node
`void`	`discardAuthToken(String token)` kills the provided auth token, aka Logout
`void`	`discardAuthToken(String token, String endpoint)` kills the provided auth token, aka Logout
`org.uddi.api_v3.BusinessEntity`	`findBusiness(String businessKey)` Deprecated. Use getBusinessDetail instead
`org.uddi.api_v3.BusinessEntity`	`findBusiness(String businessKey, org.apache.juddi.api_v3.Node node)` Deprecated. Use getBusinessDetail instead
`org.uddi.api_v3.RelatedBusinessesList`	`findRelatedBusinesses(String businessKey, org.apache.juddi.api_v3.Node node)` Looks up the BusinessEntity in the registry for "related" businesses.
`org.uddi.api_v3.BusinessService`	`findService(String serviceKey)` Deprecated. see getServiceDetail
`org.uddi.api_v3.BusinessService`	`findService(String serviceKey, org.apache.juddi.api_v3.Node node)` Deprecated. see getServiceDetail
`org.uddi.api_v3.BindingTemplate`	`findServiceBinding(String bindingKey)` Deprecated. see getServiceBindingDetail
`org.uddi.api_v3.BindingTemplate`	`findServiceBinding(String bindingKey, org.apache.juddi.api_v3.Node node)` Deprecated. use getServiceBindingDetail instead
`org.uddi.api_v3.TModelList`	`findTModel(org.uddi.api_v3.FindTModel findTModel)` finds a tmodel.
`org.uddi.api_v3.TModelList`	`findTModel(org.uddi.api_v3.FindTModel findTModel, org.apache.juddi.api_v3.Node node)` finds a tModel
`org.apache.juddi.api_v3.Clerk`	`getApiClerk()` The API Clerk is the JAXWS generated "Clerk" element that is used both on the jUDDI Client and on the jUDDI Web Service (not part of the UDDI spec).
`String`	`getAuthToken()` Gets an auth token from the uddi server using the uddi auth token Notice: never log auth tokens! Treat it like a password Calls
`String`	`getAuthToken(String endpointURL)` Gets an auth token from the uddi server using the uddi auth token Notice: never log auth tokens! Treat it like a password notes: changed to public to have access from the subscription callback API 8/20/2013 AO
`static Set<org.uddi.api_v3.BindingTemplate>`	`getBindingByVersion(String version, List<org.uddi.api_v3.BindingTemplate> bindingTemplate)` This is a convenience function that will filter a list of binding templates and return a list of bindings matching the specified version number.
`org.uddi.api_v3.BusinessEntity`	`getBusinessDetail(String businessKey)` Looks up the BusinessEntiry in the registry, will return null if is not found.
`org.uddi.api_v3.BusinessEntity`	`getBusinessDetail(String businessKey, org.apache.juddi.api_v3.Node node)` Looks up the BusinessEntiry in the registry, will return null if is not found.
`String[]`	`getClassWithAnnotations()` A list of classes defined in the config file that have UDDI Annotations on them for automated registration client.clerks.clerk(" + i + ").class
`String`	`getCryptoProvider()` client.clerks.clerk(" + i + ")[@cryptoProvider]
`List<String>`	`getEndpoints(String serviceKey)` JUDDI-700 This implements the "find_endpoints" pattern as described in Alex O'Ree's Master's Thesis on UDDI.
`boolean`	`getIsPasswordEncrypted()` client.clerks.clerk(" + i + ")[@isPasswordEncrypted]
`String`	`getManagerName()` The client manager name as defined in the config file client[@name]
`String`	`getName()` client.clerks.clerk(" + i + ")[@name]
`String`	`getPassword()` If the password is encrypted, it will be decrypted if possible, otherwise the cipher text will be returned.
`String`	`getPublisher()` This is the username client.clerks.clerk(" + i + ")[@publisher]
`String`	`getRawPassword()` If the password is encrypted, it cipher text is returned, otherwise the clear text will be returned.
`org.uddi.api_v3.BindingTemplate`	`getServiceBindingDetail(String bindingKey)` gets a binding detail by key
`org.uddi.api_v3.BindingTemplate`	`getServiceBindingDetail(String bindingKey, org.apache.juddi.api_v3.Node node)` Gets the details of a specific service binding key
`org.uddi.api_v3.ServiceDetail`	`getServiceDetail(org.uddi.api_v3.GetServiceDetail getDetail)` Gets service details or NULL if it doesn't exist or an error occurred
`org.uddi.api_v3.ServiceDetail`	`getServiceDetail(org.uddi.api_v3.GetServiceDetail getDetail, org.apache.juddi.api_v3.Node node)` Gets service details or NULL if it doesn't exist or an error occurred
`org.uddi.api_v3.BusinessService`	`getServiceDetail(String serviceKey)` Finds a service by the key, .
`org.uddi.api_v3.BusinessService`	`getServiceDetail(String serviceKey, org.apache.juddi.api_v3.Node node)` Finds a service by the key, referencing the specific Node from the configuration file
`Map<String,Properties>`	`getServices()` Deprecated.
`org.uddi.api_v3.TModelDetail`	`getTModelDetail(org.uddi.api_v3.GetTModelDetail getTModelDetail)` Gets the details of a tModel by the key.
`org.uddi.api_v3.TModelDetail`	`getTModelDetail(org.uddi.api_v3.GetTModelDetail getTModelDetail, org.apache.juddi.api_v3.Node node)` Gets the details of a tModel by the key using the referenced Node from the config file
`org.uddi.api_v3.TModelDetail`	`getTModelDetail(String tModelKey)` Gets the details of a tModel by the key.
`UDDINode`	`getUDDINode()` Returns the UDDI node that this clerk is associated with client.clerks.clerk(" + i + ")@node
`UDDINode`	`getUDDINode(org.apache.juddi.api_v3.Node apinode)`
`UDDIClerk.WSDL[]`	`getWsdls()` Used for the automated registration of services via WSDL2UDDI config file: client.clerks.clerk(" + i + ").wsdl
`org.uddi.api_v3.BindingTemplate`	`register(org.uddi.api_v3.BindingTemplate binding)` Register a BindingTemplate, using the node of current clerk ('this').
`org.uddi.api_v3.BindingTemplate`	`register(org.uddi.api_v3.BindingTemplate binding, org.apache.juddi.api_v3.Node node)` Register a BindingTemplate.
`org.uddi.api_v3.BusinessEntity`	`register(org.uddi.api_v3.BusinessEntity business)` registers a UDDI business.
`org.uddi.api_v3.BusinessEntity`	`register(org.uddi.api_v3.BusinessEntity business, org.apache.juddi.api_v3.Node node)` Registers a UDDI Business referencing the specified Node from the config file
`org.uddi.api_v3.BusinessService`	`register(org.uddi.api_v3.BusinessService service)` Register a service, using the node of current clerk ('this').
`org.uddi.api_v3.BusinessService`	`register(org.uddi.api_v3.BusinessService service, org.apache.juddi.api_v3.Node node)` Register a service.
`org.uddi.sub_v3.Subscription`	`register(org.uddi.sub_v3.Subscription subscription)` Registers the Subscription that is passed in to the UDDI node for this clerk.
`org.uddi.sub_v3.Subscription`	`register(org.uddi.sub_v3.Subscription subscription, org.apache.juddi.api_v3.Node node)` Register a Subscription to UDDI node passed in.
`org.uddi.api_v3.TModelDetail`	`register(org.uddi.api_v3.TModel tModel)` Register a tModel, using the node of current clerk ('this').
`org.uddi.api_v3.TModelDetail`	`register(org.uddi.api_v3.TModel tModel, org.apache.juddi.api_v3.Node node)` Register a tModel.
`void`	`registerWsdls()` Performans the process of parsing the configuration defined wsdls to UDDI.
`void`	`registerWsdls(javax.wsdl.Definition wsdlDefinition, String keyDomain, String businessKey)` Registers a WSDL Definition onto the UDDI node referenced by the clerk.
`void`	`registerWsdls(URL localizerBaseUrl)` Registers the WSDL files referenced in the clerk onto the UDDI node referenced by the clerk.
`org.apache.juddi.api_v3.ClerkDetail`	`saveClerk(UDDIClerk senderClerk)` This calls a jUDDI implementation specific API call and is used to help configure internode communication between jUDDI servers.
`org.apache.juddi.api_v3.NodeDetail`	`saveNode(org.apache.juddi.api_v3.Node node)` This calls a jUDDI implementation specific API call and is used to help configure internode communication between jUDDI servers.
`void`	`setClassWithAnnotations(String[] classWithAnnotations)` A list of classes defined in the config file that have UDDI Annotations on them for automated registration client.clerks.clerk(" + i + ").class
`void`	`setCryptoProvider(String clazz)` client.clerks.clerk(" + i + ")[@cryptoProvider]
`void`	`setIsPasswordEncrypted(boolean option)` client.clerks.clerk(" + i + ")[@isPasswordEncrypted] default is false
`void`	`setManagerName(String managerName)` The client manager name as defined in the config file client[@name]
`void`	`setName(String name)` client.clerks.clerk(" + i + ")[@name]
`void`	`setPassword(String password)` Use with caution, don't forget to set the IsEncrypted and Crypto provider client.clerks.clerk(" + i + ")[@password]
`void`	`setPublisher(String publisher)` This is the username client.clerks.clerk(" + i + ")[@publisher]
`void`	`setServices(Map<String,Properties> services)` Deprecated.
`void`	`setUDDINode(UDDINode uddiNode)` client.clerks.clerk(" + i + ")[@node] reference to UDDI Node
`void`	`setWsdls(UDDIClerk.WSDL[] wsdls)` Used for the automated registration of services via WSDL2UDDI config file: client.clerks.clerk(" + i + ").wsdl
`void`	`unRegisterBinding(String bindingKey)` removes a binding by key.
`void`	`unRegisterBinding(String bindingKey, org.apache.juddi.api_v3.Node node)` Unregisters the BindingTemplate with specified bindingKey and referenced node defined in the config file Note, if registration fails, no exception is thrown
`void`	`unRegisterBusiness(String businessKey)` removes a business from UDDI.
`void`	`unRegisterBusiness(String businessKey, org.apache.juddi.api_v3.Node node)` Unregisters the service with specified serviceKey using the specified Node, as defined in the config file Note, if registration fails, no exception is thrown
`void`	`unRegisterService(String serviceKey)` removes a service by key.
`void`	`unRegisterService(String serviceKey, org.apache.juddi.api_v3.Node node)` Unregisters the service with specified serviceKey.
`void`	`unRegisterSubscription(String subscriptionKey)` removes a subscription by key.
`void`	`unRegisterSubscription(String subscriptionKey, org.apache.juddi.api_v3.Node node)` removes a subscription by key, referencing the specified node in the config file Note, if registration fails, no exception is thrown
`void`	`unRegisterTModel(String tModelKey)` removes a tModel.
`void`	`unRegisterTModel(String tModelKey, org.apache.juddi.api_v3.Node node)` Unregisters the BindingTemplate with specified bindingKey.
`void`	`unRegisterWsdls()` Removes the UDDI data structures belonging to the WSDLs for this clerk from the UDDI node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
protected String name
```
  - uddiNode
```
protected UDDINode uddiNode
```
  - publisher
```
protected String publisher
```
  - password
```
protected String password
```
- Constructor Detail
  - UDDIClerk
```
public UDDIClerk()
```
    use caution calling the default constructor, many of the functions of the UDDI Clerk will not function unless manually set. The Node must be set for using most of the functions provided by this class.
  - UDDIClerk
```
public UDDIClerk(org.apache.juddi.api_v3.Clerk clerk)
```
- Method Detail
  - getClassWithAnnotations
```
public String[] getClassWithAnnotations()
```
    A list of classes defined in the config file that have UDDI Annotations on them for automated registration
    client.clerks.clerk(" + i + ").class
    
    Returns:
    
    classes with UDDI Annotations
    
    See Also:
    
    UDDIService, UDDIServiceBinding
  - getUDDINode
```
public UDDINode getUDDINode()
```
    Returns the UDDI node that this clerk is associated with client.clerks.clerk(" + i + ")@node
    
    Returns:
    
    UDDINode
  - getUDDINode
```
public UDDINode getUDDINode(org.apache.juddi.api_v3.Node apinode)
```
  - setClassWithAnnotations
```
public void setClassWithAnnotations(String[] classWithAnnotations)
```
    A list of classes defined in the config file that have UDDI Annotations on them for automated registration
    client.clerks.clerk(" + i + ").class
    
    See Also:
    
    UDDIService, UDDIServiceBinding
  - getServices
```
@Deprecated
public Map<String,Properties> getServices()
```
    Deprecated.
    
    This is not used within the jUDDI code base and will be removed in the next release
    
    Returns:
    
    a map
  - setServices
```
@Deprecated
public void setServices(Map<String,Properties> services)
```
    Deprecated.
    
    This is not used within the jUDDI code base and will be removed in the next release
    
    Parameters:
    
    services -
  - getManagerName
```
public String getManagerName()
```
    The client manager name as defined in the config file client[@name]
    
    Returns:
    
    the manager name
  - setManagerName
```
public void setManagerName(String managerName)
```
    The client manager name as defined in the config file client[@name]
    
    Parameters:
    
    managerName -
  - registerWsdls
```
public void registerWsdls()
```
    Performans the process of parsing the configuration defined wsdls to UDDI. This is a convenience wrapper Note, if registration fails, no exception is thrown
  - registerWsdls
```
public void registerWsdls(URL localizerBaseUrl)
```
    Registers the WSDL files referenced in the clerk onto the UDDI node referenced by the clerk. Note, if registration fails, no exception is thrown
```
 
 <clerks registerOnStartup="false">
     <clerk name="joe" node="default" publisher="joepublisher" password="joepublisher" isPasswordEncrypted="false" cryptoProvider="">
        <wsdl businessName="WSDL-Business">wsdl/helloworld.wsdl</wsdl>
     </clerk>
  </clerks>
 
 
```
    Parameters:
    
    localizerBaseUrl - - The baseUrl part which will be used when building the bindingTemplate.
  - registerWsdls
```
public void registerWsdls(javax.wsdl.Definition wsdlDefinition,
                          String keyDomain,
                          String businessKey)
```
    Registers a WSDL Definition onto the UDDI node referenced by the clerk. Note, if registration fails, no exception is thrown
    
    Parameters:
    
    wsdlDefinition - - the WSDL Definition
    
    keyDomain - - the keyDomain which will be used to construct the UDDI key IDs. If left null the keyDomain defined in the node's properties will be used.
    
    businessKey - - the key of the business to which this service belongs. If left null the businessKey defined in the node's properties will be used.
  - unRegisterWsdls
```
public void unRegisterWsdls()
```
    Removes the UDDI data structures belonging to the WSDLs for this clerk from the UDDI node. Note, if registration fails, no exception is thrown
  - register
```
public org.uddi.sub_v3.Subscription register(org.uddi.sub_v3.Subscription subscription)
```
    Registers the Subscription that is passed in to the UDDI node for this clerk. Note, if registration fails, no exception is thrown
    
    Parameters:
    
    subscription -
    
    Returns:
    
    a subscription object, or null if failed
  - register
```
public org.uddi.sub_v3.Subscription register(org.uddi.sub_v3.Subscription subscription,
                                             org.apache.juddi.api_v3.Node node)
```
    Register a Subscription to UDDI node passed in. Make sure you use a clerk that has credentials for this node. Note, if registration fails, no exception is thrown
    
    Parameters:
    
    subscription - a UDDI subscription, remember only one filter type is allowed by UDDI
    
    node - the UDDI node referenced from the config file
    
    Returns:
    
    the potentially UDDI server modified subscription
  - register
```
public org.uddi.api_v3.TModelDetail register(org.uddi.api_v3.TModel tModel)
```
    Register a tModel, using the node of current clerk ('this'). Note, if registration fails, no exception is thrown
    
    Parameters:
    
    tModel -
    
    Returns:
    
    the TModelDetail of the newly registered TModel
  - register
```
public org.uddi.api_v3.TModelDetail register(org.uddi.api_v3.TModel tModel,
                                             org.apache.juddi.api_v3.Node node)
```
    Register a tModel. Note, if registration fails, no exception is thrown
    
    Parameters:
    
    tModel -
    
    node -
    
    Returns:
    
    a tModel object or null if registration failed
  - register
```
public org.uddi.api_v3.BindingTemplate register(org.uddi.api_v3.BindingTemplate binding)
```
    Register a BindingTemplate, using the node of current clerk ('this'). Note, if registration fails, no exception is thrown
    
    Parameters:
    
    binding -
    
    Returns:
    
    a binding object or null
  - register
```
public org.uddi.api_v3.BindingTemplate register(org.uddi.api_v3.BindingTemplate binding,
                                                org.apache.juddi.api_v3.Node node)
```
    Register a BindingTemplate. Note, if registration fails, no exception is thrown
    
    Parameters:
    
    binding -
    
    node -
    
    Returns:
    
    a binding object or null
  - register
```
public org.uddi.api_v3.BusinessService register(org.uddi.api_v3.BusinessService service)
```
    Register a service, using the node of current clerk ('this'). Note, if registration fails, no exception is thrown and null is returned
    
    Parameters:
    
    service -
    
    Returns:
    
    a service object or null
  - register
```
public org.uddi.api_v3.BusinessService register(org.uddi.api_v3.BusinessService service,
                                                org.apache.juddi.api_v3.Node node)
```
    Register a service. Note, if registration fails, no exception is thrown
    
    Parameters:
    
    service - the element returned by the server, it may be modified from the original
    
    node -
    
    Returns:
    
    the potentially modified service by the UDDI server or NULL if save failed
  - register
```
public org.uddi.api_v3.BusinessEntity register(org.uddi.api_v3.BusinessEntity business)
```
    registers a UDDI business. This is a convenience wrapper
    
    Parameters:
    
    business -
    
    Returns:
    
    a possibility modified business entity as registered or NULL if the save failed
  - register
```
public org.uddi.api_v3.BusinessEntity register(org.uddi.api_v3.BusinessEntity business,
                                               org.apache.juddi.api_v3.Node node)
```
    Registers a UDDI Business referencing the specified Node from the config file
    
    Parameters:
    
    business -
    
    node -
    
    Returns:
    
    a possibility modified business entity as registered or NULL if the save failed
  - unRegisterBusiness
```
public void unRegisterBusiness(String businessKey)
```
    removes a business from UDDI. This is a convenience wrapper Note, if registration fails, no exception is thrown
    
    Parameters:
    
    businessKey -
  - unRegisterBusiness
```
public void unRegisterBusiness(String businessKey,
                               org.apache.juddi.api_v3.Node node)
```
    Unregisters the service with specified serviceKey using the specified Node, as defined in the config file Note, if registration fails, no exception is thrown
    
    Parameters:
    
    businessKey -
    
    node -
  - unRegisterService
```
public void unRegisterService(String serviceKey)
```
    removes a service by key. This is a convenience wrapper Note, if registration fails, no exception is thrown
    
    Parameters:
    
    serviceKey -
  - unRegisterService
```
public void unRegisterService(String serviceKey,
                              org.apache.juddi.api_v3.Node node)
```
    Unregisters the service with specified serviceKey. Note, if registration fails, no exception is thrown
    
    Parameters:
    
    serviceKey -
    
    node -
  - unRegisterBinding
```
public void unRegisterBinding(String bindingKey)
```
    removes a binding by key. This is a convenience wrapper Note, if registration fails, no exception is thrown
    
    Parameters:
    
    bindingKey -
  - unRegisterBinding
```
public void unRegisterBinding(String bindingKey,
                              org.apache.juddi.api_v3.Node node)
```
    Unregisters the BindingTemplate with specified bindingKey and referenced node defined in the config file Note, if registration fails, no exception is thrown
    
    Parameters:
    
    bindingKey -
    
    node -
  - unRegisterTModel
```
public void unRegisterTModel(String tModelKey)
```
    removes a tModel. Note, UDDI just flags tModels as deleted, it will still be accessible but not returned in a search. This is a convenience wrapper Note, if registration fails, no exception is thrown
    
    Parameters:
    
    tModelKey -
  - unRegisterTModel
```
public void unRegisterTModel(String tModelKey,
                             org.apache.juddi.api_v3.Node node)
```
    Unregisters the BindingTemplate with specified bindingKey. Note, if registration fails, no exception is thrown
    
    Parameters:
    
    tModelKey -
    
    node -
  - unRegisterSubscription
```
public void unRegisterSubscription(String subscriptionKey)
```
    removes a subscription by key. This is a convenience wrapper Note, if registration fails, no exception is thrown
    
    Parameters:
    
    subscriptionKey -
  - unRegisterSubscription
```
public void unRegisterSubscription(String subscriptionKey,
                                   org.apache.juddi.api_v3.Node node)
```
    removes a subscription by key, referencing the specified node in the config file Note, if registration fails, no exception is thrown
    
    Parameters:
    
    subscriptionKey -
    
    node -
  - findTModel
```
public org.uddi.api_v3.TModelList findTModel(org.uddi.api_v3.FindTModel findTModel)
                                      throws RemoteException,
                                             org.apache.commons.configuration.ConfigurationException,
                                             TransportException
```
    finds a tmodel. This is a convenience wrapper
    
    Parameters:
    
    findTModel -
    
    Returns:
    
    null if not found or error
    
    Throws:
    
    RemoteException
    
    org.apache.commons.configuration.ConfigurationException
    
    TransportException
  - findTModel
```
public org.uddi.api_v3.TModelList findTModel(org.uddi.api_v3.FindTModel findTModel,
                                             org.apache.juddi.api_v3.Node node)
                                      throws RemoteException,
                                             TransportException,
                                             org.apache.commons.configuration.ConfigurationException
```
    finds a tModel
    
    Parameters:
    
    findTModel -
    
    node -
    
    Returns:
    
    null if not found or error
    
    Throws:
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - getTModelDetail
```
public org.uddi.api_v3.TModelDetail getTModelDetail(String tModelKey)
                                             throws RemoteException,
                                                    org.apache.commons.configuration.ConfigurationException,
                                                    TransportException
```
    Gets the details of a tModel by the key. This is a convenience wrapper
    
    Parameters:
    
    tModelKey -
    
    Returns:
    
    null if not found or error, otherwise the details of the tModel(s)
    
    Throws:
    
    RemoteException
    
    org.apache.commons.configuration.ConfigurationException
    
    TransportException
  - getTModelDetail
```
public org.uddi.api_v3.TModelDetail getTModelDetail(org.uddi.api_v3.GetTModelDetail getTModelDetail)
                                             throws RemoteException,
                                                    org.apache.commons.configuration.ConfigurationException,
                                                    TransportException
```
    Gets the details of a tModel by the key. This is a convenience wrapper
    
    Parameters:
    
    getTModelDetail -
    
    Returns:
    
    null if not found or error
    
    Throws:
    
    RemoteException
    
    org.apache.commons.configuration.ConfigurationException
    
    TransportException
  - getTModelDetail
```
public org.uddi.api_v3.TModelDetail getTModelDetail(org.uddi.api_v3.GetTModelDetail getTModelDetail,
                                                    org.apache.juddi.api_v3.Node node)
                                             throws RemoteException,
                                                    TransportException,
                                                    org.apache.commons.configuration.ConfigurationException
```
    Gets the details of a tModel by the key using the referenced Node from the config file
    
    Parameters:
    
    getTModelDetail -
    
    node -
    
    Returns:
    
    null if not found or error
    
    Throws:
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - getServiceDetail
```
public org.uddi.api_v3.BusinessService getServiceDetail(String serviceKey)
                                                 throws RemoteException,
                                                        TransportException,
                                                        org.apache.commons.configuration.ConfigurationException
```
    Finds a service by the key, . This is a convenience wrapper
    
    Parameters:
    
    serviceKey -
    
    Returns:
    
    null if not found or error
    
    Throws:
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - findService
```
@Deprecated
public org.uddi.api_v3.BusinessService findService(String serviceKey)
                                                         throws RemoteException,
                                                                TransportException,
                                                                org.apache.commons.configuration.ConfigurationException
```
    Deprecated. see getServiceDetail
    
    Finds a service by the key, . This is a convenience wrapper
    
    Parameters:
    
    serviceKey -
    
    Returns:
    
    null if not found or error
    
    Throws:
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - findService
```
@Deprecated
public org.uddi.api_v3.BusinessService findService(String serviceKey,
                                                                org.apache.juddi.api_v3.Node node)
                                                         throws RemoteException,
                                                                TransportException,
                                                                org.apache.commons.configuration.ConfigurationException
```
    Deprecated. see getServiceDetail
    
    Finds a service by the key, referencing the specific Node from the configuration file
    
    Parameters:
    
    serviceKey -
    
    node -
    
    Returns:
    
    null if not found or error
    
    Throws:
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - getServiceDetail
```
public org.uddi.api_v3.BusinessService getServiceDetail(String serviceKey,
                                                        org.apache.juddi.api_v3.Node node)
                                                 throws RemoteException,
                                                        TransportException,
                                                        org.apache.commons.configuration.ConfigurationException
```
    Finds a service by the key, referencing the specific Node from the configuration file
    
    Parameters:
    
    serviceKey -
    
    node -
    
    Returns:
    
    null if not found or error
    
    Throws:
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - findServiceBinding
```
@Deprecated
public org.uddi.api_v3.BindingTemplate findServiceBinding(String bindingKey)
                                                                throws org.uddi.v3_service.DispositionReportFaultMessage,
                                                                       RemoteException,
                                                                       TransportException,
                                                                       org.apache.commons.configuration.ConfigurationException
```
    Deprecated. see getServiceBindingDetail
    
    Parameters:
    
    bindingKey -
    
    Returns:
    
    returns a binding template or null if not found
    
    Throws:
    
    org.uddi.v3_service.DispositionReportFaultMessage
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - getServiceBindingDetail
```
public org.uddi.api_v3.BindingTemplate getServiceBindingDetail(String bindingKey)
                                                        throws org.uddi.v3_service.DispositionReportFaultMessage,
                                                               RemoteException,
                                                               TransportException,
                                                               org.apache.commons.configuration.ConfigurationException
```
    gets a binding detail by key
    
    Parameters:
    
    bindingKey -
    
    Returns:
    
    null if not found or error, or the binding template
    
    Throws:
    
    org.uddi.v3_service.DispositionReportFaultMessage
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - findServiceBinding
```
@Deprecated
public org.uddi.api_v3.BindingTemplate findServiceBinding(String bindingKey,
                                                                       org.apache.juddi.api_v3.Node node)
                                                                throws org.uddi.v3_service.DispositionReportFaultMessage,
                                                                       RemoteException,
                                                                       TransportException,
                                                                       org.apache.commons.configuration.ConfigurationException
```
    Deprecated. use getServiceBindingDetail instead
    
    Parameters:
    
    bindingKey -
    
    node -
    
    Returns:
    
    null if not found
    
    Throws:
    
    org.uddi.v3_service.DispositionReportFaultMessage
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - getServiceBindingDetail
```
public org.uddi.api_v3.BindingTemplate getServiceBindingDetail(String bindingKey,
                                                               org.apache.juddi.api_v3.Node node)
                                                        throws org.uddi.v3_service.DispositionReportFaultMessage,
                                                               RemoteException,
                                                               TransportException,
                                                               org.apache.commons.configuration.ConfigurationException
```
    Gets the details of a specific service binding key
    
    Parameters:
    
    bindingKey -
    
    node -
    
    Returns:
    
    null if not found, or error, or the details of the binding
    
    Throws:
    
    org.uddi.v3_service.DispositionReportFaultMessage
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - findBusiness
```
@Deprecated
public org.uddi.api_v3.BusinessEntity findBusiness(String businessKey)
                                                         throws RemoteException,
                                                                TransportException,
                                                                org.apache.commons.configuration.ConfigurationException
```
    Deprecated. Use getBusinessDetail instead
    
    finds a business
    
    Parameters:
    
    businessKey -
    
    Returns:
    
    BusinessEntity if found, or null if not found.
    
    Throws:
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - findBusiness
```
@Deprecated
public org.uddi.api_v3.BusinessEntity findBusiness(String businessKey,
                                                                org.apache.juddi.api_v3.Node node)
                                                         throws RemoteException,
                                                                TransportException,
                                                                org.apache.commons.configuration.ConfigurationException
```
    Deprecated. Use getBusinessDetail instead
    
    Looks up the BusinessEntiry in the registry, will return null if is not found.
    
    Parameters:
    
    businessKey - - the key we are looking for
    
    node - - the node which is going to be queried
    
    Returns:
    
    BusinessEntity if found, or null if not found.
    
    Throws:
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - getBusinessDetail
```
public org.uddi.api_v3.BusinessEntity getBusinessDetail(String businessKey)
                                                 throws RemoteException,
                                                        TransportException,
                                                        org.apache.commons.configuration.ConfigurationException
```
    Looks up the BusinessEntiry in the registry, will return null if is not found.
    
    Parameters:
    
    businessKey - - the key we are looking for
    
    Returns:
    
    BusinessEntity is found, or null if not found.
    
    Throws:
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - getBusinessDetail
```
public org.uddi.api_v3.BusinessEntity getBusinessDetail(String businessKey,
                                                        org.apache.juddi.api_v3.Node node)
                                                 throws RemoteException,
                                                        TransportException,
                                                        org.apache.commons.configuration.ConfigurationException
```
    Looks up the BusinessEntiry in the registry, will return null if is not found.
    
    Parameters:
    
    businessKey - - the key we are looking for
    
    node - - the node which is going to be queried
    
    Returns:
    
    BusinessEntity is found, or null if not found.
    
    Throws:
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
  - findRelatedBusinesses
```
public org.uddi.api_v3.RelatedBusinessesList findRelatedBusinesses(String businessKey,
                                                                   org.apache.juddi.api_v3.Node node)
                                                            throws RemoteException,
                                                                   TransportException,
                                                                   org.apache.commons.configuration.ConfigurationException
```
    Looks up the BusinessEntity in the registry for "related" businesses. This means that there is a business relationship defined. This is also referred to as a "Publisher Assertion",
    
    Parameters:
    
    businessKey - - the key we are looking for
    
    node - - the node which is going to be queried
    
    Returns:
    
    BusinessEntity is found, or null if not found.
    
    Throws:
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException
    
    See Also:
    
    PublisherAssertion, PublisherAssertions
  - discardAuthToken
```
public void discardAuthToken()
```
    kills the current auth token, aka Logout current Node
  - discardAuthToken
```
public void discardAuthToken(String token)
```
    kills the provided auth token, aka Logout
    
    Parameters:
    
    token -
  - discardAuthToken
```
public void discardAuthToken(String token,
                             String endpoint)
```
    kills the provided auth token, aka Logout
    
    Parameters:
    
    token -
    
    endpoint -
  - getAuthToken
```
public String getAuthToken()
                    throws TransportException,
                           org.uddi.v3_service.DispositionReportFaultMessage,
                           RemoteException
```
    Gets an auth token from the uddi server using the uddi auth token
    Notice: never log auth tokens! Treat it like a password Calls
    
    Returns:
    
    getAuthToken(getUDDINode().getSecurityUrl());
    
    Throws:
    
    TransportException
    
    org.uddi.v3_service.DispositionReportFaultMessage
    
    RemoteException
    
    Since:
    
    3.2
  - getAuthToken
```
public String getAuthToken(String endpointURL)
                    throws TransportException,
                           org.uddi.v3_service.DispositionReportFaultMessage,
                           RemoteException
```
    Gets an auth token from the uddi server using the uddi auth token
    Notice: never log auth tokens! Treat it like a password notes: changed to public to have access from the subscription callback API 8/20/2013 AO
    
    Parameters:
    
    endpointURL -
    
    Returns:
    
    an auth token
    
    Throws:
    
    TransportException
    
    org.uddi.v3_service.DispositionReportFaultMessage
    
    RemoteException
  - saveNode
```
public org.apache.juddi.api_v3.NodeDetail saveNode(org.apache.juddi.api_v3.Node node)
```
    This calls a jUDDI implementation specific API call and is used to help configure internode communication between jUDDI servers. This is NOT part of the UDDI specification.
    Note: this API call should only be used with secure ports (SSL/TLS)
    
    Parameters:
    
    node -
    
    Returns:
    
    a node or null if registration fails
  - saveClerk
```
public org.apache.juddi.api_v3.ClerkDetail saveClerk(UDDIClerk senderClerk)
```
    This calls a jUDDI implementation specific API call and is used to help configure internode communication between jUDDI servers. This is NOT part of the UDDI specification.
    Note: this API call should only be used with secure ports (SSL/TLS)
    
    Parameters:
    
    senderClerk -
    
    Returns:
    
    null if registration fails
  - getApiClerk
```
public org.apache.juddi.api_v3.Clerk getApiClerk()
```
    The API Clerk is the JAXWS generated "Clerk" element that is used both on the jUDDI Client and on the jUDDI Web Service (not part of the UDDI spec).
    
    Returns:
    
    the config file defined clerk
  - getName
```
public String getName()
```
    client.clerks.clerk(" + i + ")[@name]
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
    client.clerks.clerk(" + i + ")[@name]
    
    Parameters:
    
    name -
  - setUDDINode
```
public void setUDDINode(UDDINode uddiNode)
```
    client.clerks.clerk(" + i + ")[@node] reference to UDDI Node
    
    Parameters:
    
    uddiNode -
  - getPublisher
```
public String getPublisher()
```
    This is the username client.clerks.clerk(" + i + ")[@publisher]
    
    Returns:
    
    the username
  - setPublisher
```
public void setPublisher(String publisher)
```
    This is the username client.clerks.clerk(" + i + ")[@publisher]
    
    Parameters:
    
    publisher -
  - getPassword
```
public String getPassword()
```
    If the password is encrypted, it will be decrypted if possible, otherwise the cipher text will be returned. client.clerks.clerk(" + i + ")[@password]
    
    Returns:
    
    unencrypted password
  - getRawPassword
```
public String getRawPassword()
```
    If the password is encrypted, it cipher text is returned, otherwise the clear text will be returned. client.clerks.clerk(" + i + ")[@password]
    
    Returns:
    
    password as is in the config file
  - setPassword
```
public void setPassword(String password)
```
    Use with caution, don't forget to set the IsEncrypted and Crypto provider client.clerks.clerk(" + i + ")[@password]
    
    Parameters:
    
    password -
  - getWsdls
```
public UDDIClerk.WSDL[] getWsdls()
```
    Used for the automated registration of services via WSDL2UDDI
    config file: client.clerks.clerk(" + i + ").wsdl
    
    Returns:
    
    a WSDL array
    
    See Also:
    
    WSDL2UDDI
  - setWsdls
```
public void setWsdls(UDDIClerk.WSDL[] wsdls)
```
    Used for the automated registration of services via WSDL2UDDI
    config file: client.clerks.clerk(" + i + ").wsdl
    
    Parameters:
    
    wsdls -
    
    See Also:
    
    WSDL2UDDI
  - setCryptoProvider
```
public void setCryptoProvider(String clazz)
```
    client.clerks.clerk(" + i + ")[@cryptoProvider]
    
    Parameters:
    
    clazz -
  - setIsPasswordEncrypted
```
public void setIsPasswordEncrypted(boolean option)
```
    client.clerks.clerk(" + i + ")[@isPasswordEncrypted] default is false
    
    Parameters:
    
    option -
  - getCryptoProvider
```
public String getCryptoProvider()
```
    client.clerks.clerk(" + i + ")[@cryptoProvider]
    
    Returns:
    
    may be null if not defined
  - getIsPasswordEncrypted
```
public boolean getIsPasswordEncrypted()
```
    client.clerks.clerk(" + i + ")[@isPasswordEncrypted]
    
    Returns:
    
    true/false
  - createKeyGenator
```
public static org.uddi.api_v3.TModel createKeyGenator(String partitionName,
                                                      String DescriptiveName,
                                                      String DescriptiveNameLanguage)
```
    A helper function to create a tModel key generator.
    Why would I want a key generator? In UDDIv3, you're suppose to specify what you want the keys (unique identifiers) to be, however there's a number of naming rules associated with the keys. Generally, use the FQDN of your business or organization. Optionally, when saving an UDDI entity, you can just leave the key name blank and the server should generate one for you. It's normally a UUID that's not easy to remember. In this case, there's no need to call this method.
    
    In addition, no changes are made to the UDDI server. You'll have to do that one using code similar to this:
```
 UDDIClerk clerk = ...
 TModel keygen = UDDIClerk.createKeyGenator("uddi:mydomain.com:keygenerator", "my domain", "en");
 clerk.register(keygen);
```
    Parameters:
    
    partitionName - think of this as the domain, i.e. juddi.apache.org, but it can really be anything you want. This will become part of the key associated with the tModel generator (uddi:juddi.apache.org:keygenerator). The colon ":" is the delimitor, so avoid using them unless you want to create nested key domains. If you're missing the "uddi:" prefix or the ":keygenerator" suffix, it will be added automatically.
    
    DescriptiveName - required. max length is 255 char
    
    DescriptiveNameLanguage - optional, max length is 26 char
    
    Returns:
    
    a populated tModel entity representing a tModel key generator. No changes are made to any connect UDDI service
    
    Since:
    
    3.2
  - createServiceInterfaceVersion
```
public static org.uddi.api_v3.TModelInstanceInfo createServiceInterfaceVersion(String version,
                                                                               String lang)
                                                                        throws IllegalArgumentException
```
    This is a convenience function that will build and return a TModelInstanceInfo as described in the following link that will enable you to tag web services registered in UDDI with some kind of version information.
    
    Article source: http://www.ibm.com/developerworks/webservices/library/ws-version/
    
    When using this tModel as a tModelInstance, it can be used to describe a version associated with either a service interface, a bindingTemplate service instance. Note: This is a jUDDI specific addon and may not be present in other registries
    Parameters:
    version - From the article, no specificity is provided on what to use as a value, but we recommend that you use the string representation of major.minor[.build[.revision]].
    Example
    
    6.1.2.3
    
    1.0
    
    0.1
    Returns:
    
    TModelInstanceInfo populated as described in the article, plus some descriptive information
    
    Throws:
    
    IllegalArgumentException
  - getBindingByVersion
```
public static Set<org.uddi.api_v3.BindingTemplate> getBindingByVersion(String version,
                                                                       List<org.uddi.api_v3.BindingTemplate> bindingTemplate)
                                                                throws IllegalArgumentException
```
    This is a convenience function that will filter a list of binding templates and return a list of bindings matching the specified version number. This implements and expands upon service versioning described in the following link and will enable you to tag web services registered in UDDI with some kind of version information.
    
    Article source: http://www.ibm.com/developerworks/webservices/library/ws-version/
    
    see createServiceInterfaceVersion for more information
    
    This function operates using tModelInstances that are used to describe a version associated with either a service interface, a bindingTemplate service instance. Note: This is a jUDDI specific addon and may not be present in other registries
    Parameters:
    version - From the article, no specificity is provided on what to use as a value, but we recommend that you use the string representation of major.minor[.build[.revision]].
    Example
    
    6.1.2.3
    
    1.0
    
    0.1
    bindingTemplate - the input binding template, must not be null
    
    Returns:
    
    a list if binding templates where the version equals ignoring case trimmed equals the version value
    
    Throws:
    
    IllegalArgumentException - if the version or bindingTemplate is null
  - getEndpoints
```
public List<String> getEndpoints(String serviceKey)
```
    JUDDI-700 This implements the "find_endpoints" pattern as described in Alex O'Ree's Master's Thesis on UDDI. Basically, UDDI never provided a 'simple' way to get a list of execution URLs for a web service. This function will resolve all AccessPoint and HostingRedictor indirections and provide to you a list of URLs that should be accessible for the given service.
    
    Parameters:
    
    serviceKey -
    
    Returns:
    
    a list of URI endpoints
  - getServiceDetail
```
public org.uddi.api_v3.ServiceDetail getServiceDetail(org.uddi.api_v3.GetServiceDetail getDetail)
                                               throws RemoteException,
                                                      org.apache.commons.configuration.ConfigurationException,
                                                      TransportException
```
    Gets service details or NULL if it doesn't exist or an error occurred
    
    Parameters:
    
    getDetail -
    
    Returns:
    
    null if not found
    
    Throws:
    
    RemoteException
    
    org.apache.commons.configuration.ConfigurationException
    
    TransportException
  - getServiceDetail
```
public org.uddi.api_v3.ServiceDetail getServiceDetail(org.uddi.api_v3.GetServiceDetail getDetail,
                                                      org.apache.juddi.api_v3.Node node)
                                               throws RemoteException,
                                                      TransportException,
                                                      org.apache.commons.configuration.ConfigurationException
```
    Gets service details or NULL if it doesn't exist or an error occurred
    
    Parameters:
    
    getDetail -
    
    node -
    
    Returns:
    
    null if not found
    
    Throws:
    
    RemoteException
    
    TransportException
    
    org.apache.commons.configuration.ConfigurationException

Class UDDIClerk

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

uddiNode

publisher

password

Constructor Detail

UDDIClerk

UDDIClerk

Method Detail

getClassWithAnnotations

getUDDINode

getUDDINode

setClassWithAnnotations

getServices

setServices

getManagerName

setManagerName

registerWsdls

registerWsdls

registerWsdls

unRegisterWsdls

register

register

register

register

register

register

register

register

register

register

unRegisterBusiness

unRegisterBusiness

unRegisterService

unRegisterService

unRegisterBinding

unRegisterBinding

unRegisterTModel

unRegisterTModel

unRegisterSubscription

unRegisterSubscription

findTModel

findTModel

getTModelDetail

getTModelDetail

getTModelDetail

getServiceDetail

findService

findService

getServiceDetail

findServiceBinding

getServiceBindingDetail

findServiceBinding

getServiceBindingDetail

findBusiness

findBusiness

getBusinessDetail

getBusinessDetail

findRelatedBusinesses

discardAuthToken

discardAuthToken

discardAuthToken

getAuthToken

getAuthToken

saveNode

saveClerk

getApiClerk

getName

setName

setUDDINode

getPublisher

setPublisher

getPassword

getRawPassword