1 /* 2 * Copyright 2001-2008 The Apache Software Foundation. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 * 16 */ 17 package org.uddi.v3_service; 18 19 import java.rmi.Remote; 20 import java.rmi.RemoteException; 21 22 import javax.jws.WebMethod; 23 import javax.jws.WebParam; 24 import javax.jws.WebResult; 25 import javax.jws.WebService; 26 import javax.jws.soap.SOAPBinding; 27 import javax.xml.bind.annotation.XmlSeeAlso; 28 import org.uddi.api_v3.AuthToken; 29 import org.uddi.api_v3.DiscardAuthToken; 30 import org.uddi.api_v3.GetAuthToken; 31 32 /** 33 * This portType defines all of the UDDI security operations. 34 * 35 * This class was generated by the JAX-WS RI. JAX-WS RI 2.1.5-b03- Generated 36 * source version: 2.1 37 * 38 * <p class="MsoBodyText">The security API includes the following API calls:</p> 39 * 40 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 41 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 42 * Roman""> 43 * </span></span><b>discard_authToken</b>: Used to inform a node that a 44 * previously obtained authentication token is no longer required and should be 45 * considered invalid if used after this message is received.</p> 46 * 47 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 48 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 49 * Roman""> 50 * </span></span><b>get_authToken</b>: Used to request an authentication token 51 * in the form of an authInfo element from a UDDI node. An authInfo 52 * element MAY be required when using the API calls defined in Section <a 53 * href="#_Ref8979317 ">5.1</a> <i>Inquiry API Set</i>, Section <a 54 * href="#_Ref8979330 ">5.2</a> <i>Publication API Set</i>, Section <a 55 * href="#_Ref8979371 ">5.4</a> <i>Custody and Ownership Transfer API Set, 56 * </i>and Section <a href="#_Ref8979423 ">5.5</a> <i>Subscription API 57 * Set</i>.</p> 58 * 59 * <p class="MsoBodyText">Whether authInfo elements are required on API calls is 60 * determined by node policy as described in Section <a href="#_Ref8979130 61 * ">4.8</a> <i>About Access Control and the authInfo Element</i>. In the event 62 * that an authInfo element is not discarded, a node MAY choose to expire the 63 * authentication token so it is no longer valid for authentication in API calls 64 * after a period of time. If an expired token is passed to an API call 65 * other than discard_authToken, the error E_authTokenExpired will be returned 66 * as described in Chapter 12, <i>Error Codes</i>.</p> 67 * 68 * <p class="MsoBodyText">A UDDI node typically does not support the Security 69 * API set if it does not support using an authInfo element in any API set. If 70 * the node does support using an authInfo element in any of the API set 71 * provided by the node, it SHOULD support the Security API set. A node 72 * MAY provide an alternative mechanism for obtaining authInfo elements. 73 * </p> 74 */ 75 @WebService(name = "UDDI_Security_PortType", targetNamespace = "urn:uddi-org:api_v3_portType") 76 @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE) 77 @XmlSeeAlso({ 78 org.uddi.custody_v3.ObjectFactory.class, 79 org.uddi.repl_v3.ObjectFactory.class, 80 org.uddi.subr_v3.ObjectFactory.class, 81 org.uddi.api_v3.ObjectFactory.class, 82 org.uddi.vscache_v3.ObjectFactory.class, 83 org.uddi.vs_v3.ObjectFactory.class, 84 org.uddi.sub_v3.ObjectFactory.class, 85 org.w3._2000._09.xmldsig_.ObjectFactory.class, 86 org.uddi.policy_v3.ObjectFactory.class, 87 org.uddi.policy_v3_instanceparms.ObjectFactory.class 88 }) 89 public interface UDDISecurityPortType extends Remote { 90 91 /** 92 * The discard_authToken API call is used to inform a node that the passed 93 * authentication token is to be discarded, effectively ending the session. 94 * 95 * @param body <span style="font-family:Symbol">·<span style="font:7.0pt 96 * "Times New 97 * Roman""> 98 * </span></span><b><i>authInfo</i></b>: This required argument is an 99 * element that contains an authentication token. Authentication 100 * tokens are obtained using the get_authToken API call. Discarding an 101 * expired authToken is processed and reported as a success condition. 102 * @throws DispositionReportFaultMessage Upon successful completion, an 103 * empty message is returned. See section 4.8 Success and Error Reporting. 104 * If an error occurs in processing this API call, a dispositionReport 105 * structure will be returned to the caller in a SOAP Fault. 106 */ 107 @WebMethod(operationName = "discard_authToken", action = "discard_authToken") 108 public void discardAuthToken( 109 @WebParam(name = "discard_authToken", targetNamespace = "urn:uddi-org:api_v3", partName = "body") DiscardAuthToken body) 110 throws DispositionReportFaultMessage, RemoteException; 111 112 /** 113 * The get_authToken API call is used to obtain an authentication token. An 114 * authToken element MAY be required when using the API calls defined in 115 * Section 5.1 Inquiry API Set, Section 5.2 Publication API Set, Section 5.4 116 * Custody and Ownership Transfer API Set, and Section 5.5 Subscription API 117 * Set. 118 * 119 * @param body <p class="MsoBodyText" 120 * style="margin-left:1.0in;text-indent:-.25in"><span 121 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 122 * Roman""> 123 * </span></span><b><i>userID</i></b>: This required attribute argument is 124 * the user identifier that an individual authorized user was assigned by a 125 * UDDI node. Nodes SHOULD provide a means for individuals to obtain a 126 * userID and password credentials that will be valid at the given node.</p> 127 * 128 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 129 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 130 * Roman""> 131 * </span></span><b><i>cred</i></b>: This required attribute argument is the 132 * password or credential that is associated with the user.</p> 133 * @return returns org.uddi.api_v3.AuthToken Upon successful completion this 134 * API call returns an authToken structure that contains a valid authInfo 135 * element that can be used in subsequent calls to API calls that require an 136 * authInfo value. 137 * 138 * The authToken message has the form: <img 139 * src="http://uddi.org/pubs/uddi-v3.0.2-20041019_files/image085.gif"> 140 * 141 * The authToken structure contains a single authInfo element that 142 * represents a token that is to be passed back in API calls that require 143 * one. This structure is always returned as a synchronous response to the 144 * get_authToken message. 145 * 146 * 147 * @throws DispositionReportFaultMessage <p class="MsoBodyText">If an error 148 * occurs in processing this API call, a dispositionReport element will be 149 * returned to the caller within a SOAP Fault. In addition to the 150 * errors common to all APIs, the following error information is relevant 151 * here:</p> 152 * 153 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 154 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 155 * Roman""> 156 * </span></span><b>E_unknownUser</b>: Signifies that the UDDI node that 157 * received the request does not accept the userID and/or cred argument 158 * values passed as valid credentials.</p> 159 * 160 * <p class="MsoBodyText"> </p> 161 */ 162 @WebMethod(operationName = "get_authToken", action = "get_authToken") 163 @WebResult(name = "authToken", targetNamespace = "urn:uddi-org:api_v3", partName = "body") 164 public AuthToken getAuthToken( 165 @WebParam(name = "get_authToken", targetNamespace = "urn:uddi-org:api_v3", partName = "body") GetAuthToken body) 166 throws DispositionReportFaultMessage, RemoteException; 167 }