org.uddi.v3_service

Interface UDDISecurityPortType

All Superinterfaces:

Remote

All Known Implementing Classes:

Security3to2, UDDISecurityImpl

public interface UDDISecurityPortType
extends Remote

This portType defines all of the UDDI security operations. This class was generated by the JAX-WS RI. JAX-WS RI 2.1.5-b03- Generated source version: 2.1

The security API includes the following API calls:

· discard_authToken: Used to inform a node that a previously obtained authentication token is no longer required and should be considered invalid if used after this message is received.

· get_authToken: Used to request an authentication token in the form of an authInfo element from a UDDI node. An authInfo element MAY be required when using the API calls defined in Section 5.1 Inquiry API Set, Section 5.2 Publication API Set, Section 5.4 Custody and Ownership Transfer API Set, and Section 5.5 Subscription API Set.

Whether authInfo elements are required on API calls is determined by node policy as described in Section 4.8 About Access Control and the authInfo Element. In the event that an authInfo element is not discarded, a node MAY choose to expire the authentication token so it is no longer valid for authentication in API calls after a period of time. If an expired token is passed to an API call other than discard_authToken, the error E_authTokenExpired will be returned as described in Chapter 12, Error Codes.

A UDDI node typically does not support the Security API set if it does not support using an authInfo element in any API set. If the node does support using an authInfo element in any of the API set provided by the node, it SHOULD support the Security API set. A node MAY provide an alternative mechanism for obtaining authInfo elements.

Method Summary

Modifier and Type	Method and Description
void	discardAuthToken(DiscardAuthToken body) The discard_authToken API call is used to inform a node that the passed authentication token is to be discarded, effectively ending the session.
AuthToken	getAuthToken(GetAuthToken body) The get_authToken API call is used to obtain an authentication token.

Method Detail

discardAuthToken

void discardAuthToken(DiscardAuthToken body)
               throws DispositionReportFaultMessage,
                      RemoteException

The discard_authToken API call is used to inform a node that the passed authentication token is to be discarded, effectively ending the session.

Parameters:

body - · authInfo: This required argument is an element that contains an authentication token. Authentication tokens are obtained using the get_authToken API call. Discarding an expired authToken is processed and reported as a success condition.

Throws:

DispositionReportFaultMessage - Upon successful completion, an empty message is returned. See section 4.8 Success and Error Reporting. If an error occurs in processing this API call, a dispositionReport structure will be returned to the caller in a SOAP Fault.

RemoteException

getAuthToken

AuthToken getAuthToken(GetAuthToken body)
                throws DispositionReportFaultMessage,
                       RemoteException

The get_authToken API call is used to obtain an authentication token. An authToken element MAY be required when using the API calls defined in Section 5.1 Inquiry API Set, Section 5.2 Publication API Set, Section 5.4 Custody and Ownership Transfer API Set, and Section 5.5 Subscription API Set.

Parameters:

body -

· userID: This required attribute argument is the user identifier that an individual authorized user was assigned by a UDDI node. Nodes SHOULD provide a means for individuals to obtain a userID and password credentials that will be valid at the given node.

· cred: This required attribute argument is the password or credential that is associated with the user.

Returns:

returns org.uddi.api_v3.AuthToken Upon successful completion this API call returns an authToken structure that contains a valid authInfo element that can be used in subsequent calls to API calls that require an authInfo value. The authToken message has the form: The authToken structure contains a single authInfo element that represents a token that is to be passed back in API calls that require one. This structure is always returned as a synchronous response to the get_authToken message.

Throws:

DispositionReportFaultMessage -

If an error occurs in processing this API call, a dispositionReport element will be returned to the caller within a SOAP Fault. In addition to the errors common to all APIs, the following error information is relevant here:

· E_unknownUser: Signifies that the UDDI node that received the request does not accept the userID and/or cred argument values passed as valid credentials.

RemoteException