View Javadoc

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.wssecurity;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.xml.AttributeExtensibleXMLObject;
22  import org.opensaml.xml.ElementExtensibleXMLObject;
23  
24  /**
25   * The <wsse:UsernameToken> element.
26   * 
27   * @see "WS-Security UsernameToken Profile 1.1"
28   * 
29   */
30  public interface UsernameToken extends IdBearing, AttributeExtensibleXMLObject, 
31          ElementExtensibleXMLObject, WSSecurityObject {
32      
33      /** Element local name. */
34      public static final String ELEMENT_LOCAL_NAME = "UsernameToken";
35  
36      /** Qualified element name. */
37      public static final QName ELEMENT_NAME =
38          new QName(WSSecurityConstants.WSSE_NS, ELEMENT_LOCAL_NAME, WSSecurityConstants.WSSE_PREFIX);
39      
40      /** Local name of the XSI type. */
41      public static final String TYPE_LOCAL_NAME = "UsernameTokenType"; 
42          
43      /** QName of the XSI type. */
44      public static final QName TYPE_NAME = 
45          new QName(WSSecurityConstants.WSSE_NS, TYPE_LOCAL_NAME, WSSecurityConstants.WSSE_PREFIX);
46  
47      /**
48       * Returns the <wsse:Username> child element.
49       * 
50       * @return the {@link Username} child element.
51       */
52      public Username getUsername();
53  
54      /**
55       * Sets the <wsse:Username> child element.
56       * 
57       * @param username
58       *            the {@link Username} child element to set.
59       */
60      public void setUsername(Username username);
61  
62  }