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.wstrust;
19  
20  import javax.xml.namespace.QName;
21  
22  import org.opensaml.xml.AttributeExtensibleXMLObject;
23  import org.opensaml.xml.schema.XSBase64Binary;
24  
25  /**
26   * The wst:BinarySecret element.
27   * 
28   * @see Entropy
29   * @see "WS-Trust 1.3, Chapter 3.3 Binary Secrets."
30   * 
31   */
32  public interface BinarySecret extends XSBase64Binary, AttributeExtensibleXMLObject, WSTrustObject {
33  
34      /** Element local name. */
35      public static final String ELEMENT_LOCAL_NAME = "BinarySecret";
36  
37      /** Default element name. */
38      public static final QName ELEMENT_NAME =
39          new QName(WSTrustConstants.WST_NS, ELEMENT_LOCAL_NAME, WSTrustConstants.WST_PREFIX);
40      
41      /** Local name of the XSI type. */
42      public static final String TYPE_LOCAL_NAME = "BinarySecretType"; 
43          
44      /** QName of the XSI type. */
45      public static final QName TYPE_NAME = 
46          new QName(WSTrustConstants.WST_NS, TYPE_LOCAL_NAME, WSTrustConstants.WST_PREFIX);
47  
48      /** wst:BinarySecret/@Type attribute local name. */
49      public static final String TYPE_ATTRIB_NAME = "Type";
50  
51      /** Type attribute AsymmetricKey URI. */
52      public static final String TYPE_ASYMMETRIC_KEY = WSTrustConstants.WST_NS + "/AsymmetricKey";
53  
54      /** Type attribute SymmetricKey URI. */
55      public static final String TYPE_SYMMETRIC_KEY = WSTrustConstants.WST_NS + "/SymmetricKey";
56  
57      /** Type attribute Nonce URI. */
58      public static final String TYPE_NONCE = WSTrustConstants.WST_NS + "/Nonce";
59  
60      /**
61       * Returns the wst:BinarySecret/@Type attribute value.
62       * 
63       * @return the Type attribute value.
64       */
65      public String getType();
66  
67      /**
68       * Sets the wst:BinarySecret/@Type attribute value.
69       * 
70       * @param type the Type attribute value to set.
71       */
72      public void setType(String type);
73  
74  }