org.apache.juddi.api.impl

Class UDDICustodyTransferImpl

java.lang.Object

org.apache.juddi.api.impl.AuthenticatedService

org.apache.juddi.api.impl.UDDICustodyTransferImpl

All Implemented Interfaces:

Remote, UDDICustodyTransferPortType

public class UDDICustodyTransferImpl
extends AuthenticatedService
implements UDDICustodyTransferPortType

This implements the UDDI v3 Custody Transfer API web service

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_TRANSFEREXPIRATION_DAYS
static String	TRANSFER_TOKEN_PREFIX

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

AUTHTOKEN_ACTIVE, AUTHTOKEN_RETIRED, baseUrl, baseUrlSSL, ctx, UTF8

Constructor Summary

Constructors

Constructor and Description
UDDICustodyTransferImpl()

Method Summary

Modifier and Type	Method and Description
void	discardTransferToken(DiscardTransferToken body) The discard_transferToken API is a client API used to discard a transferToken obtained through the get_transferToken API at the same node.
protected List<ChangeRecord>	executeTransfer(TransferEntities body, javax.persistence.EntityManager em, String transferToPublisher, String transferToNode) used to factor out the actual execution of custody transfer, used by both this service and the replication service.
void	getTransferToken(String authInfo, KeyBag keyBag, Holder<String> nodeID, Holder<XMLGregorianCalendar> expirationTime, Holder<byte[]> opaqueToken) The get_transferToken API is a client API used to initiate the transfer of custody of one or more businessEntity or tModel entities from one node to another.
void	transferEntities(TransferEntities body) The transfer_entities API is used by publishers to whom custody is being transferred to actually perform the transfer.

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

Field Detail

TRANSFER_TOKEN_PREFIX

public static final String TRANSFER_TOKEN_PREFIX

See Also:

Constant Field Values

DEFAULT_TRANSFEREXPIRATION_DAYS

public static final int DEFAULT_TRANSFEREXPIRATION_DAYS

See Also:

Constant Field Values

Constructor Detail

UDDICustodyTransferImpl

public UDDICustodyTransferImpl()

Method Detail

discardTransferToken

public void discardTransferToken(DiscardTransferToken body)
                          throws DispositionReportFaultMessage

Description copied from interface: UDDICustodyTransferPortType

The discard_transferToken API is a client API used to discard a transferToken obtained through the get_transferToken API at the same node. This API accepts either a transferToken or a keyBag as parameters to remove the permission to transfer data associated with a particular transferToken. If a keyBag is provided, all tokens corresponding to the keys in the keyBag will be discarded and will no longer be valid for custody or ownership transfer after the discard_transferToken is processed, irrespective of whether the keys match any known business or tmodelKey values. In the event that the keyBag represents a subset of the keyBag for one or more transferToken elements, the transferToken is discarded and will no longer be valid for transferring any entity. If the token passed in the transferToken argument does not match an existing token known to the system, no action is taken and success is reported. Keys in the keyBag argument that do not have a corresponding token are ignored.

Specified by:

discardTransferToken in interface UDDICustodyTransferPortType

Parameters:

body -

· authInfo: This OPTIONAL argument is an element that contains an authentication token. Authentication tokens are obtained using the get_authToken API call or through some other means external to this specification, and represent the identity of the publisher at a UDDI node.

· transferToken: This is a known transferToken obtained by a publisher at the node where the get_transferToken API was invoked.

· keyBag: One or more uddiKeys associated either with businessEntity or tModel entities owned by the publisher that were to be transferred to some other publisher and/or node in the registry as the result of invocation of get_transferToken. At least one businessKey or tModelKey must be provided in a keyBag.

Upon successful completion, an empty message is returned. See section 4.8 Success and Error Reporting. No error will be reported if the transferToken provided in the call does not match an existing token. No error will be reported if a token is not found for a particular key in the keyBag.

Throws:

DispositionReportFaultMessage

getTransferToken

public void getTransferToken(String authInfo,
                             KeyBag keyBag,
                             Holder<String> nodeID,
                             Holder<XMLGregorianCalendar> expirationTime,
                             Holder<byte[]> opaqueToken)
                      throws DispositionReportFaultMessage

Description copied from interface: UDDICustodyTransferPortType

The get_transferToken API is a client API used to initiate the transfer of custody of one or more businessEntity or tModel entities from one node to another. As previously stated, the two nodes may or may not be distinct; intra-node transfer between two publishers is simply a degenerate case in which node custody does not change. No actual transfer takes place with the invocation of this API. Instead, this API obtains permission from the custodial node, in the form of a transferToken, to perform the transfer. The publisher who will be recipient of the transferToken returned by this API must invoke the transfer_entities API on the target custodial node to actually transfer the entities.

Specified by:

getTransferToken in interface UDDICustodyTransferPortType

Parameters:

authInfo - · authInfo: This OPTIONAL argument is an element that contains an authentication token. Authentication tokens are obtained using the get_authToken API call or through some other means external to this specification and represent the identity of the publisher at a UDDI node.

keyBag - keyBag: One or more key (of type uddi:uddiKey) associated either with businessEntity or tModel entities owned by the publisher that are to be transferred to some other publisher and/or node in the registry. At least one businessKey or tModelKey must be provided.

nodeID - this is a return value. The transfer token consists of a nodeID, an expirationTime and an opaqueToken. The nodeID is used during the transfer_entities API by the recipient node to confirm with the relinquishing custodial node that the custody transfer is authorized and still valid. The nodeID of the transferToken is the value of the nodeID element of the Replication Configuration Structure. Refer to Section 7.5.2 Configuration of a UDDI Node – operator Element.

expirationTime - this is a return value. The expirationTime, defined as xsd:dateTime, represents the time at which the transfer token is no longer valid.

opaqueToken - this is a return value. The opaqueToken is only meaningful to the node that issues it. The opaqueToken is defined as xsd:base64Binary to allow for a RECOMMENDED encryption of the token under the relinquishing custody node’s own encryption key.

Throws:

DispositionReportFaultMessage

transferEntities

public void transferEntities(TransferEntities body)
                      throws DispositionReportFaultMessage

Description copied from interface: UDDICustodyTransferPortType

The transfer_entities API is used by publishers to whom custody is being transferred to actually perform the transfer. The recipient publisher must have an unexpired transferToken that was issued by the custodial node for the entities being transferred.

Specified by:

transferEntities in interface UDDICustodyTransferPortType

Parameters:

body - authInfo: This OPTIONAL argument is an element that contains an authentication token. Authentication tokens are obtained using the get_authToken API call or through some other means external to this specification, and represent the identity of the publisher at a UDDI node, in this case, the new owner of the entities being transferred. · transferToken: Required argument obtained from the custodial node via a call to get_transferToken by the publisher requesting a transfer of custody. The transferToken contains an opaque token, an expiration date, and the identity of the custodial node. The transferToken represents permission to transfer the entities that have been identified via a prior call to the get_transferToken API. · keyBag: One or more uddiKeys associated with businessEntity or tModel entities that are to be transferred to this publisher at the target node in the registry. The set of keys must be the same as the set of keys in the keyBag of the get_transferToken API call from which the given transferToken was once obtained.

The target node responds to this API by performing the transfer operation. This operation is comprised of four steps:

· Verification that the entity keys are valid.

· Verification that ownership of the entities by the recipient publisher is allowed and would not violate any policies at the target node related to publisher limits.

· Verification with the custodial node that the transfer of the designated entities is allowed. This is accomplished by invoking transfer_custody on the custodial node that is identified by the nodeID element in the transferToken. Any errors returned by the custodial node cause this API to fail and are propagated to the caller.

· Changing custody and ownership of the designated entities and entering these changes into the replication stream.

Upon successful completion, an empty message is returned indicating the success of the transfer operation. In the case of an inter-node custody transfer, while the transfer is in process, the entities being transferred are not available for modification. To determine the state of the data, UDDI clients can use the get_operationalInfo API to determine when custody and ownership transfer has taken place. A change in the nodeID of the operationalInfo provides such an indication.

Throws:

DispositionReportFaultMessage

executeTransfer

protected List<ChangeRecord> executeTransfer(TransferEntities body,
                                             javax.persistence.EntityManager em,
                                             String transferToPublisher,
                                             String transferToNode)
                                      throws DispositionReportFaultMessage

used to factor out the actual execution of custody transfer, used by both this service and the replication service.

Parameters:

body -

em -

transferToPublisher -

transferToNode -

Returns:

Throws:

DispositionReportFaultMessage

Since:

3.3