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.ElementExtensibleXMLObject;
24  
25  /**
26   * The wst:Claims element.
27   * 
28   * @see "WS-Trust 1.3, Chapter 4.1 Requesting a Security Token."
29   * 
30   */
31  public interface Claims extends AttributeExtensibleXMLObject, ElementExtensibleXMLObject, WSTrustObject {
32  
33      /** Element local name. */
34      public static final String ELEMENT_LOCAL_NAME = "Claims";
35  
36      /** Default element name. */
37      public static final QName ELEMENT_NAME =
38          new QName(WSTrustConstants.WST_NS, ELEMENT_LOCAL_NAME, WSTrustConstants.WST_PREFIX);
39      
40      /** Local name of the XSI type. */
41      public static final String TYPE_LOCAL_NAME = "ClaimsType"; 
42          
43      /** QName of the XSI type. */
44      public static final QName TYPE_NAME = 
45          new QName(WSTrustConstants.WST_NS, TYPE_LOCAL_NAME, WSTrustConstants.WST_PREFIX);
46  
47      /** The wst:Claims/@Dialect attribute local name. */
48      public static final String DIALECT_ATTRIB_NAME = "Dialect";
49      
50      /**
51       * Returns the wst:Claims/@Dialect attribute value.
52       * 
53       * @return the Dialect attribute value
54       */
55      public String getDialect();
56  
57      /**
58       * Sets the wst:Claims/@Dialect attribute value.
59       * 
60       * @param dialect the Dialect attribute value.
61       */
62      public void setDialect(String dialect);
63  
64  }