org.apache.juddi.api.impl

Class UDDIValueSetCachingImpl

java.lang.Object

org.apache.juddi.api.impl.AuthenticatedService

org.apache.juddi.api.impl.UDDIValueSetCachingImpl

All Implemented Interfaces:

Remote, UDDIValueSetCachingPortType

public class UDDIValueSetCachingImpl
extends AuthenticatedService
implements UDDIValueSetCachingPortType

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
UDDIValueSetCachingImpl()

Method Summary

Modifier and Type

Method and Description

void

getAllValidValues(String authInfo, String modelKey, Holder<String> chunkToken, Holder<List<ValidValue>> validValue) A UDDI node that supports external value sets MAY invoke a get_allValidValues Web service offered by a value set provider that has granted permission to that registry to cache the valid values for that value set. The external value set provider MAY offer the get_allValidValues Web service and the UDDI node MAY use it. The normal use is to return a full set of valid values for the identified value set. If the value set provider determines there are too many values to return in one chunk, the set of valid values may be returned in chunks.

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

UDDIValueSetCachingImpl

public UDDIValueSetCachingImpl()

Method Detail

getAllValidValues

public void getAllValidValues(String authInfo,
                              String modelKey,
                              Holder<String> chunkToken,
                              Holder<List<ValidValue>> validValue)
                       throws DispositionReportFaultMessage

Description copied from interface: UDDIValueSetCachingPortType

A UDDI node that supports external value sets MAY invoke a get_allValidValues Web service offered by a value set provider that has granted permission to that registry to cache the valid values for that value set. The external value set provider MAY offer the get_allValidValues Web service and the UDDI node MAY use it. The normal use is to return a full set of valid values for the identified value set. If the value set provider determines there are too many values to return in one chunk, the set of valid values may be returned in chunks.

Registry policy may require the value set provider that offers a get_allValidValues Web service to republish its value set tModel when the cache should be re-acquired by participating nodes. See Section 9.6.5 Value Sets for more information.

get_allValidValues can similarly be used to obtain the set of tModelKeys for value sets that can participate in a cached category group system.

The called Web service returns the set of valid values in a validValuesList on success. This structure lists every valid value associated with the value set or category group system that is described by the tModelKey provided. In the event too many values exist to be returned in a single response (i.e., the message size exceeds the maximum number of bytes allowed by the UDDI registry), or the value set provider wants to supply the values in multiple packets, then the validValueList includes the chunkToken element and the API can be re-issued to get the remaining valid values.

Chunking of valid values

If the value set provider determines that there are too many values to be returned in a single group, then the provider SHOULD provide a chunkToken with the results. The chunkToken is a string based token which is used by the value set provider to maintain the state of the set of values for a particular caller, when these results are chunked across multiple responses. Providers should establish their own policies for determining the content and format of the chunkToken. The chunkToken returned with a particular value set result set SHOULD be used to retrieve subsequent results. If no more results are pending, the value of the chunkToken will be "0" or the chunkToken will be absent.

A chunkToken is intended as a short-term aid in obtaining contiguous results across multiple API calls and is therefore likely to remain valid for only a short time. Value set providers may establish policies on how long a chunkToken remains valid.

Specified by:

getAllValidValues in interface UDDIValueSetCachingPortType

Parameters:

authInfo - An optional 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. Providers of get_allValidValues Web services that serve multiple registries and providers that restrict who can use their service may require authInfo for this API.

modelKey - A required uddiKey value that identifies the specific instance of the tModel which describes the value set or category group system for which a Web service to get all valid values has been provided. It uniquely identifies the category, identifier, or category group system for which valid values are being requested.

chunkToken - Optional element used to retrieve subsequent groups of data when the first invocation of this API indicates more data is available. This occurs when a chunkToken is returned whose value is not "0" in the validValuesList structure described in the next section. To retrieve the next chunk of data, the chunkToken returned should be used as an argument to the next invocation of this API.

validValue - A validValuesList structure is returned containing the set of valid values for the external category or identifier system. The list MUST contain a chunkToken if the Web service provider wishes to provide the data in packets.

Throws:

DispositionReportFaultMessage