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  
18  package org.opensaml.ws.wssecurity;
19  
20  import javax.xml.namespace.QName;
21  
22  /**
23   * The <code>Password</code> element.
24   * 
25   * @see "WS-Security UsernameToken Profile 1.1"
26   * 
27   */
28  public interface Password extends AttributedString {
29      /** Element local name. */
30      public static final String ELEMENT_LOCAL_NAME = "Password";
31  
32      /** Qualified element name. */
33      public static final QName ELEMENT_NAME = 
34          new QName(WSSecurityConstants.WSSE_NS, ELEMENT_LOCAL_NAME, WSSecurityConstants.WSSE_PREFIX);
35  
36      /** The <code>Type</code> attribute local name. */
37      public static final String TYPE_ATTRIB_NAME = "Type";
38      
39      /**
40       * The <code>wsse:Password/@Type</code> attribute URI value <code>#PasswordText</code> (DEFAULT).
41       */
42      public static final String TYPE_PASSWORD_TEXT = WSSecurityConstants.WSSE_NS + "#PasswordText";
43  
44      /**
45       * The <code>wsse:Password/@Type</code> attribute URI value <code>#PasswordDigest</code>.
46       */
47      public static final String TYPE_PASSWORD_DIGEST = WSSecurityConstants.WSSE_NS + "#PasswordDigest";
48  
49      /**
50       * Returns the <code>wsse:Password/@Type</code> attribute URI value.
51       * 
52       * @return the <code>Type</code> attribute URI value.
53       */
54      public String getType();
55  
56      /**
57       * Sets the <code>wsse:Password/@Type</code> attribute URI value.
58       * 
59       * @param type the <code>Type</code> attribute URI value to set.
60       */
61      public void setType(String type);
62  
63  }