org.apache.juddi.api.impl

Class JUDDIApiImpl

java.lang.Object

org.apache.juddi.api.impl.AuthenticatedService

org.apache.juddi.api.impl.JUDDIApiImpl

All Implemented Interfaces:

JUDDIApiPortType

public class JUDDIApiImpl
extends AuthenticatedService
implements JUDDIApiPortType

Implements the jUDDI API service. These methods are outside of the UDDI spec and are specific to jUDDI. They are primarily used for administrative functions.

Author:

Jeff Faath, Kurt T Stam, Alex O'Ree

Field Summary

Fields inherited from class org.apache.juddi.api.impl.AuthenticatedService

AUTHTOKEN_ACTIVE, AUTHTOKEN_RETIRED, baseUrl, baseUrlSSL, ctx, df, UTF8

Constructor Summary

Constructors

Constructor and Description
JUDDIApiImpl()

Method Summary

Modifier and Type	Method and Description
void	adminDeleteSubscription(String authInfo, List<String> subscriptionKey) deletes a client subscription
void	adminDeleteTModel(DeleteTModel body) Completely deletes a tModel from the persistence layer.
DispositionReport	adminSaveBusiness(String authInfo, List<AdminSaveBusinessWrapper> values) saves a business just like from the Publication API, however administrators can use this to perform restores from backup.
void	adminSaveSubscription(String authInfo, String publisherOrUsername, Holder<List<Subscription>> subscriptions) saves a client subscription, useful for restore functions
DispositionReport	adminSaveTModel(String authInfo, List<AdminSaveTModelWrapper> values) saves a tModel just like from the Publication API, however administrators can use this to perform restores from backup.
void	deleteClerk(DeleteClerk req) removes a clerk from the database, useful for replication scenarios.
void	deleteClientSubscriptionInfo(DeleteClientSubscriptionInfo body) Delete's a client's subscription information.
void	deleteNode(DeleteNode req) removes a node from the database, useful for replication scenarios.
void	deletePublisher(DeletePublisher body) Deletes publisher(s) from the persistence layer.
ClerkList	getAllClerks(String authInfo) gets all Clerks persisted in the database, useful for replication scenarios.
List<SubscriptionWrapper>	getAllClientSubscriptionInfo(String authInfo) gets all client subscriptions.
ClientSubscriptionInfoDetail	getAllClientSubscriptionInfoDetail(GetAllClientSubscriptionInfoDetail body) Gets all client subscription information.
NodeList	getAllNodes(String authInfo) gets all nodes persisted in the database, useful for replication scenarios
PublisherDetail	getAllPublisherDetail(GetAllPublisherDetail body) Retrieves all publisher from the persistence layer.
ClientSubscriptionInfoDetail	getClientSubscriptionInfoDetail(GetClientSubscriptionInfoDetail body) Retrieves clientSubscriptionKey(s) from the persistence layer.
GetEntityHistoryMessageResponse	getEntityHistory(GetEntityHistoryMessageRequest body) gets a given entities change record history
GetFailedReplicationChangeRecordsMessageResponse	getFailedReplicationChangeRecords(GetFailedReplicationChangeRecordsMessageRequest body) gets a list of change records that were received from another node but failed to save locally, usually due to a key conflict
PublisherDetail	getPublisherDetail(GetPublisherDetail body) Retrieves publisher(s) from the persistence layer.
ReplicationConfiguration	getReplicationNodes(String authInfo) returns all Nodes that have been enabled for replication.
SyncSubscriptionDetail	invokeSyncSubscription(SyncSubscription body) Instructs the registry to perform a synchronous subscription response.
ClerkDetail	saveClerk(SaveClerk body) Saves clerk(s) to the persistence layer.
ClientSubscriptionInfoDetail	saveClientSubscriptionInfo(SaveClientSubscriptionInfo body) Adds client subscription information.
NodeDetail	saveNode(SaveNode body) Saves nodes(s) to the persistence layer.
PublisherDetail	savePublisher(SavePublisher body) Saves publisher(s) to the persistence layer.
DispositionReport	setReplicationNodes(String authInfo, ReplicationConfiguration replicationConfiguration) sets all Nodes for replication.

Methods inherited from class org.apache.juddi.api.impl.AuthenticatedService

getEntityPublisher, getNode, getRequestorsIPAddress, setContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JUDDIApiImpl

public JUDDIApiImpl()

Method Detail

savePublisher

public PublisherDetail savePublisher(SavePublisher body)
                              throws DispositionReportFaultMessage

Saves publisher(s) to the persistence layer. This method is specific to jUDDI. Administrative privilege required.

Specified by:

savePublisher in interface JUDDIApiPortType

Parameters:

body -

Returns:

PublisherDetail

Throws:

DispositionReportFaultMessage

deletePublisher

public void deletePublisher(DeletePublisher body)
                     throws DispositionReportFaultMessage

Deletes publisher(s) from the persistence layer. This method is specific to jUDDI. Administrative privilege required. Also removes all registered business entities of the user and marks all created tModels as "deleted" but not does not remove the tModel from persistence. All subscriptions are also destroyed

Specified by:

deletePublisher in interface JUDDIApiPortType

Parameters:

body -

Throws:

DispositionReportFaultMessage

getPublisherDetail

public PublisherDetail getPublisherDetail(GetPublisherDetail body)
                                   throws DispositionReportFaultMessage

Retrieves publisher(s) from the persistence layer. This method is specific to jUDDI. Administrative privilege required.

Specified by:

getPublisherDetail in interface JUDDIApiPortType

Parameters:

body -

Returns:

PublisherDetail

Throws:

DispositionReportFaultMessage

getAllPublisherDetail

public PublisherDetail getAllPublisherDetail(GetAllPublisherDetail body)
                                      throws DispositionReportFaultMessage,
                                             RemoteException

Retrieves all publisher from the persistence layer. This method is specific to jUDDI. Administrative privilege required. Use caution when calling, result set is not bound. If there are many publishers, it is possible to have a result set that is too large

Specified by:

getAllPublisherDetail in interface JUDDIApiPortType

Parameters:

body -

Returns:

PublisherDetail

Throws:

DispositionReportFaultMessage

RemoteException

adminDeleteTModel

public void adminDeleteTModel(DeleteTModel body)
                       throws DispositionReportFaultMessage

Completely deletes a tModel from the persistence layer. Administrative privilege required. All entities that reference this tModel will no longer be able to use the tModel if jUDDI Option Enforce referential Integrity is enabled.
Required permission, you must be am administrator Property.JUDDI_ENFORCE_REFERENTIAL_INTEGRITY. In addition, tModels that are owned by another node via replication cannot be deleted using this method and will throw an exception

Specified by:

adminDeleteTModel in interface JUDDIApiPortType

Parameters:

body -

Throws:

DispositionReportFaultMessage

deleteClientSubscriptionInfo

public void deleteClientSubscriptionInfo(DeleteClientSubscriptionInfo body)
                                  throws DispositionReportFaultMessage,
                                         RemoteException

Delete's a client's subscription information. This is typically used for server to server subscriptions Administrative privilege required.

Specified by:

deleteClientSubscriptionInfo in interface JUDDIApiPortType

Parameters:

body -

Throws:

DispositionReportFaultMessage

RemoteException

saveClientSubscriptionInfo

public ClientSubscriptionInfoDetail saveClientSubscriptionInfo(SaveClientSubscriptionInfo body)
                                                        throws DispositionReportFaultMessage,
                                                               RemoteException

Adds client subscription information. This effectively links a server to serverr subscription to clerk Administrative privilege required.

Specified by:

saveClientSubscriptionInfo in interface JUDDIApiPortType

Parameters:

body -

Returns:

ClientSubscriptionInfoDetail

Throws:

DispositionReportFaultMessage

RemoteException

getAllClientSubscriptionInfoDetail

public ClientSubscriptionInfoDetail getAllClientSubscriptionInfoDetail(GetAllClientSubscriptionInfoDetail body)
                                                                throws DispositionReportFaultMessage

Gets all client subscription information. This is used for server to server subscriptions Administrative privilege required.

Parameters:

body -

Returns:

ClientSubscriptionInfoDetail

Throws:

DispositionReportFaultMessage

getClientSubscriptionInfoDetail

public ClientSubscriptionInfoDetail getClientSubscriptionInfoDetail(GetClientSubscriptionInfoDetail body)
                                                             throws DispositionReportFaultMessage

Retrieves clientSubscriptionKey(s) from the persistence layer. This method is specific to jUDDI. Used for server to server subscriptions Administrative privilege required.

Parameters:

body -

Returns:

ClientSubscriptionInfoDetail

Throws:

DispositionReportFaultMessage

saveClerk

public ClerkDetail saveClerk(SaveClerk body)
                      throws DispositionReportFaultMessage

Saves clerk(s) to the persistence layer. This method is specific to jUDDI. This is used for server to server subscriptions and for future use with replication. Administrative privilege required.

Specified by:

saveClerk in interface JUDDIApiPortType

Parameters:

body -

Returns:

ClerkDetail

Throws:

DispositionReportFaultMessage

saveNode

public NodeDetail saveNode(SaveNode body)
                    throws DispositionReportFaultMessage

Saves nodes(s) to the persistence layer. This method is specific to jUDDI. Administrative privilege required. This is used for server to server subscriptions and for future use with replication. Administrative privilege required.

Specified by:

saveNode in interface JUDDIApiPortType

Parameters:

body -

Returns:

NodeDetail

Throws:

DispositionReportFaultMessage

invokeSyncSubscription

public SyncSubscriptionDetail invokeSyncSubscription(SyncSubscription body)
                                              throws DispositionReportFaultMessage,
                                                     RemoteException

Instructs the registry to perform a synchronous subscription response.

Specified by:

invokeSyncSubscription in interface JUDDIApiPortType

Parameters:

body -

Returns:

SyncSubscriptionDetail

Throws:

DispositionReportFaultMessage

RemoteException

getAllNodes

public NodeList getAllNodes(String authInfo)
                     throws DispositionReportFaultMessage,
                            RemoteException

Description copied from interface: JUDDIApiPortType

gets all nodes persisted in the database, useful for replication scenarios

Specified by:

getAllNodes in interface JUDDIApiPortType

Returns:

returns org.apache.juddi.api_v3.NodeList

Throws:

DispositionReportFaultMessage

RemoteException

getAllClerks

public ClerkList getAllClerks(String authInfo)
                       throws DispositionReportFaultMessage,
                              RemoteException

Description copied from interface: JUDDIApiPortType

gets all Clerks persisted in the database, useful for replication scenarios. Clerks provide a mapping for credentials to a Node

Specified by:

getAllClerks in interface JUDDIApiPortType

Returns:

returns org.apache.juddi.api_v3.ClerkList

Throws:

DispositionReportFaultMessage

RemoteException

deleteNode

public void deleteNode(DeleteNode req)
                throws DispositionReportFaultMessage,
                       RemoteException

Description copied from interface: JUDDIApiPortType

removes a node from the database, useful for replication scenarios. Note: when removing a node, all associated clerks will be removed with it.

Specified by:

deleteNode in interface JUDDIApiPortType

Throws:

DispositionReportFaultMessage

RemoteException

deleteClerk

public void deleteClerk(DeleteClerk req)
                 throws DispositionReportFaultMessage,
                        RemoteException

Description copied from interface: JUDDIApiPortType

removes a clerk from the database, useful for replication scenarios.

Specified by:

deleteClerk in interface JUDDIApiPortType

Throws:

DispositionReportFaultMessage

RemoteException

adminDeleteSubscription

public void adminDeleteSubscription(String authInfo,
                                    List<String> subscriptionKey)
                             throws DispositionReportFaultMessage,
                                    RemoteException

Description copied from interface: JUDDIApiPortType

deletes a client subscription

Specified by:

adminDeleteSubscription in interface JUDDIApiPortType

Throws:

DispositionReportFaultMessage

RemoteException

adminSaveBusiness

public DispositionReport adminSaveBusiness(String authInfo,
                                           List<AdminSaveBusinessWrapper> values)
                                    throws DispositionReportFaultMessage,
                                           RemoteException

Description copied from interface: JUDDIApiPortType

saves a business just like from the Publication API, however administrators can use this to perform restores from backup. It allows an administrator to save the business, setting the ownership to any user, thus maintaining access control rules.

Specified by:

adminSaveBusiness in interface JUDDIApiPortType

Returns:

returns org.uddi.api_v3.DispositionReport

Throws:

DispositionReportFaultMessage

RemoteException

adminSaveTModel

public DispositionReport adminSaveTModel(String authInfo,
                                         List<AdminSaveTModelWrapper> values)
                                  throws DispositionReportFaultMessage,
                                         RemoteException

Description copied from interface: JUDDIApiPortType

saves a tModel just like from the Publication API, however administrators can use this to perform restores from backup. It allows an administrator to save the tModel, setting the ownership to any user, thus maintaining access control rules.

Specified by:

adminSaveTModel in interface JUDDIApiPortType

Returns:

returns org.uddi.api_v3.DispositionReport

Throws:

DispositionReportFaultMessage

RemoteException

getAllClientSubscriptionInfo

public List<SubscriptionWrapper> getAllClientSubscriptionInfo(String authInfo)
                                                       throws DispositionReportFaultMessage,
                                                              RemoteException

Description copied from interface: JUDDIApiPortType

gets all client subscriptions. useful for backup and restore operations

Specified by:

getAllClientSubscriptionInfo in interface JUDDIApiPortType

Returns:

returns java.util.List

Throws:

DispositionReportFaultMessage

RemoteException

setReplicationNodes

public DispositionReport setReplicationNodes(String authInfo,
                                             ReplicationConfiguration replicationConfiguration)
                                      throws DispositionReportFaultMessage,
                                             RemoteException

Description copied from interface: JUDDIApiPortType

sets all Nodes for replication. Any previously set Nodes will be removed from the replication list. Optionally, all data from remote nodes that

Specified by:

setReplicationNodes in interface JUDDIApiPortType

Returns:

returns org.uddi.api_v3.DispositionReport

Throws:

DispositionReportFaultMessage

RemoteException

getReplicationNodes

public ReplicationConfiguration getReplicationNodes(String authInfo)
                                             throws DispositionReportFaultMessage,
                                                    RemoteException

Description copied from interface: JUDDIApiPortType

returns all Nodes that have been enabled for replication.

Specified by:

getReplicationNodes in interface JUDDIApiPortType

Returns:

returns org.uddi.repl_v3.ReplicationConfiguration

Throws:

DispositionReportFaultMessage

RemoteException

adminSaveSubscription

public void adminSaveSubscription(String authInfo,
                                  String publisherOrUsername,
                                  Holder<List<Subscription>> subscriptions)
                           throws DispositionReportFaultMessage

Description copied from interface: JUDDIApiPortType

saves a client subscription, useful for restore functions

Specified by:

adminSaveSubscription in interface JUDDIApiPortType

Throws:

DispositionReportFaultMessage

getEntityHistory

public GetEntityHistoryMessageResponse getEntityHistory(GetEntityHistoryMessageRequest body)
                                                 throws DispositionReportFaultMessage,
                                                        RemoteException

gets a given entities change record history

Specified by:

getEntityHistory in interface JUDDIApiPortType

Parameters:

body -

Returns:

item history or null if not found

Throws:

DispositionReportFaultMessage

RemoteException

getFailedReplicationChangeRecords

public GetFailedReplicationChangeRecordsMessageResponse getFailedReplicationChangeRecords(GetFailedReplicationChangeRecordsMessageRequest body)
                                                                                   throws DispositionReportFaultMessage,
                                                                                          RemoteException

gets a list of change records that were received from another node but failed to save locally, usually due to a key conflict

Specified by:

getFailedReplicationChangeRecords in interface JUDDIApiPortType

Parameters:

body -

Returns:

Throws:

DispositionReportFaultMessage

RemoteException