1 /* 2 * Copyright 2008 Members of the EGEE Collaboration. 3 * Copyright 2008 University Corporation for Advanced Internet Development, Inc. 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 package org.opensaml.ws.wstrust; 18 19 import javax.xml.namespace.QName; 20 21 import org.opensaml.xml.XMLObject; 22 23 /** 24 * The wst:UseKey element. 25 * 26 * @see "WS-Trust 1.3, Chapter 9.2 Key and Encryption Requirements." 27 * 28 */ 29 public interface UseKey extends WSTrustObject { 30 31 /** Element local name. */ 32 public static final String ELEMENT_LOCAL_NAME = "UseKey"; 33 34 /** Default element name. */ 35 public static final QName ELEMENT_NAME = 36 new QName(WSTrustConstants.WST_NS, ELEMENT_LOCAL_NAME, WSTrustConstants.WST_PREFIX); 37 38 /** Local name of the XSI type. */ 39 public static final String TYPE_LOCAL_NAME = "UseKeyType"; 40 41 /** QName of the XSI type. */ 42 public static final QName TYPE_NAME = 43 new QName(WSTrustConstants.WST_NS, TYPE_LOCAL_NAME, WSTrustConstants.WST_PREFIX); 44 45 /** The wst:UseKey/@Sig attribute local name. */ 46 public static final String SIG_ATTRIB_NAME = "Sig"; 47 48 /** 49 * Get the unknown child element. 50 * 51 * @return the child element 52 */ 53 public XMLObject getUnknownXMLObject(); 54 55 /** 56 * Set the unknown child element. 57 * 58 * @param unknownObject the new child element 59 */ 60 public void setUnknownXMLObject(XMLObject unknownObject); 61 62 /** 63 * Returns the wst:UseKey/@Sig attribute value. 64 * 65 * @return the Sig attribute value or <code>null</code> 66 */ 67 public String getSig(); 68 69 /** 70 * Sets the wst:UseKey/@Sig attribute value. 71 * 72 * @param sig the Sig attribute value to set. 73 */ 74 public void setSig(String sig); 75 76 }